Jira Service Management

Mit dem Jira Service Management-Connector können Sie eine Verbindung zu Jira Service Management herstellen und Vorgänge zum Einfügen, Löschen, Aktualisieren und Lesen ausführen.

Hinweise

Führen Sie die folgenden Aufgaben aus, bevor Sie den Jira Service Management-Connector verwenden:

  • In Ihrem Google Cloud-Projekt:
    • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkverbindung.
    • Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
    • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

    • Aktivieren Sie die folgenden Dienste:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

    Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

  1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Seite „Verbindungen“

  2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
  3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
    1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

    2. Tippen Sie auf Weiter.
  4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie Jira Service Management aus der Drop-down-Liste der verfügbaren Connectors aus.
    2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
    3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 49 Zeichen haben.
    4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
    5. Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf Error festgelegt.
    6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    7. Geben Sie eine Service Desk-ID des authentifizierten Nutzers ein. Standardmäßig erhalten wir die erste ID, die von einem zusätzlichen Aufruf zurückgegeben wird, um alle Servicedesks abzurufen. Sie können die ServiceDeskId abrufen, indem Sie eine Listenabfrage an die Entität „ServiceDesks“ ausführen.
    8. Geben Sie die Ausführlichkeitsstufe für die Verbindung ein. Sie kann zwischen 1 und 5 liegen. Bei einem höheren Ausführlichkeitsgrad werden alle Kommunikationsdetails (Anfrage-, Antwort- und SSL-Zertifikate) protokolliert.
    9. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:

      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

    10. Proxy verwenden: Aktivieren Sie dieses Kästchen, um einen Proxyserver für die Verbindung zu konfigurieren. Legen Sie dann die folgenden Werte fest:
      • Proxy-Authentifizierungsschema: Wählen Sie den Authentifizierungstyp für die Authentifizierung beim Proxyserver aus. Die folgenden Authentifizierungstypen werden unterstützt:
        • Standard: Basis-HTTP-Authentifizierung.
        • Digest: Digest-HTTP-Authentifizierung.
      • Proxy User: Ein Nutzername, der für die Authentifizierung beim Proxyserver verwendet werden soll.
      • Proxy-Passwort: Das Secret Manager-Secret des Nutzerpassworts.
      • Proxy-SSL-Typ: Der SSL-Typ, der beim Herstellen einer Verbindung zum Proxyserver verwendet werden soll. Die folgenden Authentifizierungstypen werden unterstützt:
        • Automatisch: Standardeinstellung. Wenn es sich um eine HTTPS-URL handelt, wird die Option „Tunnel“ verwendet. Wenn die URL eine HTTP-URL ist, wird die Option NEVER verwendet.
        • Immer: Für die Verbindung ist immer SSL aktiviert.
        • Nie: Für die Verbindung ist SSL nicht aktiviert.
        • Tunnel: Die Verbindung erfolgt über einen Tunneling-Proxy. Der Proxyserver öffnet eine Verbindung zum Remote-Host und der Traffic fließt über den Proxy hin und zurück.
      • Geben Sie im Abschnitt Proxy-Server die Details zum Proxy-Server ein.
        1. Klicken Sie auf + Ziel hinzufügen.
        2. Wählen Sie einen Zieltyp aus.
          • Hostadresse: Geben Sie den Hostnamen oder die IP-Adresse des Ziels an.

            So stellen Sie eine private Verbindung zu Ihrem Backend-System her:

            • Erstellen Sie einen PSC-Dienstanhang.
            • Erstellen Sie einen Endpunktanhang und geben Sie dann die Details des Endpunktanhangs in das Feld Hostadresse ein.
    11. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    12. Tippen Sie auf Weiter.
  5. Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
    1. Zieltyp: Wählen Sie einen Zieltyp aus.
      • Wählen Sie in der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse des Ziels anzugeben.
      • Wenn Sie eine private Verbindung zu Ihren Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang und dann den erforderlichen Endpunktanhang aus der Liste Endpunktanhang aus.

      Wenn Sie eine öffentliche Verbindung zu Ihren Back-End-Systemen mit zusätzlicher Sicherheit herstellen möchten, können Sie statische ausgehende IP-Adressen für Ihre Verbindungen konfigurieren und dann Ihre Firewallregeln konfigurieren, um nur bestimmte statische IP-Adressen zuzulassen.

      Wenn Sie weitere Ziele eingeben möchten, klicken Sie auf + ZIEL HINZUFÜGEN.

    2. Tippen Sie auf Weiter.
  6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
    1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden von der Jira Service Management-Verbindung unterstützt:

      • OAuth2.0
      • Einfach
      • APIToken
    2. Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

    3. Tippen Sie auf WEITER.
  7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
  8. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

  • OAuth2.0
    • Client-ID: Client-ID, die von Ihrer externen Anwendung bereitgestellt wird.
    • Bereiche: Berechtigungsbereiche. Der Bereich offline_access muss mit dem Jira Service Management-Connector verwendet werden. Um zu verstehen, wie die Bereiche funktionieren und alle für Jira Service Management verfügbaren Bereiche Siehe Bereiche.
    • Client-Secret: Wählen Sie das Secret Manager-Secret aus. Sie müssen das Secret Manager-Secret erstellt haben, bevor Sie diese Autorisierung konfigurieren.
    • Secret-Version: Secret Manager-Secret-Version für den Clientschlüssel.
    • Für den Authentifizierungstyp Authorization code müssen Sie nach dem Erstellen der Verbindung einige zusätzliche Schritte zum Konfigurieren der Authentifizierung ausführen. Weitere Informationen finden Sie unter Zusätzliche Schritte nach dem Erstellen der Verbindung.

  • Einfach
    • Nutzername: Das für die Authentifizierung verwendete Jira Service Management-Nutzerkonto.
    • Passwort: Das mit dem Konto verknüpfte Passwort.
  • APIToken
    • Nutzername: Der Jira Service Management-Nutzername, mit dem das API-Token erstellt wurde.
    • API-Token: Das Passwort für den Nutzernamen ist ein API-Token. Wählen Sie das Secret Manager-Secret aus, das das mit dem Jira Cloud-Nutzernamen verknüpfte API-Token enthält.

Zusätzliche Schritte nach dem Erstellen der Verbindung

Wenn Sie OAuth 2.0 - Authorization code für Authentifizierung verwenden, müssen Sie nach dem Erstellen der Verbindung die folgenden zusätzlichen Schritte ausführen:

  1. Gehen Sie auf der Seite „Verbindungen“ so vor: finden Sie die neu erstellte Verbindung.

    Der Status des neuen Connectors lautet Autorisierung erforderlich.

  2. Klicken Sie auf Autorisierung erforderlich.

    Daraufhin wird der Bereich Autorisierung bearbeiten angezeigt.

  3. Kopieren Sie den Wert Weiterleitungs-URI in Ihre externe Anwendung.
  4. Prüfen Sie die Autorisierungsdetails.
  5. Klicken Sie auf Autorisieren.

    Ist die Autorisierung erfolgreich, wird der Verbindungsstatus im Seite „Verbindungen“.

Erneute Autorisierung für Autorisierungscode

Wenn Sie den Authentifizierungstyp Authorization code verwenden und Änderungen an der Konfiguration in Ihrer Jira Service Management-Anwendung vorgenommen haben, müssen Sie Ihre Jira Service Management-Verbindung noch einmal autorisieren. So autorisieren Sie eine Verbindung noch einmal:

  1. Klicken Sie auf der Seite Verbindungen auf die gewünschte Verbindung.

    Die Seite mit den Verbindungsdetails wird geöffnet.

  2. Klicken Sie auf Bearbeiten, um die Verbindungsdetails zu bearbeiten.
  3. Überprüfen Sie die Details unter OAuth 2.0 – Autorisierungscode im Abschnitt Authentifizierung.

    Nehmen Sie gegebenenfalls die erforderlichen Änderungen vor.

  4. Klicken Sie auf Speichern. Daraufhin gelangen Sie zur Seite mit den Verbindungsdetails.
  5. Klicken Sie im Abschnitt Authentifizierung auf Autorisierung bearbeiten. Daraufhin wird der Bereich Authorize (Autorisieren) angezeigt.
  6. Klicken Sie auf Autorisieren.

    Wenn die Autorisierung erfolgreich war, wird der Verbindungsstatus auf der Seite „Verbindungen“ auf Aktiv gesetzt.

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

  • Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

    Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

  • Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:

    Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keinen der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Liste Operations aufgeführt.

  • Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und eine Ausgabe . Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Systemeinschränkungen

Der Jira Service Management-Connector kann 15 Transaktionen pro Sekunde und pro Knoten verarbeiten. Transaktionen, die dieses Limit überschreiten, werden drosselt. Standardmäßig werden von Integration Connectors zwei Knoten (für eine bessere Verfügbarkeit) für eine Verbindung zugewiesen.

Informationen zu den Limits für Integration Connectors finden Sie unter Limits.

Aktionen

Der Jira Service Management-Connector bietet Aktionen wie „AddAttachment“, „AttachTemporaryFile“ und „CreateCustomer“. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

Beispiele für Aktionen

In diesem Abschnitt wird beschrieben, wie Sie einige der Aktionen in diesem Connector ausführen.

Beispiel: Temporäre Datei anhängen

In diesem Beispiel wird eine temporäre Datei angehängt und eine Anhangs-ID angegeben, mit der Sie einen Anhang hinzufügen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion AttachTemporaryFile aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
      {
        "Content": "test to create 1 temporaryid"
      }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der in etwa so aussieht:

    [{
        "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "FileName": "16324233309516250343.connector.txt"
    }] 

Beispiel: Anhang hinzufügen

In diesem Beispiel wird die temporäre Datei an die in der Eingabenutzlast bereitgestellte Anfrage-ID angehängt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion AddAttachment aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
        "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "RequestId": "10032"
    }  
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der in etwa so aussieht:

    [{
      "Success": "true",
      "filename": "16324233309516250343.connector.txt",
    }] 

Beispiel – Kunden erstellen

In diesem Beispiel wird ein Kunde erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CreateCustomer aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
      "Email": "something@something.com",
      "FullName": "Something"
    } 
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Connector-Aufgabe hat einen Wert ähnlich dem folgenden:

    [{
        "Key": null,
        "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "Name": null,
        "EmailAddress": "something@something.com",
        "DisplayName": "Something",
        "Active": "true",
        "Timezone": "Asia/Calcutta",
        "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
        "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
        "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
        "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
        "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
    }]

Beispiele für Entitätsvorgänge

Beispiel – Alle Anfragen auflisten

In diesem Beispiel werden alle Anfragen in der Entität Requests aufgelistet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity „Anfragen“ aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.

Beispiel – Anfragen von einer bestimmten Servicedesk-ID abrufen

In diesem Beispiel wird die Anfrage mit dem RequestKey „DP1-14“ aus der Entität Requests abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Requests aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf filterClause und Geben Sie dann RequestKey='DP1-14' in das Feld Default Value (Standardwert) ein.

    Hier ist RequestKey der Primärschlüsselwert der Entität Requests.

Beispiel – Anfrage erstellen

In diesem Beispiel wird eine Anfrage in der Entität Requests erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Requests aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {, , ,) VALUES ('2', '1', '','test');
        "RequestTypeId": "2",
        "ServiceDeskId": "1",
        "Summary": "test",
        "Description": "test"
      }
      

    Ist die Integration erfolgreich, enthält das Feld connectorOutputPayload der Connector-Aufgabe , der in etwa so aussieht:

     {
        "RequestId": "10032"
      } 
      

Verbindungen mit Terraform erstellen

Mit dem Terraform-Code Ressource, um eine neue Verbindung zu erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispiel-Terraform-Vorlage zum Erstellen einer Verbindung finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie in der Terraform-Konfigurationsdatei die folgenden Variablen festlegen:

Parametername Datentyp Erforderlich Beschreibung
proxy_enabled BOOLEAN Falsch Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme ENUM Falsch Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. Unterstützte Werte: BASIC, DIGEST, NONE
proxy_user STRING Falsch Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
proxy_password SECRET Falsch Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.
proxy_ssltype ENUM Falsch Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll. Unterstützte Werte sind: AUTO, ALWAYS, NEVER, TUNNEL

Jira Service Management-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in beiden Apigee-Integration und Anwendungsintegration Sie können die Verbindung über die Connectors-Aufgabe in einer Integration verwenden.

  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Tasks für Connectors.

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte