# Benutzerdefinierte Linsen für Workloads in AWS WA Tool Sie können benutzerdefinierte Linsen mit Ihren eigenen Säulen, Fragen, bewährten Methoden und Verbesserungsplänen erstellen. Sie wenden benutzerdefinierte Linsen auf dieselbe Weise auf eine Workload an, wie Sie von AWS bereitgestellte Linsen anwenden. Sie können auch benutzerdefinierte Linsen, die Sie erstellen, für andere AWS-Konten freigeben, und benutzerdefinierte Linsen, die anderen gehören, können für Sie freigegeben werden. Sie können die Fragen in einer benutzerdefinierten Linse auf eine bestimmte Technologie zuschneiden, dafür sorgen, dass sie Ihnen helfen, die Governance-Anforderungen in Ihrem Unternehmen zu erfüllen, oder die durch das Well-Architected Framework und die AWS-Linsen bereitgestellte Anleitung erweitern. Wie bei den vorhandenen Linsen können Sie den Fortschritt im Laufe der Zeit verfolgen, indem Sie Meilensteine erstellen und anhand von Berichten regelmäßig den Status angeben. **Topics** + [Anzeige benutzerdefinierter Linsen in AWS WA Tool](lenses-viewing.md) + [Erstellen einer benutzerdefinierten Linse für eine Workload in AWS WA Tool](lenses-create.md) + [Vorschau einer benutzerdefinierten Linse für eine Workload in AWS WA Tool](lenses-preview.md) + [Erstmaliges Veröffentlichen einer benutzerdefinierten Linse in AWS WA Tool](lenses-publish.md) + [Veröffentlichen eines Updates für eine benutzerdefinierte Linse in AWS WA Tool](lenses-publish-update.md) + [Freigeben einer benutzerdefinierten Linse in AWS WA Tool](lenses-sharing.md) + [Hinzufügen von Tags zu einer benutzerdefinierten Linse in AWS WA Tool](lenses-tagging.md) + [Löschen einer benutzerdefinierten Linse in AWS WA Tool](lenses-deleting.md) + [Spezifikation des Linsenformats in AWS WA Tool](lenses-format-specification.md) # Anzeige benutzerdefinierter Linsen in AWS WA Tool Sie können die Details benutzerdefinierter Linsen, die Sie besitzen, und solcher, die für Sie freigegebenen wurden, anzeigen. **Anzeigen einer Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. **Anmerkung** Der Abschnitt **Benutzerdefinierte Linsen** ist leer, wenn Sie keine benutzerdefinierte Linse erstellt haben oder keine benutzerdefinierte Linse für Sie freigegeben wurde. 1. Wählen die benutzerdefinierten Linsen aus, die Sie anzeigen möchten. + **Owned by me (Gehört mir)** – Zeigt benutzerdefinierte Linsen an, die Sie erstellt haben. + **Shared with me (Für mich freigegeben)** – Zeigt benutzerdefinierte Linsen an, die für Sie freigegeben wurden. 1. Wählen Sie die anzuzeigende benutzerdefinierte Linse auf eine der folgenden weisen aus: + Wählen Sie den Namen der Linse aus. + Wählen Sie die Linse aus, und klicken Sie auf **View details (Details anzeigen)**. Die Seite [Anzeigen von Linsendetails für eine Workload in AWS WA Tool](lenses-details.md) wird angezeigt. Die Seite **Custom lenses (Benutzerdefinierte Linsen)** enthält die folgenden Felder: **Name** Der Name der Linse. **Eigentümer** Die AWS-Konto-ID, der die benutzerdefinierte Linsev gehört. **Status** Der Status **PUBLISHED (VERÖFFENTLICHT)** bedeutet, dass die benutzerdefinierte Linse veröffentlicht wurde und auf Workloads angewendet oder für andere AWS-Konten freigegeben werden kann. Der Status **DRAFT (ENTWURF)** bedeutet, dass die benutzerdefinierte Linse erstellt, jedoch noch nicht veröffentlicht wurde. Eine benutzerdefinierte Linse muss veröffentlicht werden, bevor sie auf Workloads angewendet freigegeben werden kann. **Version** Der Name der Version der benutzerdefinierten Linse. **Letzte Aktualisierung** Datum und Uhrzeit, zu dem/der die benutzerdefinierte Linse zuletzt aktualisiert wurde. # Erstellen einer benutzerdefinierten Linse für eine Workload in AWS WA Tool **Erstellen einer benutzerdefinierten Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie **Create custom lens (Benutzerdefinierte Linse erstellen)**. 1. Wählen Sie zum Herunterladen der JSON-Vorlagendatei **Download file (Datei herunterladen)** aus. 1. Öffnen Sie die JSON-Vorlagendatei mit Ihrem bevorzugten Texteditor, und fügen Sie die Daten für Ihre benutzerdefinierte Linse hinzu. Zu diesen Daten gehören Ihre Säulen, Fragen, bewährten Verfahren und Links zu Verbesserungsplänen. Weitere Einzelheiten finden Sie unter [Spezifikation des Linsenformats in AWS WA Tool](lenses-format-specification.md). Eine benutzerdefinierte Linse darf eine Größe von 500 KB nicht überschreiten. 1. Wählen Sie **Choose file (Datei auswählen)**, um Ihre JSON-Datei auszuwählen. 1. (Optional) Fügen Sie im Abschnitt **Tags** alle Tags hinzu, die Sie der benutzerdefinierten Linse zuordnen möchten. 1. Wählen Sie **Submit & Preview (Senden und Vorschau)**, um eine Vorschau der benutzerdefinierten Linse anzuzeigen, oder **Submit (Senden)**, um die benutzerdefinierte Linse ohne Vorschau zu senden. Wenn Sie für Ihre benutzerdefinierte Linse **Submit & Preview (Senden und Vorschau)** wählen, können Sie auf **Next (Weiter)** klicken, um durch die Linsen-Vorschau zu navigieren, oder auf **Exit preview (Vorschau beenden)** klicken, um zu den **benutzerdefinierten Linsen** zurückzukehren. Wenn die Überprüfung fehlschlägt, bearbeiten Sie Ihre JSON-Datei, und versuchen Sie erneut, die benutzerdefinierte Linse zu erstellen. Nach der Validierung Ihrer JSON-Datei durch AWS WA Tool wird Ihre benutzerdefinierte Linse unter **Benutzerdefinierte Linsen** angezeigt. Nachdem eine benutzerdefinierte Linse erstellt wurde, befindet sie sich im Status **DRAFT (ENTWURF)**. Sie müssen [die Linse veröffentlichen](lenses-publish.md), bevor sie auf Workloads angewendet oder für andere AWS-Konten freigegeben werden kann. Sie können bis zu 15 benutzerdefinierte Linsen in einem AWS-Konto erstellen. **Haftungsausschluss** Geben oder erfassen Sie keine personenbezogenen Daten (PII) von Endbenutzern oder anderen identifizierbaren Personen in oder über Ihre benutzerdefinierten Linsen. Wenn Ihre benutzerdefinierte Linse oder die für Sie freigegebenen geteilten und in Ihrem Konto verwendeten Linsen personenbezogene Daten enthalten oder erfassen, sind Sie dafür verantwortlich, sicherzustellen, dass die enthaltenen personenbezogenen Daten gemäß geltendem Recht verarbeitet werden, angemessene Datenschutzhinweise bereitzustellen und die erforderlichen Einwilligungen für die Verarbeitung dieser Daten einzuholen. # Vorschau einer benutzerdefinierten Linse für eine Workload in AWS WA Tool **Vorschau einer benutzerdefinierten Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Nur Linsen mit dem Status **DRAFT (ENTWURF)** können in der Vorschau angezeigt werden. Wählen Sie die gewünschte benutzerdefinierte **DRAFT**-Linse aus, und wählen Sie **Preview experience (Vorschau)**. 1. Wählen Sie **Next (Weiter)**, um durch die Linsenvorschau zu navigieren. 1. (Optional) Sie können Ihren **Verbesserungsplan** überprüfen, indem Sie für jede Frage in der Vorschau Best Practices auswählen und **Update based on answers (Auf Grundlage der Antworten aktualisieren)** auswählen, um Ihre Risikologik zu testen. Wenn Änderungen erforderlich sind, können Sie die [Risikoregeln](lenses-format-specification.md#lenses-format-risk-rules) in Ihrer JSON-Vorlage vor der Veröffentlichung aktualisieren. 1. Wählen Sie **Exit preview (Vorschau beenden)**“, um zur benutzerdefinierten Linse zurückzukehren. **Anmerkung** Sie können auch eine Vorschau einer benutzerdefinierten Linse anzeigen, indem Sie beim [Erstellen einer benutzerdefinierten Linse](lenses-create.md) die Option **Submit & Preview (Senden und Vorschau)** auswählen. # Erstmaliges Veröffentlichen einer benutzerdefinierten Linse in AWS WA Tool **Veröffentlichen einer benutzerdefinierten Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie die gewünschte benutzerdefinierte Linse aus, und wählen Sie **Publish lens (Linse veröffentlichen)**. 1. Geben Sie im Feld **Version name (Versionsname)** eine eindeutige Kennung für die Versionsänderung ein. Dieser Wert kann bis zu 32 Zeichen lang sein und darf nur alphanumerische Zeichen und Punkte („.“) enthalten. 1. Wählen Sie **Publish custom lens (Benutzerdefinierte Linse veröffentlichen)**. Nachdem eine benutzerdefinierte Linse veröffentlicht wurde, befindet sie sich im Status **PUBLISHED (VERÖFFENTLICHT)**. Die benutzerdefinierte Linse kann jetzt auf Workloads angewendet oder für andere AWS-Konten-Benutzer freigegeben werden. # Veröffentlichen eines Updates für eine benutzerdefinierte Linse in AWS WA Tool **Veröffentlichen eines Updates für eine vorhandene benutzerdefinierte Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie die gewünschte benutzerdefinierte Linse aus, und klicken Sie auf **Edit (Bearbeiten)**. 1. Wenn Sie keine aktualisierte JSON-Datei zur Hand haben, wählen Sie **Download file (Datei herunterladen)**, um eine Kopie der aktuellen benutzerdefinierten Linse herunterzuladen. Bearbeiten Sie die heruntergeladene JSON-Datei mit einem Texteditor Ihrer Wahl, und nehmen Sie die gewünschten Änderungen vor. 1. Wählen Sie **Choose file (Datei auswählen)**, um Ihre aktualisierte JSON-Datei auszuwählen, und wählen Sie **Submit & Preview (Senden und Vorschau)**, um eine Vorschau der benutzerdefinierten Linse anzuzeigen, oder **Submit (Senden)**, um die benutzerdefinierte Linse ohne Vorschau einzureichen. Eine benutzerdefinierte Linse darf eine Größe von 500 KB nicht überschreiten. Nach der Validierung Ihrer JSON-Datei durch AWS WA Tool wird Ihre benutzerdefinierte Linse unter **Custom lenses (Benutzerdefinierte Linsen)** im Status **DRAFT (ENTWURF)** angezeigt. 1. Wählen Sie erneut die benutzerdefinierte Linse aus, und wählen Sie **Publish lens (Linse veröffentlichen)**. 1. Wählen Sie **Review changes before publishing (Änderungen vor der Veröffentlichung überprüfen)**, um zu überprüfen, ob die an Ihrer benutzerdefinierten Linse vorgenommenen Änderungen korrekt sind. Dies beinhaltet die Überprüfung folgender Elemente: + Der Name der benutzerdefinierten Linse + Die Namen der Säulen + Die neuen, aktualisierten und gelöschten Fragen Wählen Sie **Next (Weiter)** aus. 1. Geben Sie Art der Versionsänderung an. **Hauptversion** Zeigt an, dass an der Linse substanzielle Änderungen vorgenommen wurden. Wird für Änderungen verwendet, die sich auf die Bedeutung der benutzerdefinierten Linse auswirken. Bei Workloads, bei denen die Linse angewendet wurde, wird eine Benachrichtigung darüber angezeigt, dass eine neue Version der benutzerdefinierten Linse verfügbar ist. Größere Versionsänderungen werden *nicht* automatisch auf Workloads angewendet, bei denen die Linse verwendet wird. **Unterversion** Zeigt an, dass geringfügigere Änderungen an der Linse vorgenommen wurden. Wird für kleinere Änderungen verwendet, z. B. Textänderungen oder Aktualisierungen der URL-Links. Kleinere Versionsänderungen werden automatisch auf Workloads angewendet, die die benutzerdefinierte Linse verwenden. Wählen Sie **Next (Weiter)** aus. 1. Geben Sie im Feld **Version name (Versionsname)** eine eindeutige Kennung für die Versionsänderung ein. Dieser Wert kann bis zu 32 Zeichen lang sein und darf nur alphanumerische Zeichen und Punkte („.“) enthalten. 1. Wählen Sie **Publish custom lens (Benutzerdefinierte Linse veröffentlichen)**. Nachdem eine benutzerdefinierte Linse veröffentlicht wurde, befindet sie sich im Status **PUBLISHED (VERÖFFENTLICHT)**. Die aktualisierte benutzerdefinierte Linse kann jetzt auf Workloads angewendet oder für andere AWS-Konten-Benutzer freigegeben werden. Wenn es sich bei dem Update um eine *größere Versionsänderung* handelt, werden alle Workloads, auf die die vorherige Version der Linse angewendet wurde, darüber informiert, dass eine neue Version verfügbar ist, und es wird die Option zum Upgrade angeboten. Kleinere Versionsaktualisierungen werden automatisch und ohne Benachrichtigung angewendet. Sie können bis zu 100 Versionen einer benutzerdefinierten Linse erstellen. # Freigeben einer benutzerdefinierten Linse in AWS WA Tool Sie können eine benutzerdefinierte Linse für andere AWS-Konten, Benutzer, AWS Organizations und Organisationseinheiten (OUs) freigeben. **Freigeben einer benutzerdefinierten Linse für andere AWS-Konten und Benutzer** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie die freizugebende Linse aus, und klicken Sie auf **View details (Details anzeigen)**. 1. Wählen Sie auf der [Anzeigen von Linsendetails für eine Workload in AWS WA Tool](lenses-details.md)-Seite die Option **Shares (Freigaben)**. Wählen Sie dann **Create (Erstellen)** und **Create Shares to Users oder Accounts (Freigaben für Benutzer oder Konten erstellen)** aus, um eine Einladung zur gemeinsamen Nutzung von Linsen zu erstellen. 1. Geben Sie die 12-stellige AWS-Konto-ID oder den ARN des Benutzers ein, für den Sie die benutzerdefinierte Linse freigeben möchten. 1. Wählen Sie **Create (Erstellen)**, um dem angegebenen AWS-Konto Benutzer eine Einladung zur gemeinsamen Nutzung einer benutzerdefinierten Linse zu senden. Sie können benutzerdefinierte Linsen für bis zu 300 AWS-Konten oder Benutzer freigeben. Wenn die Einladung zur gemeinsamen Nutzung der Linse nicht innerhalb von sieben Tagen angenommen wird, ist die Einladung automatisch abgelaufen. **Wichtig** Bevor Sie eine benutzerdefinierte Linse für eine Organisation oder Organisationseinheiten (OUs) freigeben können, müssen Sie [den AWS Organizations-Zugriff aktivieren](sharing.md#getting-started-sharing-orgs). **Freigeben einer benutzerdefinierten Linse für Ihre Organisation oder Organisationseinheiten** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie die benutzerdefinierte Linse aus, die freigegeben werden soll. 1. Wählen Sie auf der [Anzeigen von Linsendetails für eine Workload in AWS WA Tool](lenses-details.md)-Seite die Option **Shares (Freigaben)**. Wählen Sie dann **Create (Erstellen)** und **Create Shares to Organizations (Freigaben für Organisationen erstellen)** aus. 1. Wählen Sie auf der Seite **Create custom lens share (Freigabe einer benutzerdefinierten Linse erstellen)** aus, ob Sie der gesamten Organisation oder einer oder mehreren Organisationseinheiten Berechtigungen gewähren möchten. 1. Wählen Sie **Create (Erstellen)**, um die benutzerdefinierte Linse freizugeben. Um zu sehen, wer über freigegebenen Zugriff auf eine Workload verfügt, wählen Sie **Shares (Freigaben)** auf der Seite [Anzeigen von Linsendetails für eine Workload in AWS WA Tool](lenses-details.md). **Haftungsausschluss** Indem Sie Ihre benutzerdefinierten Linsen für andere AWS-Konten freigeben, erklären Sie sich damit einverstanden, dass AWS Ihre benutzerdefinierten Linsen diesen anderen Konten zur Verfügung stellt. Diese anderen Konten können weiterhin auf Ihre freigegebenen benutzerdefinierten Linsen zugreifen und diese verwenden, auch wenn Sie die benutzerdefinierten Linsen aus Ihren eigenen AWS-Konto löschen oder Ihre AWS-Konto beenden. # Hinzufügen von Tags zu einer benutzerdefinierten Linse in AWS WA Tool **Hinzufügen von Tags zu einer benutzerdefinierten Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie die benutzerdefinierte Linse aus, die Sie aktualisieren möchten. 1. Wählen Sie im Abschnitt **Tags** die Option **Manage tags (Tags verwalten)**. 1. Wählen Sie für jeden Tag, den Sie hinzufügen möchten, **Add new tag (Neuen Tag hinzufügen)**, und geben Sie den **Schlüssel** und den **Wert** des Tags ein. 1. Wählen Sie **Save (Speichern)**. Zum Entfernen eines vorhandenen Tags wählen Sie neben dem zu entfernenden Tag **Remove (Entfernen)** aus. # Löschen einer benutzerdefinierten Linse in AWS WA Tool **Löschen einer benutzerdefinierten Linse** 1. Melden Sie sich bei der AWS-Managementkonsole an und öffnen Sie AWS Well-Architected Tool-Konsole unter [https://console.aws.amazon.com/wellarchitected/](https://console.aws.amazon.com/wellarchitected/). 1. Wählen Sie im linken Navigationsbereich **Custom lenses (Benutzerdefinierte Linsen)** aus. 1. Wählen Sie die zu löschende benutzerdefinierte Linse aus, und klicken Sie auf **Delete (Löschen)**. 1. Wählen Sie **Löschen** aus. Bestehende Workloads, bei denen die Linse angewendet wurde, werden darüber informiert, dass die benutzerdefinierte Linse gelöscht wurde, können sie aber weiterhin verwenden. Die benutzerdefinierte Linse kann nicht mehr auf neue Workloads angewendet werden. **Haftungsausschluss** Indem Sie Ihre benutzerdefinierten Linsen für andere AWS-Konten freigeben, erklären Sie sich damit einverstanden, dass AWS Ihre benutzerdefinierten Linsen diesen anderen Konten zur Verfügung stellt. Diese anderen Konten können weiterhin auf Ihre freigegebenen benutzerdefinierten Linsen zugreifen und diese verwenden, auch wenn Sie die benutzerdefinierten Linsen aus Ihren eigenen AWS-Konto löschen oder Ihre AWS-Konto beenden. # Spezifikation des Linsenformats in AWS WA Tool Linsen werden mithilfe eines bestimmten JSON-Formats definiert. Wenn Sie mit der Erstellung einer benutzerdefinierten Linse beginnen, haben Sie die Möglichkeit, eine JSON-Vorlagendatei herunterzuladen. Sie können diese Datei als Grundlage für Ihre benutzerdefinierten Linsen verwenden, da sie die Grundstruktur für die Säulen, Fragen, bewährten Methoden und den Verbesserungsplan definiert. ## Abschnitt „Lens (Linse)“ In diesem Abschnitt werden die Attribute für die benutzerdefinierte Linse selbst definiert. Dies sind ihr Name und ihre Beschreibung. + `schemaVersion`: Die Version des benutzerdefinierten Linsenschemas, das verwendet werden soll. Von der Vorlage festgelegt, nicht ändern. + `name`: Name der Linse Der Name kann eine Länge von bis zu 128 Zeichen haben. + `description`: Textbeschreibung der Linse. Dieser Text wird angezeigt, wenn Sie Linsen auswählen, die während der Workload-Erstellung hinzugefügt werden sollen, oder wenn Sie eine Linse auswählen, die später auf eine vorhandene Workload angewendet werden soll. Die Beschreibung kann bis zu 2048 Zeichen lang sein. ``` "schemaVersion": "2021-11-01", "name": "Company Policy ABC", "description": "This lens provides a set of specific questions to assess compliance with company policy ABC-2021 as revised on 2021/09/01.", ``` ## Abschnitt „Pillars (Säulen)“ In diesem Abschnitt werden die Säulen definiert, die der benutzerdefinierten Linse zugeordnet sind. Sie können Ihre Fragen den Säulen des AWS Well-Architected Framework zuordnen, Ihre eigenen Säulen definieren oder beides. Sie können bis zu zehn Säulen in einer benutzerdefinierten Linse erstellen. + `id`: ID für die Säule. Die ID kann zwischen 3 und 128 Zeichen lang sein und darf nur alphanumerische Zeichen, Bindestriche („-“) und/oder Unterstriche („\$1“) enthalten. Die in einer Säule verwendete ID muss eindeutig sein. Verwenden Sie die folgenden IDs, wenn Sie Ihre Fragen den Säulen des Frameworks zuordnen: + `operationalExcellence` + `security` + `reliability` + `performance` + `costOptimization` + `sustainability` + `name`: Name der Säule. Der Name kann eine Länge von bis zu 128 Zeichen haben. ``` "pillars": [ { "id": "company_Privacy", "name": "Privacy Excellence", . . . }, { "id": "company_Security", "name": "Security", . . . } ] ``` ## Abschnitt „Questions (Frage)“ In diesem Abschnitt werden die Fragen definiert, die zu einer Säule gehören. Sie können bis zu 20 Fragen in einer Säule in einer benutzerdefinierten Linse definieren. + `id`: ID für die Frage. Die ID kann zwischen 3 und 128 Zeichen lang sein und darf nur alphanumerische Zeichen und Unterstriche („\$1“) enthalten. Die in einer Frage verwendeten IDs müssen eindeutig sein. + `title`: Titel der Frage. Der Titel kann eine Länge von bis zu 128 Zeichen haben. + `description`: Beschreibt die Frage ausführlicher. Die Beschreibung kann bis zu 2048 Zeichen lang sein. + `helpfulResource displayText`: Optional. Text, der hilfreiche Informationen zu der Frage enthält. Der Text kann eine Länge von bis zu 2048 Zeichen haben. Muss angegeben werden, wenn `helpfulResource url` angegeben ist. + `helpfulResource url`: Optional. Eine URL-Ressource, die die Frage ausführlicher erläutert. Die URL muss mit `http://` oder `https://` beginnen. **Anmerkung** Beim Synchronisieren eines benutzerdefinierten Lens-Workloads mit Jira werden bei Fragen sowohl die „ID“ als auch der „Titel“ der Frage angezeigt. Das in Jira-Tickets verwendete Format ist `[ QuestionID ] QuestionTitle`. ``` "questions": [ { "id": "privacy01", "title": "How do you ensure HR conversations are private?", "description": "Career and benefits discussions should occur on secure channels only and be audited regularly for compliance.", "helpfulResource": { "displayText": "This is helpful text for the first question", "url": "https://example.com/poptquest01_help.html" }, . . . }, { "id": "privacy02", "title": "Is your team following the company privacy policy?", "description": "Our company requires customers to opt-in to data use and does not disclose customer data to third parties either individually or in aggregate.", "helpfulResource": { "displayText": "This is helpful text for the second question", "url": "https://example.com/poptquest02_help.html" }, . . . } ] ``` ## Abschnitt „Choices (Auswahlmöglichkeiten)“ In diesem Abschnitt werden die Wahlmöglichkeiten definiert, die mit einer Frage verknüpft sind. Sie können bis zu 15 Auswahlmöglichkeiten für eine Frage in einer benutzerdefinierten Linse erstellen. + `id`: ID für die Auswahlmöglichkeit. Die ID kann zwischen 3 und 128 Zeichen lang sein und darf nur alphanumerische Zeichen und Unterstriche („\$1“) enthalten. Für jede Auswahlmöglichkeit in einer Frage muss eine eindeutige ID angegeben werden. Das Hinzufügen einer Auswahlmöglichkeit mit dem Suffix von `_no` fungiert als `None of these`-Auswahl für die Frage. + `title`: Titel der Auswahlmöglichkeit Der Titel kann eine Länge von bis zu 128 Zeichen haben. + `helpfulResource displayText`: Optional. Text, der hilfreiche Informationen zu einer Auswahlmöglichkeit enthält. Der Text kann eine Länge von bis zu 2048 Zeichen haben. Muss enthalten sein, falls `helpfulResource url` angegeben ist. + `helpfulResource url`: Optional. Eine URL-Ressource, die die Auswahlmöglichkeit detaillierter erklärt. Die URL muss mit `http://` oder `https://` beginnen. + `improvementPlan displayText`: Text, der beschreibt, wie eine Auswahlmöglichkeit verbessert werden kann. Der Text kann eine Länge von bis zu 2048 Zeichen haben. Ein `improvementPlan` ist für jede Auswahlmöglichkeit erforderlich, außer für `None of these`. + `improvementPlan url`: Optional. Eine URL-Ressource, die bei der Verbesserung helfen kann. Die URL muss mit `http://` oder `https://` beginnen. + `additionalResources type`: Optional. Die Art der zusätzlichen Ressourcen. Der Wert kann entweder `HELPFUL_RESOURCE` oder `IMPROVEMENT_PLAN` sein. + `additionalResources content`: Optional. Gibt die `displayText`- und `url`-Werte für die zusätzliche Ressource an. Für eine Auswahlmöglichkeit können bis zu fünf zusätzliche nützliche Ressourcen und bis zu fünf zusätzliche Verbesserungsplanelemente angegeben werden. + `displayText`: Optional. Text, der die nützliche Ressource oder den Verbesserungsplan beschreibt. Der Text kann eine Länge von bis zu 2048 Zeichen haben. Muss enthalten sein, falls `url` angegeben ist. + `url`: Optional. Eine URL-Ressource für die nützliche Ressource oder den Verbesserungsplan. Die URL muss mit `http://` oder `https://` beginnen. **Anmerkung** Wenn eine benutzerdefinierte Lens-Workload mit Jira synchronisiert wird, werden in den Auswahlmöglichkeiten die „ID“ der Frage und der Auswahlmöglichkeit sowie der „Titel“ der Auswahlmöglichkeit angezeigt. Das verwendete Format ist `[ QuestionID | ChoiceID ] ChoiceTitle`. ``` "choices": [ { "id": "choice_1", "title": "Option 1", "helpfulResource": { "displayText": "This is helpful text for the first choice", "url": "https://example.com/popt01_help.html" }, "improvementPlan": { "displayText": "This is text that will be shown for improvement of this choice.", "url": "https://example.com/popt01_iplan.html" } }, { "id": "choice_2", "title": "Option 2", "helpfulResource": { "displayText": "This is helpful text for the second choice", "url": "https://example.com/hr_manual_CORP_1.pdf" }, "improvementPlan": { "displayText": "This is text that will be shown for improvement of this choice.", "url": "https://example.com/popt02_iplan_01.html" }, "additionalResources":[ { "type": "HELPFUL_RESOURCE", "content": [ { "displayText": "This is the second set of helpful text for this choice.", "url": "https://example.com/hr_manual_country.html" }, { "displayText": "This is the third set of helpful text for this choice.", "url": "https://example.com/hr_manual_city.html" } ] }, { "type": "IMPROVEMENT_PLAN", "content": [ { "displayText": "This is additional text that will be shown for improvement of this choice.", "url": "https://example.com/popt02_iplan_02.html" }, { "displayText": "This is the third piece of improvement plan text.", "url": "https://example.com/popt02_iplan_03.html" } { "displayText": "This is the fourth piece of improvement plan text.", "url": "https://example.com/popt02_iplan_04.html" } ] } ] }, { "id": "option_no", "title": "None of these", "helpfulResource": { "displayText": "Choose this if your workload does not follow these best practices.", "url": "https://example.com/popt02_iplan_none.html" } } ``` ## Abschnitt „Risk Rules (Risikoregeln)“ In diesem Abschnitt wird definiert, wie die ausgewählten Optionen das Risikoniveau bestimmen. Sie können maximal drei Risikoregeln pro Frage definieren, eine für jede Risikostufe. + `condition`: Ein boolescher Ausdruck für die Auswahlmöglichkeiten, der einer Risikostufe für die Frage zugeordnet wird, oder `default`. Für jede Frage muss eine `default`-Risikoregel vorhanden sein. + `risk`: Gibt das mit der Bedingung verbundene Risiko an. Gültige Werte sind `HIGH_RISK`, `MEDIUM_RISK` und `NO_RISK`. Die Reihenfolge Ihrer Risikoregeln ist bedeutsam. Die erste `condition`, die als `true` bewertet wird, legt das Risiko für die Frage fest. Ein gängiges Muster für die Implementierung von Risikoregeln besteht darin, mit den am wenigsten riskanten (und in der Regel detailliertesten) Regeln zu beginnen und sich dann bis zu den riskantesten (und unspezifischsten) Regeln vorzuarbeiten. Zum Beispiel: ``` "riskRules": [ { "condition": "choice_1 && choice_2 && choice_3", "risk": "NO_RISK" }, { "condition": "((choice_1 || choice_2) && choice_3) || (!choice_1 && choice_3)", "risk": "MEDIUM_RISK" }, { "condition": "default", "risk": "HIGH_RISK" } ] ``` Wenn für die Frage drei Auswahlmöglichkeiten (`choice_1`, `choice_2` und `choice_3`) zur Verfügung stehen, führen diese Risikoregeln zu folgendem Verhalten: + Wenn alle drei Optionen ausgewählt sind, besteht kein Risiko. + Wenn entweder `choice_1` oder `choice_2` ausgewählt **und** `choice_3` ausgewählt ist, besteht ein mittleres Risiko. + Wenn `choice_1` **nicht** ausgewählt, aber `choice_3` ausgewählt ist, besteht ebenfalls ein mittleres Risiko. + Wenn keine dieser Bedingungen zutrifft, besteht ein hohes Risiko.