Dokumentkommentierung

Wenn sie in einen verbundenen Workspace integriert sind, ermöglichen Altium Designer-Projekte einem verteilten Entwicklungsteam die kollaborative Arbeit an zentral gespeicherten und verwalteten Projekten. Die Designoberfläche unterstützt Kommentare in verschiedenen Designdokumenten, um den Design-Kollaborationsprozess zu verbessern. Kommentare, d. h. von Benutzern hinzugefügte Notizen, können in Dokumenten platziert und von anderen Benutzern beantwortet werden.

Das Comments and Tasks Panel

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

Das Comments and Tasks-Panel ermöglicht es Ihnen, Kommentare zu einem definierten Bereich oder Punkt im aktiven Dokument eines Workspace-Projekts hinzuzufügen und diese Kommentare Workspace-Mitgliedern zuzuweisen, wodurch im Wesentlichen Aufgaben für sie erstellt werden. Das Panel ermöglicht allen Benutzern, die am Dokument arbeiten, Kommentare hinzuzufügen und alle Kommentare anzuzeigen, ohne das Dokument selbst tatsächlich zu ändern. Diese Funktion unterstützt effiziente Kollaborationsprozesse und ist äußerst wertvoll, wenn auf Probleme innerhalb des Dokuments hingewiesen werden muss, ohne Dateien physisch zusammenzuführen und Konflikte zu verursachen. Das Comments and Tasks-Panel kann im Wesentlichen zum Erstellen einer „To-do“-Liste verwendet werden, und mit zunehmender Reife des Designs können die Kommentare gelöst und geschlossen werden. Platzierte Kommentare stehen zusammenarbeitenden Benutzern in Echtzeit zur Verfügung – also Benutzern mit freigegebenem Zugriff auf das Dokument – und werden unabhängig vom Projekt im Workspace gespeichert, ohne dessen enthaltene Dokumente in irgendeiner Weise zu verändern.

Beachten Sie, dass Kommentare und Aufgaben sowohl in Altium Designer als auch im zugehörigen Workspace über dessen browserbasierte Designansicht hinzugefügt und verwaltet werden können. Die Funktionalität der beiden Kommentarsysteme ist im Wesentlichen identisch, und 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 Kommentierung unterstützt wird

Schaltplan

Ein Kommentar kann auf ein Objekt, einen bestimmten Punkt oder einen Bereich in einem Schaltplandokument angewendet werden.

PCB

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

Draftsman

Ein Kommentar kann auf einen bestimmten Punkt oder einen Bereich in einem Draftsman-Dokument eines PCB-, Multi-board- oder Kabelbaum-Designprojekts angewendet werden – .

Multi-board-Schaltplan

Ein Kommentar kann auf ein Objekt oder einen bestimmten Punkt in einem Multi-board-Schaltplandokument angewendet werden – .

Multi-board-Assembly

Ein Kommentar kann auf einen bestimmten Punkt im Multi-board-Assembly-Dokument angewendet werden – .

Harness Wiring Diagram und Layout Drawing

Ein Kommentar kann auf ein Objekt, einen bestimmten Punkt oder einen Bereich in einem Wiring-Diagramm- oder Layout-Drawing-Dokument eines Kabelbaum-Designprojekts angewendet werden.

ActiveBOM

Ein Kommentar kann auf eine Zeile in einem ActiveBOM-Dokument angewendet werden – .

Zugriff auf das Panel „Comments and Tasks“

Auf das Panel wird aus einem Workspace-Projekt auf folgende Weise zugegriffen:

• Klicken Sie auf die Schaltfläche Panels unten rechts im Designbereich und wählen Sie dann 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 () zeigt an, dass derzeit keine Verbindung zu einem Workspace besteht, und Sie werden aufgefordert, eine Verbindung zu einem Workspace herzustellen, bevor auf die Daten des Panels zugegriffen werden kann.

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

• Doppelklicken Sie auf den Marker-Pin eines im Designbereich platzierten Kommentars.

Hinzufügen eines Kommentars ohne Verbindung zu einem Workspace

Bevor Sie die Kommentarfunktion verwenden, stellen Sie sicher, dass Sie mit Ihrem Workspace verbunden sind und ein Projekt sowie einen Dokumenttyp geöffnet haben, der Kommentare unterstützt (einschließlich 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 Comments and Tasks-Panel gibt Hinweise auf diese Voraussetzungen.

Optionen des Panels „Comments and Tasks“

Verwenden Sie die Schaltflächen oben im Comments and Tasks-Panel, um die Verfügbarkeit 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-Marker-Pins im Dokument um. Kommentar-Einträge in der Auflistung des Panels „Comments and Tasks“ können weiterhin wie gewohnt ausgewählt werden.

Verwenden Sie das Filter-Dropdown-Menü im Comments and Tasks Panel (), um die Kommentarfilterung zu konfigurieren, sowie die zugehörige Schaltfläche , um zwischen gefilterter und ungefilterter Ansicht umzuschalten.

• Tasks only – aktivieren Sie diese Option, um nur Kommentare anzuzeigen, die einem Benutzer zugewiesen sind.
• ASSIGNED TO – standardmäßig sind alle Optionen deaktiviert. Folglich werden alle Aufgaben/Kommentare angezeigt und nach Namen sortiert (der erste Eintrag in der Liste ist der aktuelle Benutzer). Wenn Kontrollkästchen für einen oder mehrere Benutzer aktiviert werden, werden die Einträge dieser aktivierten Benutzer angezeigt. 

Verwenden Sie die Optionen des Menüs der Schaltfläche , um Kommentarsichtbarkeit und Benachrichtigungen zu konfigurieren:

• Unresolved Only – gelöste Kommentare werden nicht in die Liste aufgenommen.

• Current document only – zeigt nur Kommentare an, die im aktuell aktiven Dokument platziert wurden.

• Notification settings – klicken Sie hier, um den Dialog Notification Settings zu öffnen und den Empfang von E-Mail-Benachrichtigungen für alle Kommentaraktivitäten in diesem Design (All), nur für Kommentare, in denen Sie erwähnt oder denen Sie zugewiesen sind (My), oder gar keine E-Mail-Benachrichtigungen (None) zu konfigurieren. ► Beispiel für 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 Ausgabe-PDF enthält Informationen zu Kommentaren im Design: Kommentar-ID, Autor, Datum und Uhrzeit der Erstellung, Kommentartext, Zuweisungsempfänger (für Aufgaben) und Status (bei einem Kommentar, ob er Resolved ist; bei einer Aufgabe ihr Status To Do / In Progress / Resolved). Sie können wählen, ob alle dem Design zugeordneten Kommentare exportiert werden sollen, unabhängig davon, wann diese Kommentare erstellt wurden, oder nur Kommentare, die zwischen bestimmten Design-Releases erstellt wurden. Außerdem gibt es einige Optionen, um festzulegen, welche Screenshots in das erzeugte PDF-Dokument aufgenommen werden. Zusammen liefern beide Informationen darüber, wo sich ein Kommentar befindet und worauf er sich bezieht (Punkt, Komponente, Bereich). Wenn Sie beide deaktiviert lassen, erhalten Sie nur die Kommentare selbst. Nach der Konfiguration klicken Sie auf Export , um das PDF zu erzeugen; im anschließenden Dialog legen Sie Speicherort und Namen fest (standardmäßig den des Projekts).

  • Entire designs snapshots - fügt eine Aufnahme jedes Quelldokuments mit einem Kommentar innerhalb des angegebenen Zeitraums Period ein. Dadurch wird visuell bestätigt, wo sich der Kommentar anhand des nummerierten Kommentar-Markers im Dokument befindet.
  • Original design screenshots - fügt den Original-Schnappschuss ein, der beim Erstellen eines Kommentars aufgenommen wurde (und der Schnappschuss ist, der im Fenster Contextual Commenting verfügbar ist, wenn im Hauptdesignbereich auf einen Kommentar-Marker geklickt wird). Dies zeigt den Punkt, Bereich oder die Komponente, auf die sich der Kommentar bezieht.

  Der Export von Kommentaren in eine PDF-Datei kann auch über eine Output-Job-Datei als Teil der Projektfreigabe konfiguriert und erzeugt werden. Fügen Sie dazu einen Export Comments Outputter als Teil der Kategorie Report Outputs hinzu.

  Beachten Sie, dass die Funktion zum Exportieren von Kommentaren nur für Mitglieder des Workspace verfügbar ist, in dem sich das Projekt befindet. Für Benutzer, für die das Projekt außerhalb des Workspace freigegeben wurde, ist sie nicht verfügbar.

Platzierung

Um einen Kommentar im Designbereich eines objektbasierten grafischen Editors wie Schaltplan, 2D-PCB oder Draftsman zu platzieren, führen Sie zunächst den entsprechenden Befehl aus. Dies kann auf eine der folgenden Arten geschehen:

• Klicken Sie auf die Schaltfläche , die im Comments and Tasks-Panel verfügbar ist.

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

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

• Verwenden Sie die Tastenkombination Ctrl+Alt+C.

• Klicken Sie mit der rechten Maustaste und wählen Sie dann Comment im Designbereich aus.

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 Kommentar-Platzierungsmodus, und der Cursor ändert sich in ein Fadenkreuz mit einem blauen Kreis, das Objekte zur Auswahl erkennt und hervorhebt:

• Klicken Sie auf ein hervorgehobenes Objekt, um einen Kommentar an dieses Objekt anzuhängen (anzuheften).

• Klicken Sie in einen nicht hervorgehobenen Bereich, um einen Kommentar an genau diesem Punkt im Dokument anzuhängen.

• Klicken Sie abseits eines Objekts und ziehen Sie den Cursor, um einen rechteckigen hervorgehobenen Bereich zu erstellen und einen Kommentar an den angegebenen Bereich anzuhängen ().

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

Die Platzierungsaktion öffnet dann einen Dialog zur Kommentareingabe, der ein Feld zur Eingabe des Kommentartexts bietet und bei grafischen Dokumenten außerdem – sofern zutreffend – eine zusätzliche Option zum Hinzufügen einer Freihandzeichnung zum Kommentar enthält (). Wählen Sie die Option Assign a task to, um sich selbst oder einem der im Kommentar erwähnten Benutzer eine Aufgabe zuzuweisen (siehe Details unten). Klicken Sie auf , um das Erstellen des Kommentars zu bestätigen; dadurch wird der Kommentar mit einem nummerierten Pin-Marker im Dokument verknüpft und außerdem ein zusammenfassender Kommentar-Eintrag zum Comments and Tasks-Panel hinzugefügt.

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

Erwähnungen und Aufgabenzuweisungen

Zusätzlich zum Text im Dialog zur Kommentareingabe kann durch Eingabe des Zeichens @ ein Verweis als „Erwähnung“ für jeden anderen beim verbundenen Workspace registrierten Benutzer oder jede Rolle hinzugefügt werden. Wählen Sie einen Namen/eine E-Mail-Adresse aus der Dropdown-Liste aus, um den Benutzerverweis (Workspace-Mitglied) zum Kommentar hinzuzufügen, und auch als Eintrag Assign a task to – im Wesentlichen wird dem Benutzer damit ein task zugewiesen. Deaktivieren Sie die letztere Option, wenn der Kommentar nicht als ausdrücklich diesem Benutzer zugewiesen betrachtet werden soll. Eine Rollengruppe (z. B. „Engineers“) und damit deren enthaltene Benutzer kann ebenfalls als Erwähnung hinzugefügt werden.

Wenn ein erwähnter Benutzer keinen Zugriff auf das aktuelle Projekt hat, werden Sie aufgefordert, es mit diesem Benutzer zu teilen. Diese Option ist verfügbar, wenn Sie der Projekteigentümer oder ein Workspace-Administrator sind. Benutzerzugriffsrechte werden über den Dialog Share dialog vergeben; der Benutzer erhält eine E-Mail, die ihn über den freigegebenen Zugriff informiert. Wenn Sie den Share-Dialog abbrechen, wird das Projekt nicht freigegeben, der Kommentar wird jedoch wie gewohnt platziert.

► Weitere Informationen zum Freigeben eines Designs.

Wenn einem Benutzer eine Aufgabe zugewiesen wird, wird das Bild/Foto dieses Benutzers oben links im Kommentardialog und in der Kommentar-Kachel im Comments and Tasks-Panel angezeigt. Außerdem wird die Aufgabe mit dem Projektnamen und der Sequenznummer benannt (z. B. Kame_FMU-1) statt nur mit einer einfachen Nummer, wie es bei normalen Kommentaren der Fall ist. Dieser Name wird auch im Kommentardialog und in der Kommentar-Kachel 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 fokussiert wird.

Positionierung

Die Position eines Kommentars im Editorbereich wird durch Ziehen des zugehörigen „Pins“ an eine neue Stelle verschoben – während oder nach der Platzierung. Wenn ausgewählt, enthält der Kommentar-Pin eine Verbindungslinie zu seinem zugehörigen Objekt oder Bereich.

Beachten Sie, dass ein Kommentar auch während seiner ursprünglichen Platzierung positioniert werden kann, indem Sie im Platzierungsmodus klicken und ziehen ().

Einfügen von Bildern

Sie können einem Kommentar ein Bild hinzufügen, indem Sie das Bild zunächst aus einem Explorer -Fenster oder einer Browserseite kopieren, indem Sie mit der rechten Maustaste auf das Bild klicken, wodurch das Bild in die Zwischenablage kopiert wird. Um das Bild anzuhängen, verwenden Sie im Kommentar selbst einen Rechtsklick auf Paste (oder die Tastenkombination Ctrl+V ) in dem Feld mit dem Text Add others with @ or paste images. 

Jedes Bild darf maximal 2 MB groß sein. Nachdem es in den Kommentar eingefügt wurde, klicken Sie auf das Bild, um es in voller Größe anzuzeigen, wie im Bild rechts dargestellt.

Sie können auch einen Kommentar posten, der nur aus einem eingefügten Bild ohne Text besteht, wie unten gezeigt.

Freihandzeichnung

Wenn Sie einen Kommentar platzieren oder bearbeiten, wählen Sie die Optionsschaltfläche , um mit dem daraufhin angezeigten Stiftcursor eine Freihandzeichnung hinzuzufügen. Klicken und ziehen Sie, um Linien zu erstellen, und klicken Sie dann mit der rechten Maustaste, um die Zeichnung abzuschließen und dem aktuell ausgewählten Kommentar zuzuordnen.

Um auf den Modus Freehand Drawing des Bedienfelds Properties zuzugreifen, drücken Sie die Taste Tab , wenn der Freihand-Zeichenmodus aktiv ist (dies wird durch das Symbol  im Designbereich angezeigt). Mit diesen Optionen können Sie Kommentare über die Dropdown-Liste Commands rückgängig machen und wiederholen sowie Breite, Größe und Farbe über die Dropdown-Liste Properties ändern.

Allgemeine Aufgaben

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

Allgemeine Aufgaben werden im Bedienfeld Comments and Tasks aufgeführt.

Klicken Sie im Bedienfeld auf einen Eintrag für eine allgemeine Aufgabe, um auf die zugehörigen Kommentardialoge zuzugreifen. Verwenden Sie den Dialog, um Kommentare (einschließlich solcher mit eingefügten Bildern) für die ausgewählte allgemeine Aufgabe zu posten.

Losgelöste Kommentare

Wenn ein Projektdokument entfernt wurde oder sich seine UniqueID geändert hat, können die Kommentare für das Dokument „losgelöst“ werden. Auf diese Kommentare kann weiterhin über den aufklappbaren Bereich Detached Comments des Bedienfelds zugegriffen werden. Klicken Sie im Bedienfeld Comments and Tasks auf die Kachel eines losgelösten Kommentars, um den zugehörigen Dialog im Designbereich des aktuell geöffneten Dokuments anzuzeigen.

Arbeiten mit Kommentaren

Kommentare, die in einem Designdokument platziert wurden, werden sowohl im Bedienfeld Comments and Tasks (als Folge nummerierter Einträge) als auch im entsprechenden Dokumenteditor (als nummerierte Pin-Grafiken) erfasst. Jeder Bedienfeldeintrag stellt einen Kommentar-Thread dar und bietet zusammenfassende Informationen, darunter, wer den Kommentar platziert hat und wann, den ursprünglichen Kommentartext, etwaige angewendete Erwähnungen/Zuweisungen sowie die Anzahl der Antworten im Thread.

Ein Kommentar-Thread wird geöffnet, indem Sie seinen Eintrag im Bedienfeld Comments and Tasks auswählen oder im Designbereich auf den zugehörigen Pin klicken. Dadurch wird der Kommentar im Dokumenteditor hervorgehoben und der Kommentareintragsdialog geöffnet, der den ursprünglichen Kommentar und alle Benutzerantworten 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 durch Auswahl von Einträgen im Bedienfeld Comments and Tasks.

Kommentardialog

Die Interaktion mit einem platzierten Kommentar erfolgt über den Popup-Kommentardialog, der alle Einträge im ausgewählten Kommentar-Thread anzeigt und Optionen zum Anzeigen der Vorschau, Antworten, Bearbeiten, Lösen und Löschen eines Eintrags enthält. Der Dialog wird geöffnet, wenn ein Kommentar zunächst platziert wird oder wenn ein platzierter Kommentar im Bedienfeld Comments and Tasks oder im Designbereich ausgewählt wird. 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 grafische Aufnahme des Editorbereichs zu sehen, als der Kommentar platziert wurde. Klicken Sie auf das Symbol oben rechts im Screenshot oder auf den Screenshot 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 Text und optional eine Benutzererwähnung („@“) in das Feld Reply ein, um einen neuen Eintrag zum Kommentar-Thread hinzuzufügen. Wählen Sie die Option Assign a task to, um eine einem Benutzer zugewiesene Aufgabe zu erstellen, der in der Dropdown-Liste angegeben ist. Klicken Sie auf , um den Eintrag zu bestätigen.

Bearbeiten und Löschen

Ein vorhandener Kommentar kann vom Autor dieses Kommentars über die im Menü  des Kommentars verfügbare Option Edit 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 zum Kommentar-Thread zu kopieren. Dieser Link kann verwendet werden, um dieses Projekt in der Web Viewer der Browseroberfläche des Workspace zu öffnen, wobei auf ein Objekt, einen Punkt oder einen Bereich des Kommentars gezoomt und zentriert wird.

Lösen

Klicken Sie auf die Schaltfläche / , um den Kommentarstatus zwischen Resolved und Unresolved (Standard) umzuschalten. Ein gelöster Kommentar (als abgeschlossen geschlossen) ist inaktiv und nicht bearbeitbar, und sowohl sein Eintrag im Bedienfeld Comments and Tasks als auch seine Pin-Markierung im Dokument sind 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 wird anfangs sofort auf die Priorität Medium und den Status To Do gesetzt, kann jedoch durch Klicken auf ein entsprechendes Steuerelement oben im Kommentardialog geändert werden.

Commit-Tag-, Release-Revisions-ID- und Design-Review-Informationen 

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

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

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

• Kommentare, die im Web Viewer beim Anzeigen eines Design-Review-Snapshots erstellt wurden, enthalten den Design-Review-Eintrag. Klicken Sie auf den Design-Review-Link, um die Seite der Überprüfung zu öffnen.

Arbeiten mit Jira-Aufgaben

Wenn die Jira-Integration für Ihren Altium 365 Workspace aktiviert und konfiguriert ist, enthält ein platzierter Kommentar zusätzlich die Option, ein Jira-Ticket in Ihrem Atlassian Jira®-Dienst zu platzieren und damit zu verknüpfen. Wie herkömmliche Kommentare und die ihnen zugeordneten Aufgaben können platzierte Jira-Tickets innerhalb der Designdokumente angezeigt, bearbeitet und kommentiert sowie über das Bedienfeld Comments and Tasks angezeigt/ausgewählt werden.

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

Ein Jira-Ticket erstellen

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

❯ ❮ Javascript ID: CreateJiraIssue

Platzieren Sie eine Jira-Aufgabe im aktuellen Projektdokument, indem Sie zuerst einen Kommentar platzieren. Der alternative Jira-Modus ist über das Dropdown-Menü Comment verfügbar. Rufen Sie die Platzierung der Jira-Aufgabe auf, indem Sie im Menü Comment des Dialogs die Option Jira Issue auswählen. Klicken Sie auf die Option Create Issue, falls sie nicht bereits ausgewählt ist. Wählen Sie den zu erstellenden Tickettyp aus der Dropdown-Liste Issue Type aus, die die in Ihrem Jira-Dienst verfügbaren Typen enthält. Geben Sie eine Ticket-Summary sowie optional Beschreibung/Zugewiesener ein. Die Dropdown-Liste Assignee enthält nur Benutzer, die als Mitglieder Ihres Jira-Kontos registriert sind. Wählen Sie Post, um zu bestätigen. Das Jira-Ticket wird an der Position des ursprünglichen Dokumentkommentars platziert, im Bedienfeld Comments and Tasks aufgenommen, stellt einen Link zum Ticket im Jira-Bereich bereit und umfasst interaktiven Zugriff auf dessen Aufgabenprioritätseinstellungen (Medium, High usw.) und Statuseinstellungen (To Do, In Progress usw.).

Wählen Sie die Task ID des Workspace-Jira-Tickets im Kommentardialog oder im Bedienfeld Comments and Tasks, um dieses Ticket direkt in einem neuen Tab Ihres Standardbrowsers im Jira-Bereich zu öffnen. Die Workspace-Task ID entspricht der Issue Key im Jira-Bereich, und die wichtigsten Jira-Parameter wie Zusammenfassung, Beschreibung, Zugewiesener und Kommentare werden zwischen den beiden Instanzen zugeordnet. Der Workspace-Benutzer, der das Jira-Ticket erstellt hat, ist auf der Jira-Seite der Ticketmelder. Beachten Sie, dass ein Snapshot-Bild des aktuellen Workspace-Dokuments als Jira-Anhang eingefügt wird, wenn beim Erstellen des Workspace-Jira-Tickets die Option Attach original snapshot ausgewählt wurde (siehe oben).

Eine platzierte Workspace-Jira-Aufgabe erstellt ein synchronisiertes Jira-Ticket im Jira-Bereich. Beide sind über die Zuordnung der Workspace-Task ID zur Jira-Issue Key miteinander verknüpft.

Zusammen mit den zwischen Workspace- und Jira-Tickets zugeordneten Parametern werden auch die aufgabenbezogenen Einstellungen für Priority und den Status Progress synchronisiert. Wenn beispielsweise die Workspace-Ticket-Aufgabe vom Prioritätsstatus Medium in High verschoben wird, spiegelt sich dies sofort im Ticket auf der Jira-Seite wider, und wenn der Fortschrittsstatus auf der Jira-Seite von To Do in In Progress geändert wird, ändert sich entsprechend auch der Status des Workspace-Jira-Tickets. Möglicherweise ist eine Datenaktualisierung erforderlich (durch Klicken auf die Schaltfläche  oben im Bedienfeld Comments and Tasks), um aktualisierte Daten anzuzeigen.

Mit einem Jira-Ticket verknüpfen

Die Altium 365 Jira Integration ermöglicht es außerdem, eine Workspace-Aufgabe über den Modus Jira Issue des Kommentardialogs mit einem vorhandenen Jira-Ticket in Ihrem Atlassian-Jira-Dienst zu verknüpfen. Sie können jedes Ticket im angegebenen Jira-Projekt verknüpfen, das dann mit der Workspace-Jira-Aufgabe synchronisiert wird.

❯ ❮ Javascript ID: LinkJiraIssue

Platzieren Sie einen Kommentar auf dem Dokumentbereich oder Objekt, den bzw. das Sie einem vorhandenen Jira-Ticket zuordnen möchten, und wählen Sie dann im Kommentardialog den Modus Jira Issue und die Option Link Issue aus. Verwenden Sie die Dropdown-Liste Select or search issues, um das Jira-Ticket auszuwählen (angezeigt als Text Summary), das mit der neu platzierten Jira-Aufgabeninstanz verknüpft werden soll. Beginnen Sie mit der Eingabe in das Textfeld, um nach einem benötigten Jira-Ticket zu suchen. Die Dropdown-Liste Jira Issue des Dialogs zeigt das ausgewählte Ticket 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-Ticket herzustellen. Die neue Jira-Ticket-Aufgabe wird im Bedienfeld 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.

Das verknüpfte Jira-Ticket ist nun mit der Workspace-Jira-Aufgabe synchronisiert, die die Ticket-Comments enthält und auf die durch das Jira-Ticket definierten Zustände Progress und Priority gesetzt ist – In Progress und High in diesem Beispiel. Beachten Sie, dass die Ticket-Web links-Einträge in Jira nun anzeigen, dass eine Altium 365 Workspace-Jira-Aufgabe mit diesem Ticket verknüpft (oder erneut verknüpft) wurde.

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

To-Do-Bedienfeld

Während Ihr verbundener Workspace einen umfassenden Satz an Funktionen für Kommentare und Aufgabenzuweisungen wie oben beschrieben bereitstellt, können Sie auch auf das Bedienfeld To-Do zugreifen, um den Überblick über Ihre Aufgaben zu behalten. Das Bedienfeld To-Do listet alle To-Do-Elemente auf, die derzeit für das aktive Projekt definiert sind. Ein To-Do-Element dient als Erinnerung an eine Aufgabe, die später in Bezug auf ein Dokument ausgeführt werden muss.

Das Bedienfeld To-Do

To-Do Panel Content and Use

Das Bedienfeld To-Do kann zwei Arten von „To-Do“-Elementen für das aktive Projekt auflisten:

• Ein To-Do-Element auf Projektebene.
• Ein To-Do-Element auf Dokumentebene – hinzugefügt zu einem textbasierten Dokument innerhalb des Projekts.

Für jedes To-Do-Element werden die folgenden Informationen angezeigt:

• Done – mit diesem Kontrollkästchen können Sie das Element markieren, wenn die definierte Aufgabe abgeschlossen wurde.
• Action Item – die tatsächlich auszuführende Aufgabe.
• Priority – die Wichtigkeit der auszuführenden Aufgabe (Lowest, Low, Normal (Standard), High, Highest).
• Document – ein Verweis auf das Quelldokument, dem ein To-Do-Element auf Dokumentebene hinzugefügt wurde.
• Owner – dies könnte der Name der Person sein, die die Aufgabe eingibt oder sie tatsächlich ausführen soll.
• Category – dies könnte der bestimmte Bereich innerhalb des Projekts sein, zu dem die auszuführende Aufgabe gehört (z. B. Schaltpläne, Designregeln, Routing, Constraints usw.).

To-Do-Elemente auf Projektebene hinzufügen

To-Do-Elemente auf Projektebene werden direkt im Bedienfeld selbst hinzugefügt. Stellen Sie vor dem Hinzufügen von Elementen sicher, dass das aktive Dokument im Designeditorfenster eines der Designdokumente des Projekts ist, für das Sie To-Do-Elemente definieren möchten.

Um ein neues To-Do-Element hinzuzufügen, klicken Sie mit der rechten Maustaste in das Bedienfeld und wählen im daraufhin angezeigten Kontextmenü den Eintrag Add Project To-Do Item. Der Dialog Edit To-Do Item wird geöffnet.

Verwenden Sie diesen Dialog, um einen passenden Text für die Aufgabe einzugeben, die für das Projekt ausgeführt werden muss. Verwenden Sie die verfügbaren Felder im Dialog, um eine task's Priority, Owner, and Category zu definieren. Nachdem Sie das Element wie gewünscht definiert haben, klicken Sie auf OK, um das neue Element zum Bedienfeld hinzuzufügen.

To-Do-Elemente auf Dokumentebene hinzufügen

To-Do-Elemente auf Dokumentebene werden einem textbasierten Quelldokument hinzugefügt (z. B. VHDL-Datei, Constraint-Datei, Embedded-Source-Code-Dokument usw.). Stellen Sie vor dem Hinzufügen von Elementen sicher, dass das gewünschte Dokument im Designeditorfenster aktiv ist und dass dieses Dokument zu dem Projekt gehört, dessen gesamte To-Do-Elemente Sie gerade definieren.

Um ein neues To-Do-Element hinzuzufügen, platzieren Sie den Textcursor an der gewünschten Position im Dokument, an der Sie ein To-Do-Element platzieren möchten, klicken Sie mit der rechten Maustaste und wählen Sie im daraufhin angezeigten Popup-Menü den Eintrag Add To-Do Item. Der Dialog Edit To-Do Item wird angezeigt. Verwenden Sie diesen Dialog, um einen passenden Text für die Aufgabe einzugeben, die im Dokument ausgeführt werden muss. Verwenden Sie die verfügbaren Felder im Dialog, um für die Aufgabe eine Priority, Owner und Category zu definieren (z. B. Formatierungsdurchlauf, Code-Review-Durchlauf usw.). Nachdem Sie das To-Do-Element wie gewünscht definiert haben, klicken Sie auf OK, um den Dialog zu schließen und den Fokus zum aktuellen Dokument zurückzubringen. Ein Eintrag für das To-Do-Element erscheint im Bedienfeld To-Do und auch an der durch die aktuelle Textcursorposition markierten Stelle. Der Eintrag erscheint als Kommentar (zwischen den für diesen Dokumenttyp definierten Kommentartrennzeichen), einschließlich des eigentlichen Texts für das Element und einer eindeutigen Kennung, wie im Bild unten gezeigt.

Rechtsklickmenü

Das Rechtsklickmenü bietet die folgenden Befehle:

• Goto Source – dieser Befehl ist verfügbar, wenn das ausgewählte Element im Bedienfeld ein To-Do-Element auf Dokumentebene ist. Verwenden Sie diesen Befehl, um das im Feld Dokument des Elements referenzierte zugehörige Quelldokument zu öffnen (falls noch nicht geöffnet) und es zum aktiven Dokument im Designeditorfenster zu machen. Der Textcursor wird an den Anfang des Textes des To-Do-Elements gesetzt.
• Add Project To-Do Item – fügt dem Bedienfeld für das aktive Projekt ein To-Do-Element auf Projektebene hinzu.
• Edit – bearbeitet das ausgewählte To-Do-Element. Der Dialog Edit To-Do Item wird angezeigt, sodass Sie die erforderlichen Änderungen vornehmen können.
• Delete – löscht das ausgewählte To-Do-Element aus dem Bedienfeld.
• Show Completed Items – wenn diese Option aktiviert ist, bleiben nur To-Do-Elemente im Bedienfeld angezeigt, die als abgeschlossen markiert wurden (Option Done aktiviert).
• Report – erstellt einen Bericht mit allen derzeit im Bedienfeld angezeigten To-Do-Elementen. Nach dem Starten des Befehls wird der Dialog Report Preview geöffnet, in dem Sie den Bericht konfigurieren, drucken und in verschiedene Dateiformate exportieren können.

Hinweise

• Wenn im Bedienfeld ein To-Do-Element auf Dokumentebene definiert wurde und das entsprechende Quelldokument das aktive Dokument im Designeditorfenster ist, wird der Text des gesamten To-Do-Eintrags im Bedienfeld fett dargestellt.
• Durch Doppelklicken auf einen To-Do-Eintrags im Bedienfeld wird der Dialog Edit To-Do Item geöffnet, in dem Sie die Definition der Aufgabe ändern können.
• Die Einträge im Bereich können durch Klicken auf die Kopfzeile einer beliebigen Spalte nach dieser Spalte sortiert werden. Klicken Sie einmal, um aufsteigend zu sortieren; klicken Sie erneut, um absteigend zu sortieren.
• Die direkte Filterung ermöglicht es Ihnen, schnell zu einem To-Do-Element zu springen, indem Sie direkt im Bereich tippen. Sie können anhand jeder Datenspalte im Bereich 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 den Anfangsbuchstaben des Eintrags ein, zu dem Sie springen möchten. Der erste Eintrag in dieser Spalte, der mit dem von Ihnen eingegebenen Buchstaben beginnt, wird ausgewählt, und der Buchstabe wird hervorgehoben, um anzuzeigen, dass die Filterung des Spalteninhalts auf dem eingegebenen Buchstaben basiert.