Dokumentkommentierung

Durch die Integration in einen verbundenen Workspace ermöglichen Altium Designer-Projekte einem räumlich verteilten Entwicklungsteam, gemeinsam an zentral gespeicherten und verwalteten Projekten zu arbeiten. Die Designoberfläche unterstützt das Kommentieren verschiedener Designdokumente, um die Zusammenarbeit im Designprozess zu verbessern. Kommentare, also von Benutzern hinzugefügte Notizen, können in Dokumenten platziert und von anderen Benutzern beantwortet werden.

Das Comments and Tasks -Panel

Platzierte Kommentare stehen den zusammenarbeitenden Benutzern (mit gemeinsamem Zugriff auf das Dokument) in Echtzeit zur Verfügung und werden unabhängig vom Projekt auf dem Server gespeichert, ohne die zugehörigen Dokumente in irgendeiner Weise zu verändern. Die Kommentarfunktion wird über das Comments and Tasks-Panel verwaltet. Wenn im Comments and Tasks-Panel ein Kommentareintrag ausgewählt wird, öffnet das System das zugehörige Designdokument und lädt es bei Bedarf.

Im Comments and Tasks-Panel können Sie Kommentare zu einem definierten Bereich oder Punkt im aktiven Dokument eines Workspace-Projekts hinzufügen und diese Kommentare Workspace-Mitgliedern zuweisen, wodurch im Grunde Aufgaben für sie erstellt werden. Über das Panel können alle Benutzer, die an dem Dokument arbeiten, Kommentare hinzufügen und sämtliche Kommentare anzeigen, ohne das Dokument selbst zu ändern. Diese Funktion fördert eine effektive Zusammenarbeit und ist besonders hilfreich, wenn auf Probleme im Dokument hingewiesen werden muss, ohne Änderungen zusammenzuführen und dabei Konflikte zu verursachen. Das Comments and Tasks-Panel lässt sich somit zum Erstellen einer Aufgabenliste verwenden. Mit fortschreitender Entwicklung des Designs können die Kommentare als erledigt markiert und geschlossen werden. Platzierte Kommentare stehen den zusammenarbeitenden Benutzern – also denjenigen mit gemeinsamem Zugriff auf das Dokument – in Echtzeit zur Verfügung und werden unabhängig vom Projekt im Workspace gespeichert, ohne die zugehörigen Dokumente in irgendeiner Weise zu verändern.

Beachten Sie, dass Kommentare und Aufgaben sowohl in Altium Designer als auch in der Designansicht der Browseroberfläche des zugehörigen Workspace hinzugefügt und verwaltet werden können. Die beiden Kommentarsysteme bieten im Wesentlichen die gleichen Funktionen. Da sowohl die Projekt- als auch die Kommentardaten im Workspace gespeichert werden, arbeiten die Systeme in Echtzeit zusammen.

Ausführliche Informationen zum Kommentarsystem in der Browseroberfläche eines Workspace finden Sie unter Commenting in the Web Viewer (Altium 365 Workspace, Enterprise Server Workspace).

Wo Kommentare unterstützt werden

Schaltplan

Ein Kommentar kann einem Objekt, einem bestimmten Punkt oder einem Bereich in einem Schaltplandokument zugeordnet werden.

PCB

Ein Kommentar kann einem Objekt, einem bestimmten Punkt oder einem Bereich in einem PCB-Dokument (im 2D-Layoutmodus) zugeordnet werden – .

Draftsman

Ein Kommentar kann einem bestimmten Punkt oder einem Bereich in einem Draftsman-Dokument eines PCB-, Multi-board- oder Kabelbaumdesignprojekts zugeordnet werden – .

Multi-board-Schaltplan

Ein Kommentar kann einem Objekt oder einem bestimmten Punkt in einem Multi-board-Schaltplandokument zugeordnet werden – .

Multi-board-Baugruppe

Ein Kommentar kann einem bestimmten Punkt im Multi-board-Baugruppendokument zugeordnet werden – .

Kabelbaumverdrahtungsplan und Layoutzeichnung

Ein Kommentar kann einem Objekt, einem bestimmten Punkt oder einem Bereich in einem Verdrahtungsplan oder einer Layoutzeichnung eines Kabelbaumdesignprojekts zugeordnet werden.

ActiveBOM

Ein Kommentar kann einer Zeile in einem ActiveBOM-Dokument zugeordnet werden – .

Zugriff auf das Panel für Kommentare und Aufgaben

In einem Workspace-Projekt können Sie das Panel auf folgende Weise öffnen:

• Klicken Sie unten rechts im Designbereich auf die Schaltfläche Panels und wählen Sie anschließend Comments and Tasks.

  Das Workspace-Symbol neben dem Namen eines Panels im Menü unten rechts im Designbereich zeigt an, dass eine Verbindung zu einem Workspace erforderlich ist, um die Daten des zugehörigen Panels anzuzeigen. Ein blaues Symbol () bedeutet, dass derzeit eine Verbindung zu einem Workspace besteht. Ein graues Symbol () bedeutet, dass derzeit keine Verbindung zu einem Workspace besteht. In diesem Fall werden Sie aufgefordert, eine Verbindung zu einem Workspace herzustellen, bevor Sie auf die Daten des Panels zugreifen können.

• Wählen Sie den Befehl View » Panels » Comments and Tasks aus den Hauptmenüs.

• Doppelklicken Sie auf die Markierungsnadel eines im Designbereich platzierten Kommentars.

Hinzufügen eines Kommentars ohne Verbindung zu einem Workspace

Stellen Sie vor der Verwendung der Kommentarfunktion sicher, dass Sie mit Ihrem Workspace verbunden sind und ein Projekt sowie ein Dokument eines Typs geöffnet haben, der Kommentare unterstützt (darunter Schaltplan, 2D-PCB, Draftsman und ActiveBOM). Verwenden Sie den Befehl File » Open Project, um ein Workspace-Projekt aus den für Sie freigegebenen Projekten auszuwählen. Das Panel Comments and Tasks zeigt Hinweise zu diesen Voraussetzungen an.

Optionen des Panels „Comments and Tasks“

Verwenden Sie die Schaltflächen oben im Panel Comments and Tasks, um die Anzeige von Kommentaren im Panel und im Editorbereich festzulegen und anzugeben, ob erwähnte Benutzer benachrichtigt werden.

Die Schaltfläche  des Panels schaltet die Sichtbarkeit der Kommentar-Pins im Dokument um. Kommentareinträge in der Liste des Panels „Comments and Tasks“ können weiterhin wie gewohnt ausgewählt werden.

Verwenden Sie das Filter-Dropdown-Menü im Panel (), um die Kommentarfilterung zu konfigurieren, und die zugehörige Schaltfläche , um zwischen der gefilterten und der ungefilterten Ansicht umzuschalten.

• TYPE – Aktivieren Sie den anzuzeigenden Typ. Standardmäßig sind alle Typen aktiviert.

• SCOPE – Aktivieren Sie Current document, um nur Kommentare für das aktuelle Dokument anzuzeigen.

• ASSIGNEE – Standardmäßig sind alle Optionen deaktiviert. Daher werden alle Aufgaben/Kommentare angezeigt und nach Namen sortiert (der erste Eintrag in der Liste ist der aktuelle Benutzer). Wenn die Kontrollkästchen für einen oder mehrere Benutzer aktiviert werden, werden die Einträge dieser Benutzer angezeigt. 

• Clear Filters – Hiermit setzen Sie die Filterung schnell auf die Standardeinstellungen zurück.

Verwenden Sie die Optionen im Menü der Schaltfläche , um die Sichtbarkeit von Kommentaren und Benachrichtigungen zu konfigurieren:

• Unresolved Only – Erledigte Kommentare werden nicht in der Liste angezeigt.

• Notification settings – Klicken Sie hier, um den Dialog Notification Settings zu öffnen und festzulegen, ob Sie E-Mail-Benachrichtigungen zu allen Kommentaraktivitäten in diesem Design (All), nur zu Kommentaren, in denen Sie erwähnt werden oder Ihnen eine Aufgabe zugewiesen wird (My), oder gar keine E-Mail-Benachrichtigungen (None) erhalten möchten. ► Beispiel für den E-Mail-Inhalt.

• Export Comments – Klicken Sie hier, um den Dialog Comment Export Configuration zu öffnen und den Export von Kommentaren in eine PDF-Datei zu konfigurieren.

  

Die ausgegebene PDF-Datei enthält Informationen zu den Kommentaren im Design: Kommentar-ID, Autor, Datum und Uhrzeit der Erstellung, Kommentartext, zugewiesener Benutzer (bei Aufgaben) und Status (bei einem Kommentar, ob er Resolved ist; bei einer Aufgabe den Status To Do / In Progress / Resolved). Sie können entweder alle mit dem Design verknüpften Kommentare exportieren, unabhängig vom Zeitpunkt ihrer Erstellung, oder nur Kommentare, die zwischen bestimmten Designfreigaben erstellt wurden. Außerdem stehen einige Optionen zur Verfügung, mit denen Sie festlegen können, welche Screenshots in das erzeugte PDF-Dokument aufgenommen werden. Zusammen geben diese Aufschluss darüber, wo sich ein Kommentar befindet und worauf er sich bezieht (Punkt, Bauteil, Bereich). Wenn Sie beide Optionen deaktiviert lassen, werden nur die Kommentare selbst ausgegeben. Klicken Sie nach der Konfiguration auf Export , um die PDF-Datei zu erzeugen, und legen Sie im anschließenden Dialog den Speicherort und den Namen fest (standardmäßig der Projektname).

• Entire designs snapshots – Fügt eine Momentaufnahme jedes Quelldokuments hinzu, das innerhalb des angegebenen Zeitraums Period einen Kommentar enthält. Anhand einer nummerierten Kommentarmarkierung lässt sich visuell nachvollziehen, wo sich der Kommentar im Dokument befindet.
• Original design screenshots – Fügt die ursprüngliche Momentaufnahme hinzu, die beim Erstellen eines Kommentars aufgenommen wurde (diese Momentaufnahme ist auch im Fenster Contextual Commenting verfügbar, wenn Sie im Hauptdesignbereich auf eine Kommentarmarkierung klicken). Sie zeigt den Punkt, den Bereich oder das Bauteil, auf den bzw. das sich der Kommentar bezieht.

Platzierung

Um einen Kommentar im Designbereich eines objektbasierten grafischen Editors, beispielsweise für Schaltpläne, 2D-PCBs oder Draftsman, zu platzieren, führen Sie zunächst den entsprechenden Befehl aus. Dazu haben Sie folgende Möglichkeiten:

• Klicken Sie auf die Schaltfläche  im Panel Comments and Tasks.

• Klicken Sie nahe der oberen rechten Ecke des Designbereichs auf .

• Klicken Sie in den Hauptmenüs auf Place » Comment.

• Verwenden Sie die Tastenkombination Ctrl+Alt+C.

• Klicken Sie mit der rechten Maustaste in den Designbereich und wählen Sie Comment.

Je nach Dokumenttyp (siehe oben) können Kommentare einem Objekt, einem bestimmten Punkt oder einem Bereich im aktiven Dokument zugewiesen werden. Der Befehl aktiviert den Kommentarplatzierungsmodus. Der Mauszeiger wird zu einem Fadenkreuz mit einem blauen Kreis, der Objekte zur Auswahl erkennt und hervorhebt:

• Klicken Sie auf ein hervorgehobenes Objekt, um einen Kommentar an diesem Objekt anzuheften.

• Klicken Sie in einen nicht hervorgehobenen Bereich, um einen Kommentar an diesem bestimmten Punkt im Dokument anzuheften.

• Klicken Sie außerhalb eines Objekts und ziehen Sie den Mauszeiger, um einen rechteckigen, hervorgehobenen Bereich zu erstellen und einen Kommentar an diesem Bereich anzuheften ().

Klicken Sie in einem ActiveBOM-Dokument auf eine Zelle, um der betreffenden Stücklistenzeile einen Kommentar hinzuzufügen. Klicken Sie mit der rechten Maustaste auf eine Zeile und wählen Sie den Befehl Comment, um dieser Zeile einen Kommentar hinzuzufügen.

Durch die Platzierung wird ein Dialog zur Kommentareingabe geöffnet. Dieser bietet ein Feld zur Eingabe des Kommentartexts und bei grafischen Dokumenten gegebenenfalls eine zusätzliche Option, um dem Kommentar eine Freihandzeichnung hinzuzufügen (). Wählen Sie die Option Assign a task to, um sich selbst oder einem der im Kommentar erwähnten Benutzer eine Aufgabe zuzuweisen (Details siehe unten). Klicken Sie auf , um die Erstellung des Kommentars zu bestätigen. Dadurch wird der Kommentar mit einem nummerierten Pin im Dokument verknüpft und dem Panel Comments and Tasks ein Eintrag mit einer Zusammenfassung des Kommentars hinzugefügt.

Platzieren eines Kommentars an einem Objekt, Erwähnen eines anderen registrierten Benutzers im Kommentar, Verschieben des Kommentar-Pins und Hinzufügen einer Freihandzeichnung zum Kommentar.

Erwähnungen und Aufgaben­zuweisungen

Zusätzlich zum Text im Dialogfeld zur Kommentareingabe kann ein Verweis in Form einer „Erwähnung“ für jeden anderen Benutzer oder jede Rolle hinzugefügt werden, der bzw. die im verbundenen Workspace registriert ist. Geben Sie dazu das Zeichen @ ein. Wählen Sie einen Namen bzw. eine E-Mail-Adresse aus der Dropdown-Liste aus, um den Verweis auf den Benutzer (Workspace-Mitglied) zum Kommentar und auch als Eintrag Assign a task to hinzuzufügen – damit wird dem Benutzer eine task zugewiesen. Deaktivieren Sie die letztere Option, wenn der Kommentar diesem Benutzer nicht ausdrücklich zugewiesen werden soll. Auch eine Rollengruppe (z. B. „Ingenieure“) und damit die ihr angehörenden Benutzer kann als Erwähnung hinzugefügt werden.

Wenn ein erwähnter Benutzer keinen Zugriff auf das aktuelle Projekt hat, werden Sie aufgefordert, es für diesen Benutzer freizugeben. Diese Option ist verfügbar, wenn Sie der Projekteigentümer oder ein Workspace-Administrator sind. Benutzerzugriffsrechte werden über das Dialogfeld „Freigeben“ erteilt; der Benutzer erhält eine E-Mail, die ihn über den freigegebenen Zugriff informiert. Wenn Sie das Dialogfeld „Freigeben“ abbrechen, wird das Projekt nicht freigegeben, der Kommentar jedoch wie gewohnt platziert.

► Weitere Informationen zum Freigeben eines Designs.

Wenn einem Benutzer eine Aufgabe zugewiesen wird, erscheint das Bild/Foto dieses Benutzers oben links im Kommentardialogfeld und auf der Kommentarkachel im Panel Comments and Tasks. Außerdem erhält die Aufgabe einen Namen aus dem Projektnamen und der fortlaufenden Nummer (z. B. Kame_FMU-1) anstelle einer einfachen Nummer wie bei normalen Kommentaren. Dieser Name wird ebenfalls im Kommentardialogfeld und auf der Kommentarkachel angezeigt. Klicken Sie darauf, um die Seite Tasks des Projekts in der Browseroberfläche des Workspace zu öffnen, wobei die ausgewählte Aufgabe in der Aufgabenliste im Fokus steht.

Positionierung

Die Position eines Kommentars im Editorbereich wird geändert, indem Sie die zugehörige „Stecknadel“ während oder nach der Platzierung an eine neue Position ziehen. Wenn die Kommentar-Stecknadel ausgewählt ist, wird eine Verbindungslinie zum zugehörigen Objekt oder Bereich angezeigt.

Beachten Sie, dass ein Kommentar auch bei seiner erstmaligen Platzierung durch Klicken und Ziehen im Platzierungsmodus () positioniert werden kann.

Bilder einfügen

Sie können einem Kommentar ein Bild hinzufügen, indem Sie das Bild zunächst aus einem Explorer Fenster oder von einer Browserseite per Rechtsklick auf das Bild in die Zwischenablage kopieren. Um das Bild anzuhängen, verwenden Sie im Kommentar selbst (im Feld mit der Beschriftung Add others with @ or paste images) den Rechtsklick-Befehl Paste (oder die Tastenkombination Ctrl+V ). 

Jedes Bild darf maximal 2 MB groß sein. Klicken Sie nach dem Einfügen in den Kommentar auf das Bild, um es vollständig anzuzeigen, wie im Bild rechts dargestellt.

Sie können auch einen Kommentar veröffentlichen, der nur ein eingefügtes Bild ohne Text enthält, wie unten gezeigt.

Zeichnen

Wählen Sie beim Platzieren oder Bearbeiten eines Kommentars die Optionsschaltfläche , um mit dem daraufhin angezeigten Stiftcursor eine Freihandzeichnung hinzuzufügen. Klicken und ziehen Sie, um Linien zu zeichnen. Klicken Sie anschließend mit der rechten Maustaste, um die Zeichnung abzuschließen und dem aktuell ausgewählten Kommentar zuzuordnen.

Um auf den Modus Freehand Drawing des Panels Properties zuzugreifen, drücken Sie die Taste Tab , während der Freihandzeichenmodus aktiv ist (angezeigt durch das Symbol im Designbereich). Mit diesen Optionen können Sie unter dem Dropdown-Menü Commands Kommentare rückgängig machen und wiederherstellen sowie unter dem Dropdown-Menü Properties Breite, Größe und Farbe ändern.

Allgemeine Aufgaben

Allgemeine Aufgaben (Aufgaben, die für das aktuelle Projekt gelten, aber keinem Projektkommentar oder Dokument zugeordnet sind) werden im Panel in einer separaten Gruppe unter dem Projekteintrag aufgelistet. Für allgemeine Aufgaben werden im Panel dieselben Inhalte und Attribute angezeigt (zugewiesener Benutzer, Priorität usw.).

Allgemeine Aufgaben werden im Panel Comments and Tasks aufgelistet.

Klicken Sie im Panel auf den Eintrag einer allgemeinen Aufgabe, um deren Kommentardialogfelder zu öffnen. Verwenden Sie das Dialogfeld, um Kommentare (auch solche mit eingefügten Bildern) für die ausgewählte allgemeine Aufgabe zu veröffentlichen.

Losgelöste Kommentare

Wenn ein Projektdokument entfernt wird oder sich seine UniqueID geändert hat, können die Kommentare zu diesem Dokument „losgelöst“ werden. Diese Kommentare sind weiterhin über den aufklappbaren Bereich Detached Comments des Panels zugänglich. Klicken Sie im Panel Comments and Tasks auf die Kachel eines losgelösten Kommentars, um dessen Dialog im Designbereich des aktuell geöffneten Dokuments anzuzeigen.

Mit Kommentaren arbeiten

Kommentare in einem Designdokument werden sowohl im Panel Comments and Tasks (als Folge nummerierter Einträge) als auch im zugehörigen Dokumenteditor (als nummerierte Pin-Markierungen) erfasst. Jeder Panel-Eintrag stellt einen Kommentar-Thread dar und enthält zusammenfassende Informationen: wer den Kommentar wann erstellt hat, den ursprünglichen Kommentartext, etwaige Erwähnungen/Zuweisungen sowie die Anzahl der Antworten im Thread.

Ein Kommentar-Thread wird geöffnet, indem Sie seinen Eintrag im Panel Comments and Tasks auswählen oder auf die zugehörige Pin-Markierung im Designbereich klicken. Dadurch wird der Kommentar im Dokumenteditor hervorgehoben und der Kommentardialog geöffnet, der den ursprünglichen Kommentar und alle Antworten von Benutzern enthält. Wenn ein ausgewählter Kommentar einem anderen Designdokument zugeordnet ist, öffnet das System dieses Dokument und lädt es bei Bedarf.

Navigation durch Kommentare durch Auswahl von Pin-Markierungen im Designbereich und von Einträgen im Panel Comments and Tasks.

Kommentardialog

Die Interaktion mit einem platzierten Kommentar erfolgt über den eingeblendeten Kommentardialog. Dieser zeigt alle Einträge des ausgewählten Kommentar-Threads und bietet Optionen zum Anzeigen einer Vorschau, Antworten, Bearbeiten, Erledigen und Löschen eines Eintrags. Der Dialog wird beim erstmaligen Platzieren eines Kommentars oder beim Auswählen eines platzierten Kommentars im Panel Comments and Tasks oder im Designbereich geöffnet. Drücken Sie Esc oder klicken Sie in den Designbereich, um den Kommentardialog zu schließen.

Vorschau

Wählen Sie im ursprünglichen Kommentar die Option Original Snapshot, um eine Bildschirmaufnahme des Editorbereichs zum Zeitpunkt der Kommentarerstellung anzuzeigen. Klicken Sie auf das Symbol oben rechts in der Bildschirmaufnahme oder auf die Bildschirmaufnahme selbst, um eine Vorschau in voller Größe zu öffnen (klicken Sie auf das Symbol  oben rechts in dieser Vorschau oder auf das Bild selbst, um sie zu schließen).

Antworten

Geben Sie im Feld Reply Text und optional eine Benutzererwähnung ('@') ein, um dem Kommentar-Thread einen neuen Eintrag hinzuzufügen. Wählen Sie die Option Assign a task to, um eine Aufgabe zu erstellen, die einem in der Dropdown-Liste angegebenen Benutzer zugewiesen wird. Klicken Sie auf , um den Eintrag zu bestätigen.

Bearbeiten und Löschen

Ein vorhandener Kommentar kann von seinem Verfasser über die Option Edit im Menü  des Kommentars bearbeitet werden. Klicken Sie auf die Schaltfläche , um die Bearbeitung des Kommentars zu bestätigen.

Verwenden Sie die Option Delete, um den aktuell ausgewählten Kommentar zu entfernen. Beachten Sie, dass der gesamte Thread entfernt wird, wenn der ursprüngliche Kommentar (anstelle einer Antwort) gelöscht wird.

Verwenden Sie die Option Convert to Task, um den Kommentar in eine Ihnen selbst zugewiesene Aufgabe umzuwandeln.

Verwenden Sie die Option Copy Link, um die URL des Kommentar-Threads zu kopieren. Über diesen Link lässt sich das Projekt im Web Viewer der Browseroberfläche des Workspace öffnen, wobei auf das Objekt, den Punkt oder den Bereich des Kommentars gezoomt und die Ansicht darauf zentriert wird.

Erledigen

Klicken Sie auf die Schaltfläche / , um den Kommentarstatus zwischen Resolved und Unresolved (Standard) umzuschalten. Ein erledigter Kommentar (als abgeschlossen geschlossen) ist inaktiv und kann nicht bearbeitet werden. Sowohl sein Eintrag im Panel Comments and Tasks als auch seine Pin-Markierung im Dokument werden ausgegraut.

Aufgabenprioritäten und -status festlegen

Wenn ein Aufgabenkommentar einem Benutzer zugewiesen wurde, können seine Priorität und sein Status festgelegt werden. Eine Aufgabe erhält zunächst automatisch die Priorität Medium und den Status To Do. Beide können jedoch durch Klicken auf das jeweilige Steuerelement oben im Kommentardialog geändert werden.

Commit-Tag, Release-Revisions-ID und Informationen zur Designprüfung 

Commit-Tags und Release-Revisions-IDs werden beim Anzeigen der entsprechenden Kommentare/Aufgaben sowohl im Panel Comments and Tasks als auch im Kommentardialog in Altium Designer angezeigt.

• Kommentare, die im Web Viewer beim Anzeigen des Design-Snapshots eines mit einem Tag versehenen Commits erstellt werden, enthalten den zugehörigen Tag-Namen. Klicken Sie auf den Link mit dem Tag-Namen, um den zugehörigen Commit-Snapshot im Web Viewer zu öffnen.

• Kommentare, die im Web Viewer beim Anzeigen eines bestimmten Releases erstellt werden, enthalten die Release-Revisions-ID. Klicken Sie auf den Link mit der Release-Revisions-ID, um das Manufacturing Portal für dieses Release zu öffnen.

• Kommentare, die im Web Viewer beim Anzeigen eines Snapshots einer Designprüfung erstellt werden, enthalten den Eintrag zur Designprüfung. Klicken Sie auf den Link zur Designprüfung, um die Seite der Prüfung zu öffnen.

Mit Jira-Aufgaben arbeiten

Wenn die Jira-Integration für Ihren Altium 365 Workspace aktiviert und konfiguriert ist, enthält ein platzierter Kommentar die zusätzliche Option, einen Jira-Vorgang in Ihrem Atlassian Jira®-Dienst anzulegen und zu verknüpfen. Wie herkömmliche Kommentare und die zugehörigen Aufgaben können angelegte Jira-Vorgänge direkt in den Designdokumenten angezeigt, bearbeitet und kommentiert sowie über das Panel Comments and Tasks angezeigt und ausgewählt werden.

Eine platzierte Jira-Aufgabeninstanz wird mit dem jeweiligen Vorgang im Jira-Bereich synchronisiert. Die bidirektionale Datensynchronisierung zwischen Jira-Vorgängen und Workspace-Aufgaben ermöglicht die Verwaltung von Designprojekten über den Jira-Bereich in Verbindung mit Altium 365.

Einen Jira-Vorgang erstellen

Um eine Jira-Vorgangsaufgabe für ein Designprojekt anzulegen, platzieren Sie zunächst wie gewohnt eine Kommentarinstanz und wählen Sie dann im Kommentardialog die Option Jira Issue. Wählen Sie anschließend einen Vorgangstyp und fügen Sie eine Zusammenfassung hinzu, um die synchronisierte Jira-Vorgangsaufgabe zu erstellen.

Wählen Sie die Task ID des Workspace-Jira-Vorgangs im Kommentardialog oder im Panel Comments and Tasks aus, um diesen Vorgang im Jira-Bereich direkt in einem neuen Tab Ihres Standardbrowsers zu öffnen. Die Task ID im Workspace wird der Issue Key im Jira-Bereich zugeordnet, und die wichtigsten Jira-Parameter wie Zusammenfassung, Beschreibung, Bearbeiter und Kommentare werden zwischen den beiden Instanzen abgeglichen. Der Workspace-Benutzer, der den Jira-Vorgang erstellt hat, ist auf der Jira-Seite der Melder des Vorgangs. Beachten Sie, dass ein Schnappschuss des aktuellen Workspace-Dokuments als Jira-Anhang hinzugefügt wird, wenn beim Erstellen des Workspace-Jira-Vorgangs die Option Attach original snapshot ausgewählt wurde (siehe oben).

Eine platzierte Workspace-Jira-Aufgabe erstellt einen synchronisierten Jira-Vorgang im Jira-Bereich. Die beiden sind durch die Zuordnung der Workspace-Task ID zur Jira-Issue Key miteinander verknüpft.

Neben den Parametern, die zwischen den Workspace- und Jira-Vorgängen abgeglichen werden, werden auch die aufgabenbezogenen Statuseinstellungen Priority und Progress synchronisiert. Wenn beispielsweise die Priorität der Workspace-Aufgabe von Medium auf High geändert wird, wird dies sofort im Vorgang auf der Jira-Seite übernommen. Ebenso ändert ein Wechsel des Bearbeitungsstatus von To Do auf In Progress auf der Jira-Seite den Status des Workspace-Jira-Vorgangs. Möglicherweise müssen die Daten aktualisiert werden (durch Klicken auf die Schaltfläche  oben im Panel Comments and Tasks), damit die aktualisierten Daten angezeigt werden.

Mit einem Jira-Vorgang verknüpfen

Die Jira-Integration von Altium 365 ermöglicht es außerdem, eine Workspace-Aufgabe über den Modus Jira Issue des Kommentardialogs mit einem vorhandenen Jira-Vorgang in Ihrem Atlassian-Jira-Dienst zu verknüpfen. Sie können eine Verknüpfung mit jedem Vorgang im angegebenen Jira-Projekt herstellen, der anschließend mit der Workspace-Jira-Aufgabe synchronisiert wird.

❯ ❮ Javascript ID: LinkJiraIssue

Platzieren Sie eine Kommentarinstanz in dem Dokumentbereich oder auf dem Objekt, das Sie mit einem vorhandenen Jira-Vorgang verknüpfen möchten, und wählen Sie anschließend im Kommentardialog den Modus Jira Issue und die Option Link Issue aus. Wählen Sie über die Dropdown-Liste Select or search issues den Jira-Vorgang (angezeigt als Summary-Text) aus, der mit der neu platzierten Jira-Aufgabeninstanz verknüpft werden soll. Beginnen Sie mit der Eingabe im Textfeld, um nach dem gewünschten Jira-Vorgang zu suchen. Die Dropdown-Liste Jira Issue des Dialogs zeigt den ausgewählten Vorgang aus dem Jira-Bereich an. Aktivieren Sie bei Bedarf die Option Attach original snapshot, um ein Bild der aktuellen Dokumentansicht an Jira zu übertragen. Klicken Sie auf die Schaltfläche Post, um die Verknüpfung zwischen der Workspace-Jira-Aufgabe und dem ausgewählten Jira-Vorgang herzustellen. Die neue Jira-Vorgangsaufgabe wird im Panel Comments and Tasks und im Kommentardialog angezeigt, der alle vorhandenen (oder hinzugefügten) Kommentare enthält. Wählen Sie die Option Show all Replies des Dialogs, um die vollständige Liste anzuzeigen.

Der verknüpfte Jira-Vorgang wird nun mit der Workspace-Jira-Aufgabe synchronisiert. Diese enthält die Vorgangs-Comments und ist auf die vom Jira-Vorgang vorgegebenen Zustände für Progress und Priority gesetzt – in diesem Beispiel In Progress und High. Beachten Sie, dass die Einträge unter Web links des Jira-Vorgangs nun darauf hinweisen, dass eine Altium 365 Workspace-Jira-Aufgabe mit diesem Vorgang verknüpft (oder erneut verknüpft) wurde.

Ein vorhandener Jira-Vorgang wird mit einer Workspace-Aufgabe verknüpft, indem sein Eintrag Jira Issue im Modus Link Issue des Workspace-Kommentardialogs angegeben wird.

To-Do-Panel

Während Ihr verbundener Workspace die oben beschriebenen umfassenden Funktionen für Kommentare und Aufgabenzuweisung bietet, können Sie auch auf das Panel To-Do zugreifen, um den Überblick über Ihre Aufgaben zu behalten. Das Panel To-Do listet alle To-Do-Einträge auf, die derzeit für das aktive Projekt definiert sind. Ein To-Do-Eintrag dient als Erinnerung an eine Aufgabe, die zu einem späteren Zeitpunkt im Zusammenhang mit einem Dokument ausgeführt werden muss.

Das Panel To-Do

Inhalt und Verwendung des To-Do-Panels

Das Panel To-Do kann zwei Arten von To-Do-Einträgen für das aktive Projekt auflisten:

• Einen To-Do-Eintrag auf Projektebene.
• Einen To-Do-Eintrag auf Dokumentebene, der einem textbasierten Dokument innerhalb des Projekts hinzugefügt wurde.

Für jeden To-Do-Eintrag werden die folgenden Informationen angezeigt:

• Done – Mit diesem Kontrollkästchen können Sie den Eintrag abhaken, wenn die zugehörige Aufgabe abgeschlossen ist.
• Action Item – Die eigentliche Aufgabe, die ausgeführt werden muss.
• Priority – Die Wichtigkeit der auszuführenden Aufgabe (Lowest, Low, Normal (Standard), High, Highest).
• Document – Ein Verweis auf das Quelldokument, dem ein To-Do-Eintrag auf Dokumentebene hinzugefügt wurde.
• Owner – Dies kann der Name der Person sein, die die Aufgabe eingetragen hat oder die sie tatsächlich ausführen soll.
• Category - Dies kann der jeweilige Bereich innerhalb des Projekts sein, dem die auszuführende Aufgabe zugeordnet ist (z. B. Schaltpläne, Designregeln, Routing, Constraints usw.).

Aufgaben auf Projektebene hinzufügen

Aufgaben auf Projektebene werden direkt im Panel hinzugefügt. Stellen Sie vor dem Hinzufügen von Einträgen sicher, dass das aktive Dokument im Designeditor-Fenster eines der Designdokumente des Projekts ist, für das Sie Aufgaben definieren möchten.

Um eine neue Aufgabe hinzuzufügen, klicken Sie mit der rechten Maustaste in das Panel und wählen Sie im daraufhin angezeigten Kontextmenü den Eintrag Add Project To-Do Item. Das Dialogfeld Edit To-Do Item wird geöffnet.

Geben Sie in diesem Dialogfeld einen passenden Text für die Aufgabe ein, die für das Projekt ausgeführt werden muss. Verwenden Sie die verfügbaren Felder im Dialogfeld, um eine task's Priority, Owner, and Category festzulegen. Nachdem Sie den Eintrag wie gewünscht definiert haben, klicken Sie auf OK, um den neuen Eintrag zum Panel hinzuzufügen.

Aufgaben auf Dokumentebene hinzufügen

Aufgaben auf Dokumentebene werden einem textbasierten Quelldokument hinzugefügt (z. B. einer VHDL-Datei, einer Constraint-Datei, einem Dokument mit Embedded-Quellcode usw.). Stellen Sie vor dem Hinzufügen von Einträgen sicher, dass das gewünschte Dokument im Designeditor-Fenster aktiv ist und zu dem Projekt gehört, dessen Aufgaben Sie gerade definieren.

Um eine neue Aufgabe hinzuzufügen, setzen Sie den Textcursor an die gewünschte Stelle im Dokument, an der Sie die Aufgabe einfügen möchten. Klicken Sie mit der rechten Maustaste und wählen Sie im daraufhin angezeigten Kontextmenü den Eintrag Add To-Do Item. Das Dialogfeld Edit To-Do Item wird angezeigt. Geben Sie in diesem Dialogfeld einen passenden Text für die Aufgabe ein, die im Dokument ausgeführt werden muss. Verwenden Sie die verfügbaren Felder im Dialogfeld, um eine Priority, Owner und Category für die Aufgabe festzulegen (z. B. Formatierungsdurchgang, Code-Review-Durchgang usw.). Nachdem Sie die Aufgabe wie gewünscht definiert haben, klicken Sie auf OK, um das Dialogfeld zu schließen und zum aktuellen Dokument zurückzukehren. Ein Eintrag für die Aufgabe wird im Panel To-Do sowie an der aktuellen Position des Textcursors angezeigt. Der Eintrag erscheint als Kommentar (innerhalb der für diesen Dokumenttyp definierten Kommentarzeichen) und enthält den eigentlichen Aufgabentext sowie eine eindeutige Kennung, wie in der folgenden Abbildung dargestellt.

Kontextmenü

Das Kontextmenü bietet die folgenden Befehle:

• Goto Source - Dieser Befehl ist verfügbar, wenn der im Panel ausgewählte Eintrag eine Aufgabe auf Dokumentebene ist. Verwenden Sie diesen Befehl, um das zugehörige Quelldokument, auf das im Feld „Document“ des Eintrags verwiesen wird, zu öffnen (sofern es noch nicht geöffnet ist) und im Designeditor-Fenster zum aktiven Dokument zu machen. Der Textcursor wird an den Anfang des Aufgabentextes gesetzt.
• Add Project To-Do Item - Fügt dem Panel eine Aufgabe auf Projektebene für das aktive Projekt hinzu.
• Edit - Bearbeitet die ausgewählte Aufgabe. Das Dialogfeld Edit To-Do Item wird angezeigt, in dem Sie die erforderlichen Änderungen vornehmen können.
• Delete - Löscht die ausgewählte Aufgabe aus dem Panel.
• Show Completed Items - Wenn diese Option aktiviert ist, werden im Panel nur Aufgaben angezeigt, die als abgeschlossen markiert wurden (Option Done aktiviert).
• Report - Erstellt einen Bericht mit allen Aufgaben, die derzeit im Panel angezeigt werden. Nach dem Aufrufen des Befehls wird das Dialogfeld Report Preview geöffnet, in dem Sie den Bericht konfigurieren, drucken und in verschiedene Dateiformate exportieren können.

Hinweise

• Wenn eine Aufgabe auf Dokumentebene im Panel definiert wurde und das zugehörige Quelldokument das aktive Dokument im Designeditor-Fenster ist, wird der gesamte Text des Aufgabeneintrags im Panel fett dargestellt.
• Durch Doppelklicken auf einen Aufgabeneintrag im Panel wird das Dialogfeld Edit To-Do Item geöffnet, in dem Sie die Definition der Aufgabe ändern können.
• Die Einträge im Panel können nach jeder Spalte sortiert werden, indem Sie auf die jeweilige Spaltenüberschrift klicken. Klicken Sie einmal, um aufsteigend zu sortieren, und erneut, um absteigend zu sortieren.
• Mit der Direktfilterung können Sie schnell zu einem Aufgabeneintrag springen, indem Sie direkt im Panel tippen. Sie können nach jeder Datenspalte im Panel filtern. Verwenden Sie die Tasten Right Arrow und Left Arrow, um zwischen den Spalten für die Filterung zu wechseln, oder klicken Sie direkt auf ein Feld innerhalb einer Spalte. Um diese Filterfunktion zu verwenden, klicken Sie in eine Datenspalte und geben Sie den ersten Buchstaben des Eintrags ein, zu dem Sie springen möchten. Der erste Eintrag in dieser Spalte, der mit dem eingegebenen Buchstaben beginnt, wird ausgewählt. Der Buchstabe wird hervorgehoben, um anzuzeigen, dass der Spalteninhalt anhand des eingegebenen Buchstabens gefiltert wird.