Benutzerdefinierte Aktionen

Einführung

Die Funktion „Custom Actions“ im Requirements & Systems Portal ermöglicht es Benutzern, benutzerdefinierte Automatisierungsskripte mit Python und KI zu erstellen und anzuwenden, um ihren Projekt-Workflow zu verbessern. Diese benutzerdefinierten Aktionen können mit verschiedenen Objekten innerhalb Ihres Projekts verknüpft werden, z. B. mit Blocks, Valis und Anforderungen, und sie können außerdem die Möglichkeiten von Python und KI nutzen.

Wie kann ich Custom Actions erstellen?

Benutzer können Custom Actions nahtlos im Skriptmodul des Requirements & Systems Portal erstellen und dabei sowohl Skriptfunktionen als auch KI-Funktionen nutzen. Mit dieser Funktion können Benutzer im benutzerdefinierten Aktionsbereich des Skriptmoduls mühelos Python-Code verfassen und bestimmte Aktionen ausführen, indem sie den KI-Endpunkt vali-assistant verwenden, um über Prompts oder Python-Skripte die gewünschten Ausgaben zu erzeugen.

Sobald im Skriptmodul ein neues Python-Skript mit der benutzerdefinierten Aktion erstellt wurde, kann der Benutzer in der Option „General“ eine benutzerdefinierte Aktion erstellen (1) innerhalb der Skripteinstellungen. Der Benutzer muss die Informationen zum Objekttyp (2) sowie eine Beschreibung angeben und die „Anzeigeeinstellungen“ (3) ausfüllen, d. h. den Anzeigenamen und die Position der benutzerdefinierten Aktion.

Erstellen einer „Custom Action“ innerhalb eines Skripts – Abschnitt „Settings“ im Skriptmodul für die benutzerdefinierte Aktion.
Falls das benutzerdefinierte Skript erstellt wird, um einen benutzerdefinierten Workflow im System Design Module auszuführen, muss der Benutzer bei „Placement“ die Option Blocks auswählen.

Wenn der Benutzer ein Skript für eine benutzerdefinierte Aktion erstellt und keine „Display Settings“ angibt, ist die benutzerdefinierte Aktion für den Benutzer im Drei-Punkte-Menü des Objekts (z. B. Requirement) nicht zugänglich. Jeder Benutzer muss die Display Settings im Skript erstellen, damit die „Custom Action“ in den Modulen angezeigt werden kann.

Wenn der Benutzer mindestens „Read only“-Zugriff auf das Skript hat, kann er die benutzerdefinierte Aktion erstellen.

Der Benutzer kann die benutzerdefinierte Aktion außerdem über die Option „Share with“ unterhalb der Anzeigeeinstellungen mit beliebigen Benutzern oder Gruppen innerhalb der Deployment-Umgebung teilen (siehe Abbildung Share Custom Action).

image-20240409-115928.pngCustom Action teilen – Benutzerdefinierte Aktionen mit anderen Benutzern im selben Projekt teilen.

Die Übersicht der Custom Actions ist im Menü „Settings“ (1) zugänglich, sodass Benutzer die Vielfalt der von anderen erstellten benutzerdefinierten Aktionen (2) anzeigen können. Benutzer können diese Aktionen nahtlos zu ihren Anzeigeeinstellungen hinzufügen oder daraus entfernen und ihren Zugriff auf benutzerdefinierte Aktionen (3) anpassen.

Einstellungen für Custom Actions – Hier kann der Benutzer verschiedene Eigenschaften einer benutzerdefinierten Aktion festlegen, z. B. ob sie angezeigt wird, eine Beschreibung, den Namen usw.

Beispiele für Workflows mit Custom Actions:

Example 1: Den Bezeichner der Anforderungen von Groß- in Kleinschreibung umwandeln


Zur Veranschaulichung dieses Beispiels haben wir das Python-Skript bereits zu den Skriptvorlagen innerhalb des Moduls hinzugefügt. Das Skript wandelt den Bezeichner von Groß- in Kleinschreibung um. Ein kurzes Video zeigt, wie Sie dieses Skript, seine benutzerdefinierte Aktion und deren Verwendung für Anforderungen erstellen können.

Ihre Bezeichner umbenennen – Den Bezeichner der Anforderungen von Groß- in Kleinschreibung umwandeln

Das Skript wurde als Vorlage im Skriptmodul hinzugefügt. Beim Erstellen eines Skripts können Sie „Custom actions“ auswählen und dann die vorhandenen Vorlagen auswählen, um den Code auch für Ihren benutzerdefinierten Workflow wiederzuverwenden.

Achten Sie darauf, wichtige Informationen innerhalb des Skripts an Ihren Anwendungsfall anzupassen.

 

Example 2: Anforderungen mithilfe von Custom Actions in Kombination mit KI von einer Sprache in eine andere übersetzen

Mit der KI von ValiAssistant können Sie mühelos eine Reihe von Anforderungen übermitteln und den vali-assistant per Prompt anweisen, diese in eine beliebige unterstützte Sprache Ihrer Wahl zu übersetzen.

Custom Action Translate – Verwenden Sie die Custom Actions und die KI-Funktionalität, um beispielsweise Ihren Anforderungstext in eine andere Sprache zu übersetzen.

Einige weitere Anwendungsfälle, die mit benutzerdefinierten Aktionen umgesetzt werden können

  • Qualitätsprüfung einer Anforderung

  • Mehrere Valis über Block Types erstellen und dem Block hinzufügen

  • Prüfen, ob die High-Level-Anforderungen gut sind, und umgekehrt prüfen, ob die Low-Level-Anforderungen nicht vage sind.

  • Anforderungstyp vorschlagen

  • Anforderungstext/-formatierung in großen Mengen bearbeiten, z. B.: „must“ durch „shall“ ersetzen usw.

  • Zusammenfassung der Anforderungen erstellen usw.

Zugriff auf Custom Actions

Diese von Benutzern erstellten benutzerdefinierten Aktionen können dann bequem für den allgemeinen Zugriff gespeichert werden, sodass sie mühelos mit einer Vielzahl von Objekten verknüpft werden können, darunter Anforderungen, Blocks und Valis innerhalb des Requirements & Systems Portal. Das bedeutet, dass ein normaler Benutzer, wenn er eine benutzerdefinierte Aktion ausführen muss, sie einfach im Menü „Actions“ des Objekts (Anforderungen, Blocks oder Valis) auswählen kann, ohne zur Ausführung zum Skriptmodul oder zu einem Dashboard navigieren zu müssen.

Zugriff auf Custom Actions – Zugriff auf die benutzerdefinierten Aktionen über die Spalte „Actions“ und „ValiAssistant“.

Auf die benutzerdefinierten Aktionen für das System Design Module kann auf ähnliche Weise zugegriffen werden. Der Benutzer muss sich jedoch in der Listenansicht aller „Blocks“ befinden.

Zugriff auf die benutzerdefinierte Aktion im System Design Module

 

AI-LocalizedAI-localized
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Feature Availability

The features available to you depend on which Altium solution you have – Altium Develop, an edition of Altium Agile (Agile Teams or Agile Enterprise), or Altium Designer (on active term).

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Inhalt