Document Commenting

Wenn sie in einen verbundenen Workspace integriert sind, ermöglichen Altium Designer-Projekte einem verteilten Designteam die kollaborative Arbeit an zentral gespeicherten und verwalteten Projekten. Die Designoberfläche unterstützt das Kommentieren verschiedener Designdokumente, 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 (also Benutzern mit gemeinsamem Zugriff auf das Dokument) in Echtzeit zur Verfügung 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 Kommentareintrag 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 besonders wertvoll, wenn auf Probleme im Dokument hingewiesen werden muss, ohne physisch zusammenzuführen und Konflikte zu verursachen. Das Comments and Tasks-Panel kann im Wesentlichen verwendet werden, um eine „To-do“-Liste zu erstellen, 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 gemeinsamem 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 Browseroberflächen-Designansicht hinzugefügt und verwaltet werden können. Die Funktionalität der beiden Kommentarsysteme ist im Wesentlichen gleich, und da sowohl die Projekt- als auch die Kommentardaten im Workspace gespeichert werden, arbeiten die Systeme in Echtzeit zusammen.

Siehe Commenting in the Web Viewer (Altium 365 Workspace, Enterprise Server Workspace) für detaillierte Informationen zum Kommentarsystem in der Browseroberfläche eines 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 Harness-Design-Projekts angewendet werden – .

Multi-board Schematic

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

Multi-board Assembly

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

Harness Wiring Diagram and Layout Drawing

Ein Kommentar kann auf ein Objekt, einen bestimmten Punkt oder einen Bereich in einem Wiring-Diagram- oder Layout-Drawing-Dokument eines Harness-Design-Projekts 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 zunächst aufgefordert werden, 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 Markierungs-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 der Dokumenttypen geöffnet haben, die Kommentare unterstützen (einschließlich Schaltplan, 2D-PCB, Draftsman und ActiveBOM). Verwenden Sie den Befehl File » Open Project, um ein Workspace-Projekt aus den Projekten auszuwählen, die für Sie freigegeben wurden. Das Comments and Tasks-Panel gibt Hinweise zu diesen 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-Markierungs-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-Drop-down-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 sind, 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 – nur Kommentare anzeigen, die im aktuell aktiven Dokument platziert wurden.

• Notification settings – klicken Sie, 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 werden oder Ihnen etwas zugewiesen wird (My), oder zum vollständigen Deaktivieren von E-Mail-Benachrichtigungen (None) zu konfigurieren. ► Beispiel für E-Mail-Inhalt.

• Export Comments – klicken Sie, 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 Kommentaren im Design: Kommentar-ID, Autor, Datum und Uhrzeit der Erstellung, Kommentartext, Bearbeiter (für Aufgaben) und Status (bei einem Kommentar, wenn er Resolved ist; bei einer Aufgabe ihr Status To Do / In Progress / Resolved). Sie können wählen, ob alle mit dem Design verknüpften Kommentare exportiert werden sollen, unabhängig davon, wann diese erstellt wurden, oder nur Kommentare, die zwischen bestimmten Design-Releases erstellt wurden. Außerdem gibt es einige Optionen, mit denen Sie festlegen können, welche Screenshots in das erzeugte PDF-Dokument aufgenommen werden sollen. 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. Klicken Sie nach der Konfiguration auf Export , um die PDF-Datei zu erzeugen, und legen Sie im nachfolgenden Dialog fest, wo sie gespeichert wird und welchen Namen sie erhält (standardmäßig den des Projekts).

  • Entire designs snapshots - einen Schnappschuss jedes Quelldokuments mit einem Kommentar innerhalb des angegebenen Zeitraums Period einfügen. Dies bietet eine visuelle Bestätigung, wo sich der Kommentar im Dokument anhand eines nummerierten Kommentarmarkers befindet.
  • Original design screenshots - den Original-Schnappschuss einfügen, der beim Erstellen eines Kommentars aufgenommen wurde (und der Schnappschuss ist, der im Fenster Contextual Commenting verfügbar ist, wenn im Haupt-Designbereich auf einen Kommentarmarker geklickt wird). Dieser 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 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, mit denen das Projekt außerhalb des Workspace geteilt 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 erfolgen:

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

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

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

• Verwenden Sie das Tastaturkürzel 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 zu einem 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 (). 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 die Erstellung des Kommentars zu bestätigen. Dadurch wird der Kommentar mit einem nummerierten Pin-Marker im Dokument verknüpft und außerdem ein Kommentarzusammenfassungseintrag im Bereich Comments and Tasks 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

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

Wenn ein erwähnter Benutzer keinen Zugriff auf das aktuelle Projekt hat, werden Sie aufgefordert, das Projekt 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 geteilten Zugriff informiert. Wenn Sie den Share-Dialog abbrechen, wird das Projekt nicht geteilt, der Kommentar wird jedoch wie gewohnt platziert.

► Weitere Informationen zum Teilen eines Designs.

Wenn einem Benutzer eine Aufgabe zugewiesen wird, wird das Bild/Foto dieses Benutzers oben links im Kommentardialog und in der Kommentarkachel im Bereich Comments and Tasks 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 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 fokussiert ist.

Positionierung

Die Position eines Kommentars im Editorbereich wird verschoben, indem der zugehörige „Pin“ an eine neue Position gezogen wird – während oder nach seiner Platzierung. Wenn er ausgewählt ist, 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; dadurch wird das Bild in die Zwischenablage kopiert. Um das Bild anzuhängen, verwenden Sie im Kommentar selbst einen Rechtsklick auf Paste (oder das Tastenkürzel Ctrl+V ) im 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 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 resultierenden Stiftcursor eine Freihandzeichnung hinzuzufügen. Klicken und ziehen Sie, um Linien zu erstellen, und klicken Sie dann mit der rechten Maustaste, um den Vorgang abzuschließen und die Zeichnung dem aktuell ausgewählten Kommentar zuzuordnen.

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

Allgemeine Aufgaben

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

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

Klicken Sie im Panel auf einen Eintrag für eine allgemeine Aufgabe, um deren Kommentardialoge zu öffnen. Verwenden Sie den Dialog, um Kommentare (einschließlich solcher mit eingefügten Bildern) für die ausgewählte allgemeine Aufgabe zu veröffentlichen.

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 Detached Comments einklappbaren Bereich des Panels zugegriffen werden. Klicken Sie im Comments and Tasks Panel auf die Kachel eines losgelösten Kommentars, um dessen Dialog im Designbereich des aktuell geöffneten Dokuments anzuzeigen.

Arbeiten mit Kommentaren

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

Ein Kommentar-Thread wird geöffnet, indem sein Eintrag im Comments and Tasks Panel ausgewählt oder auf den zugehörigen Pin im Designbereich geklickt wird. Dadurch wird der Kommentar im Dokumenteditor hervorgehoben und der Dialog für den Kommentareintrag 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).

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

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 erstmals platziert wird oder wenn ein platzierter Kommentar im Comments and Tasks Panel 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 ('@') im Feld Reply 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 im Dropdown angegebenen Benutzer zugewiesen wird. 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 im Web Viewer der Browseroberfläche des Workspace zu öffnen, wobei ein Objekt, Punkt oder Bereich des Kommentars gezoomt und zentriert dargestellt 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 Comments and Tasks Panel als auch seine Pin-Markierung im Dokument werden ausgegraut dargestellt.

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 anfänglich sofort auf die Priorität Medium und den Status To Do gesetzt, diese können jedoch durch Klicken auf ein zugehöriges Steuerelement oben im Kommentardialog geändert werden.

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

Commit-Tags und Release-Revision-IDs werden angezeigt, wenn die entsprechenden Kommentare/Aufgaben sowohl im Comments and Tasks Panel als auch im Kommentardialog in Altium Designer angezeigt werden.

• 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-Revision-ID. Klicken Sie auf den Link der Release-Revision-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 des Reviews 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-Issue 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-Issues innerhalb der Designdokumente angezeigt, bearbeitet und kommentiert sowie über das Comments and Tasks Panel angezeigt/ausgewählt werden.

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

Ein Jira-Issue erstellen

Um eine Jira-Issue-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 Issue-Typ aus und fügen Sie eine Zusammenfassung hinzu, um die synchronisierte Jira-Issue-Aufgabe zu erstellen.

❯ ❮ Javascript ID: CreateJiraIssue

Platzieren Sie eine Jira-Aufgabe im aktuellen Projektdokument, indem Sie zunächst einen Kommentar platzieren. Der alternative Jira-Modus ist über das Dropdown-Menü Comment verfügbar. Starten Sie das Platzieren der Jira-Aufgabe, indem Sie im Menü Comment des Dialogs die Option Jira Issue auswählen. Klicken Sie auf die Option Create Issue, falls sie noch nicht ausgewählt ist. Wählen Sie den zu erstellenden Issue-Typ aus der Dropdown-Liste Issue Type aus, die die in Ihrem Jira-Dienst verfügbaren Typen enthält. Geben Sie eine Issue-Summary und optional eine Beschreibung/einen Bearbeiter 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-Issue wird an der ursprünglichen Kommentarposition im Dokument platziert, im Comments and Tasks Panel aufgeführt, bietet einen Link zum Issue im Jira-Bereich und enthält interaktiven Zugriff auf seine Aufgabenprioritätseinstellungen (Medium, High usw.) und Statuseinstellungen (To Do, In Progress usw.).

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

Eine platzierte Workspace-Jira-Aufgabe erstellt ein synchronisiertes Jira-Issue im Jira-Bereich. Beide sind über die Zuordnung des Workspace-Task ID mit dem Jira-Issue Key verknüpft.

Neben den zwischen Workspace- und Jira-Issues zugeordneten Parametern werden auch die aufgabenbezogenen Statuseinstellungen Priority und Progress synchronisiert. Wenn beispielsweise die Workspace-Issue-Aufgabe von einem Prioritätsstatus Medium auf High verschoben wird, wird dies sofort im Issue auf der Jira-Seite übernommen. Ebenso ändert eine Änderung des Fortschrittsstatus auf der Jira-Seite von To Do auf In Progress entsprechend den Status des Workspace-Jira-Issues. Möglicherweise ist eine Datenaktualisierung erforderlich (durch Klicken auf die Schaltfläche  oben im Bereich Comments and Tasks), um die aktualisierten Daten zu sehen.

Mit einem Jira-Issue verknüpfen

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

❯ ❮ Javascript ID: LinkJiraIssue

Platzieren Sie eine Kommentarinstanz im Dokumentbereich oder auf dem Objekt, das Sie mit einem vorhandenen Jira-Issue verknüpfen 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-Issue 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 gewünschten Jira-Issue zu suchen. Die Dropdown-Liste Jira Issue des Dialogs zeigt das ausgewählte Issue 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-Issue herzustellen. Die neue Jira-Issue-Aufgabe wird im Bereich 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-Issue ist nun mit der Workspace-Jira-Aufgabe synchronisiert. Dazu gehören das Issue Comments sowie die durch das Jira-Issue definierten Status Progress und Priority – in diesem Beispiel In Progress und High. Beachten Sie, dass die Einträge des Jira-Issues Web links nun anzeigen, dass eine Altium 365 Workspace-Jira-Aufgabe mit diesem Issue verknüpft (oder erneut verknüpft) wurde.

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

To-Do-Bereich

Während Ihr verbundener Workspace einen umfassenden Funktionsumfang für Kommentare und Aufgabenzuweisungen bietet, wie oben beschrieben, können Sie auch auf den Bereich To-Do zugreifen, um Ihre Aufgaben im Blick zu behalten. Der Bereich 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.

Der Bereich To-Do

To-Do Panel Content and Use

Der Bereich To-Do kann für das aktive Projekt zwei Arten von „To-do“-Elementen 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 - dieses Kontrollkästchen ermöglicht es Ihnen, das Element zu 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, zu dem ein To-Do-Element auf Dokumentebene hinzugefügt wurde.
• Owner - dies kann der Name der Person sein, die die Aufgabe eingibt, oder der Person, die die Aufgabe tatsächlich ausführen soll.
• Category - dies kann der bestimmte Bereich innerhalb des Projekts sein, in den die auszuführende Aufgabe fällt (z. B. Schaltpläne, Design Rules, Routing, Constraints usw.).

Hinzufügen von To-Do-Elementen auf Projektebene

To-Do-Elemente auf Projektebene werden direkt im Bereich selbst hinzugefügt. Bevor Sie Elemente hinzufügen, stellen Sie sicher, dass das aktive Dokument im Fenster des Design-Editors 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 den Bereich und wählen Sie 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 geeigneten Text für die Aufgabe einzugeben, die für das Projekt ausgeführt werden muss. Verwenden Sie die verfügbaren Felder im Dialog, um ein 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 Bereich hinzuzufügen.

Hinzufügen von To-Do-Elementen auf Dokumentebene

To-Do-Elemente auf Dokumentebene werden zu einem textbasierten Quelldokument hinzugefügt (z. B. VHDL-Datei, Constraint-Datei, Embedded-Source-Code-Dokument usw.). Bevor Sie Elemente hinzufügen, stellen Sie sicher, dass das gewünschte Dokument im Fenster des Design-Editors aktiv ist und dass dieses Dokument zu dem Projekt gehört, dessen allgemeine To-Do-Elemente Sie derzeit 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 einfügen 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 geeigneten 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 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 Bereich To-Do und außerdem an der durch die aktuelle Textcursor-Position markierten Stelle. Der Eintrag erscheint als Kommentar (zwischen den für diesen Dokumenttyp definierten Kommentartrennzeichen), einschließlich des eigentlichen Textes für das Element und einer eindeutigen Kennung, wie im Bild unten gezeigt.

Rechtsklick-Menü

Das Rechtsklick-Menü bietet die folgenden Befehle:

• Goto Source - dieser Befehl ist verfügbar, wenn das im Bereich ausgewählte Element ein To-Do-Element auf Dokumentebene ist. Verwenden Sie diesen Befehl, um das zugehörige Quelldokument zu öffnen (falls noch nicht geöffnet), auf das im Feld Dokument des Elements verwiesen wird, und es zum aktiven Dokument im Fenster des Design-Editors zu machen. Der Textcursor wird an den Anfang des Textes des To-Do-Elements gesetzt.
• Add Project To-Do Item - fügt dem Bereich 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 und ermöglicht Ihnen, die erforderlichen Änderungen vorzunehmen.
• Delete - löscht das ausgewählte To-Do-Element aus dem Bereich.
• Show Completed Items - wenn diese Option aktiviert ist, bleiben nur To-Do-Elemente im Bereich angezeigt, die als abgeschlossen markiert wurden (Option Done aktiviert).
• Report - erstellt einen Bericht mit allen To-Do-Elementen, die derzeit im Bereich angezeigt werden. 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 ein To-Do-Element auf Dokumentebene im Bereich definiert wurde und das entsprechende Quelldokument das aktive Dokument im Fenster des Design-Editors ist, wird der Text für den gesamten To-Do-Eintrag im Bereich fett dargestellt.
• Ein Doppelklick auf einen To-Do-Eintrag im Bereich öffnet den Dialog Edit To-Do Item, in dem Sie die Definition der Aufgabe ändern können.
• Die Einträge im Bereich können durch Klicken auf die Überschrift der jeweiligen Spalte nach jeder Spalte sortiert werden. Klicken Sie einmal, um aufsteigend zu sortieren; klicken Sie erneut, um absteigend zu sortieren.
• Mit der Direktfilterung können Sie schnell zu einem To-Do-Eintrag 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 eingegebenen Buchstaben beginnt, wird ausgewählt, und der Buchstabe wird hervorgehoben, um anzuzeigen, dass die Filterung des Spalteninhalts auf dem eingegebenen Buchstaben basiert.