Jira Cloud-Aktionen hinzufügen

Wenn Jira-Aktionen aktiviert sind, können Endnutzer den Assistenten bitten, die folgenden Jira Cloud-Aktionen auszuführen:

  • Jira-Vorgänge erstellen
  • Jira-Vorgänge bearbeiten

Ein Nutzer könnte beispielsweise „Erstelle eine Jira-Vorgang vom Typ ‚Story‘ mit dem Titel ‚Launch Project Y‘ im Projekt ABC“ oder „Aktualisiere den Titel des Jira-Tickets JCD-1 zu ‚Launch Project Y‘“ in Ihre App eingeben. Der Assistent fragt bei Bedarf nach zusätzlichen Details und bittet den Nutzer dann, die Erstellungs- oder Bearbeitungsanfrage zu bestätigen.

Der Assistent kann die folgenden Jira-Felder über Aktionen lesen und bearbeiten:

Feld Beschreibung
Fehler-ID Erforderlich. ID des zu ändernden Problems, z. B. KAN-123.
Titel Titel der Ausgabe.
Art des Problems Art des Problems.
Priorität Priorität des Problems.
Status Problemstatus.
Beschreibung Problembeschreibung im Markdown-Format.
Komponente Problemkomponente
Zuständige Person Der Verantwortliche für das Problem, z. B. user@google.com.

Authentifizierung und Berechtigungen in Jira einrichten

Bevor Sie Jira-Aktionen aktivieren, muss ein Jira-Administrator dedizierte OAuth 2.0-Anmeldedaten für Aktionen in Jira einrichten. Dies ist erforderlich, um Ihre Jira-Integration zu verbinden und Lese- und Schreibberechtigungen für Aktionen zu gewähren.

Autorisierungsclients für Jira-Vorgänge unterscheiden sich von denen für die Aufnahme von Jira-Daten. Sie verwenden unterschiedliche Berechtigungen und eine andere Callback-URL-Konfiguration. Informationen zum Einrichten von Autorisierungsklienten für Jira Cloud-Connectoren zum Erfassen von Daten finden Sie unter Jira Cloud verbinden.

In dieser Anleitung wird beschrieben, wie Sie über die Atlassian Developer Console eine Client-ID und einen Clientschlüssel erstellen, die erforderlichen OAuth 2.0-Bereiche konfigurieren und Nutzerberechtigungen einrichten. Rufen Sie schließlich die URL und ID Ihrer Instanz ab, konfigurieren Sie Rollen und authentifizieren Sie sich, um Daten zwischen Jira Cloud und Google zu lesen und zu schreiben.

Client-ID und Clientschlüssel erstellen

  1. Melden Sie sich unter developer.atlassian.com an.
  2. Klicken Sie rechts oben auf das Profilsymbol und wählen Sie Entwicklerkonsole aus.
  3. Klicken Sie auf Erstellen und wählen Sie OAuth 2.0-Integration aus.
  4. Geben Sie einen Namen für die App ein.
    • Klicken Sie das Kästchen für die Nutzungsbedingungen an.
    • Klicken Sie auf Erstellen.
  5. Klicken Sie auf Autorisierung.
  6. Wählen Sie in der Tabelle Autorisierungstyp für OAuth 2.0 (3LO) die Option Hinzufügen aus.
  7. Geben Sie im Feld Callback-URL https://vertexaisearch.cloud.google.com/oauth-redirect ein und klicken Sie dann auf Änderungen speichern.
  8. Klicken Sie auf Berechtigungen:

    1. Rufen Sie die Jira API auf, klicken Sie auf Hinzufügen und dann auf Konfigurieren.
    2. Wechseln Sie zum Tab Klassische Bereiche und klicken Sie auf Bereiche bearbeiten. Wählen Sie die folgenden Bereiche aus und speichern Sie dann Ihre Änderungen:

      • Klassische Bereiche:

        • read:jira-work
        • read:jira-user
        • write:jira-work
      • Detaillierte Bereiche:

        • read:user:jira
  9. Klicken Sie auf Verteilung, wählen Sie Bearbeiten aus und gehen Sie so vor:

    1. Wählen Sie zuerst das Optionsfeld Freigabe aus, um andere Felder bearbeiten zu können.
    2. Füllen Sie die restlichen Felder aus.
      1. Wählen Sie für Anbieter die Option Google aus.
      2. Geben Sie https://policies.google.com als Datenschutzerklärung ein.
      3. Wählen Sie für Speichert Ihre App personenbezogene Daten? die Option Yes aus.
      4. Klicken Sie das Kästchen Ich bestätige, dass ich die API für Berichte zu personenbezogenen Daten implementiert habe an.
    3. Klicken Sie auf Änderungen speichern.
  10. Wählen Sie Einstellungen aus, um Ihre Client-ID und Ihren Clientschlüssel zu kopieren.

Instanz-URL und ‑ID abrufen

So rufen Sie die Instanz-URL ab:

  1. Rufen Sie atlassian.net auf und melden Sie sich mit Ihrem Administratorkonto an.
  2. Wählen Sie die App aus, die Sie synchronisieren möchten. Synchronisieren Sie beispielsweise die erste App.
  3. Suchen Sie die Instanz-URL, die Subdomain in der Adressleiste.

So rufen Sie die Instanz-ID ab:

  1. Öffnen Sie einen neuen Tab, kopieren Sie die Instanz-URL und hängen Sie /_edge/tenant_info an die Instanz-URL an. Beispiel: https://YOUR-INSTANCE.atlassian.net/_edge/tenant_info
  2. Rufen Sie den Link auf, um den Wert für cloudId zu finden. Die cloudId ist Ihre Instanz-ID.

Berechtigungen und Rollen einrichten

  1. Melden Sie sich mit Ihrem Administratorkonto bei atlassian.com an.
  2. Klicken Sie links oben auf das Menüsymbol oder rufen Sie admin.atlassian.com auf.
  3. Klicken Sie auf der Seite Verwaltung auf Nutzer verwalten und rufen Sie die Seite Gruppen auf.
  4. Klicken Sie auf Gruppe erstellen. Geben Sie einen Namen für die Gruppe ein und erstellen Sie sie.
  5. Klicken Sie auf der Seite Ihrer neuen Gruppe im Bereich Gruppenzugriff auf Produkte auf Produkte zur Gruppe hinzufügen.
  6. Wählen Sie für Jira die Produktrolle Administrator für Nutzerzugriff aus.
  7. Wählen Sie für Jira-Administrator die Produktrolle Produktadministrator aus und speichern Sie die Änderungen.
  8. Klicken Sie auf der Seite Gruppen auf Gruppenmitglieder hinzufügen und fügen Sie Nutzer oder Konten hinzu, mit denen sich der Connector authentifizieren soll.

Aktualisierungstoken abrufen

Wenn Sie Jira-Vorgänge über die Google Cloud Console konfigurieren möchten, müssen Sie kein Aktualisierungstoken abrufen.

Wenn Sie die API zum Konfigurieren Ihrer Jira-Aktionen verwenden müssen, ist ein Aktualisierungstoken erforderlich. So erhalten Sie ein Aktualisierungstoken:

  1. Rufen Sie Ihre App in der Google Cloud Console auf.
  2. Wählen Sie Autorisierung aus.
  3. Wählen Sie neben OAuth 2.0 (3LO) die Option Konfigurieren aus.
  4. Verwenden Sie für die Weiterleitungs-URL einen Platzhalter wie https://beispiel.de.
  5. Wenn Sie in Ihrem ersten Autorisierungsvorgang ein Aktualisierungstoken erhalten möchten, fügen Sie offline_access dem Bereichsparameter der Autorisierungs-URL hinzu. Beispiel: https://auth.atlassian.com/authorize?audience=api.atlassian.com&client_id=your_client_id**&scope=offline_access**%20read%3Ajira-user&redirect_uri=https%3A%2F%2Fyour-redirect-url&state=%24%7BYOUR_USER_BOUND_VALUE%7D&response_type=code&prompt=consent
  6. Nach der Autorisierung werden Sie zur Weiterleitungs-URL zurückgeleitet. In der Adressleiste sollte ein Abfrageparameter namens „code“ zu sehen sein. Notieren Sie sich den Wert.
  7. Verwenden Sie Tools wie curl oder Postman, um eine POST-Anfrage an https://auth.atlassian.com/oauth/token zu senden, mit einem JSON-Objekt mit den folgenden Schlüsseln:

    1. grant_type: authorization_code
    2. client_id: Ihre Client-ID
    3. client_secret: Ihr Clientschlüssel
    4. code: Der Code, den Sie in Schritt 6 erhalten haben
    5. redirect_uri: Ihr Weiterleitungs-URI
  8. Sie erhalten das Aktualisierungstoken in der Antwort.

Weitere Informationen zu Aktualisierungstokens finden Sie in der Atlassian-Dokumentation unter Implementieren des Aktualisierungstoken-Ablaufs.

Jira-Aktion konfigurieren

In diesem Abschnitt wird beschrieben, wie Sie einen Jira-Connector für Aktionen erstellen und Jira-Aktionen für Ihren Assistenten aktivieren.

Hinweise

Bevor Sie Ihre Aktionen konfigurieren, müssen Sie die folgenden Schritte ausführen:

  • Ihr Projekt muss auf die Zulassungsliste für Assistant-Aktionen gesetzt werden.
  • Ein Jira-Administrator hat die Schritte unter Authentifizierung und Berechtigungen in Jira einrichten ausgeführt und Ihnen die folgenden Informationen zur Verfügung gestellt:
    • Client-ID
    • Clientschlüssel
    • Instanz-ID
    • Aktualisierungstoken. Nur erforderlich, wenn Jira-Vorgänge über die API statt über die Google Cloud -Konsole erstellt werden. Google empfiehlt, Aktionen über die Google Cloud Console zu erstellen.

Jira-Aktionen in der Google Cloud -Konsole konfigurieren

Google empfiehlt, Aktionen über die Google Cloud Console zu erstellen.

So fügen Sie Ihrer App über die Console Aktionen hinzu:

  1. Rufen Sie in der Google Cloud Console die Seite Gemini Enterprise auf.
  2. Rufen Sie Ihre App auf.
  3. Klicken Sie im Navigationsmenü auf Aktionen.
  4. Klicken Sie für Jira auf Verbinden.
  5. Wählen Sie eine Jira-Instanz aus.
  6. Geben Sie bei entsprechender Aufforderung die Autorisierungsinformationen für den Connector ein. Das ist nur erforderlich, wenn die Instanz noch nicht für eine Aktion konfiguriert wurde.
  7. Wählen Sie aus, welche Aktionen aktiviert werden sollen.
  8. Klicken Sie auf Einrichtung fertigstellen. Ihre Aktion wird auf der Seite Aktionen angezeigt.

Jira-Vorgänge mit der API erstellen und aktivieren

Google empfiehlt, Aktionen über die Google Cloud Console zu erstellen. Wenn Sie Aktionen mit der API erstellen müssen, gehen Sie so vor:

  1. Jira-Connector erstellen und für die Suche konfigurieren:

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-GFE-SSL: yes" \
    -H "X-Goog-User-Project: PROJECT_NUMBER" \
    "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/global:setUpDataConnector" \
    -d '{
      "collectionId": "COLLECTION_ID",
      "collectionDisplayName": "COLLECTION_DISPLAY_NAME",
      "dataConnector": {
        "dataSource": "jira",
        "params": {
          "client_id": "{Client ID of your Jira integration}",
          "client_secret": "{Client Secret of your Jira integration}",
          "refresh_token": "{Refresh Token of your Jira integration}",
          "instance_id": "{Your Jira Cloud instance ID}"
        },
        "refreshInterval": "{ >1800 }s",
        "entities": [
          {
            "entityName" : "project",
            "params" : {
              "inclusion_filters" : {}
            }
          },
          {
            "entityName": "{attachment/comment/issue/worklog}" // Optional, you can build up to 4 different entities
          }
        ],
        "syncMode": "PERIODIC"
      }
    }
    

    Ersetzen Sie Folgendes:

    • PROJECT_NUMBER: Die Nummer Ihres Google Cloud -Projekts
    • COLLECTION_ID: die ID für die Sammlung.
    • COLLECTION_DISPLAY_NAME: Ein Anzeigename für die Sammlung.
  2. Fügen Sie Ihrem Jira-Connector Aktionskonfigurationen hinzu:

    curl -X PATCH \
      -H "Authorization: Bearer $(gcloud auth print-access-token --project "PROJECT_NUMBER")" \
      -H "Content-Type: application/json" \
      -H "X-Goog-User-Project: PROJECT_NUMBER" \
      "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/global/collections/COLLECTION_ID/dataConnector?update_mask=action_config" \
      -d '{
      "name": "projects/PROJECT_NUMBER/locations/global/collections/COLLECTION_ID/dataConnector",
      "action_config": {
        "is_action_configured": true,
        "action_params": {
            "client_id": "{Client id from Jira integration}",
            "client_secret": "{Client secret from Jira integration}",
            "instance_uri": "{instance URI of your Jira instance}"
          }
        }
      }'
    
  3. Jira-Aktionen für Ihren Assistenten aktivieren:

    curl -X PATCH \
      -H "Authorization: Bearer $(gcloud auth print-access-token --project "<var>PROJECT_NUMBER</var>")" \
      -H "Content-Type: application/json" \
      -H "X-Goog-User-Project: PROJECT_NUMBER" \
      "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/global/collections/default_collection/engines/APP_ID/assistants/default_assistant?update_mask=enabledActions" \
      -d '{
        "name": "projects/PROJECT_NUMBER/locations/global/collections/default_collection/engines/APP_ID/assistants/default_assistant",
        "enabledActions": {
          "projects/PROJECT_NUMBER/locations/global/collections/CONNECTOR_ID/dataConnector": {
            "actionInfo": [
              {
                "actionName": "create_jira_issue",
                "actionDisplayName": "Create Jira Issue"
              }
            ]
          }
        }
      }'
    

    Ersetzen Sie Folgendes:

    • PROJECT_NUMBER: Die Nummer Ihres Google Cloud -Projekts

    • APP_ID: Die ID der App.

    • CONNECTOR_ID: die Sammlungs-ID des Connectors, die Sie im vorherigen Schritt generiert haben.

Nachdem Sie Aktionen hinzugefügt haben, kann der Assistent diese Aktionen im Namen Ihrer Endnutzer in der App ausführen. Wenn ein Nutzer den Assistenten zum ersten Mal auffordert, eine Jira Cloud-Aktion auszuführen, wird er aufgefordert, den Zugriff auf sein Atlassian-Konto zu autorisieren.