Jira Service Management

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

• OAuth2.0
  • 用戶端 ID： 外部應用程式提供的用戶端 ID。
  • 範圍： 權限範圍。offline_access 範圍必須與 Jira Service Management 連接器搭配使用。如要瞭解範圍的運作方式，以及查看 Jira Service Management 的所有可用範圍，請參閱「範圍」。
  • 用戶端密鑰： 選取 Secret Manager 密鑰。 設定這項授權前，您必須先建立 Secret Manager 密鑰。
  • 密鑰版本： 用戶端密鑰的 Secret Manager 密鑰版本。

  如果是 Authorization code 驗證類型，建立連線後，您必須執行幾個額外步驟來設定驗證。詳情請參閱建立連結後需執行的額外步驟。

• 基本
  • 使用者名稱：用於驗證的 Jira Service Management 使用者帳戶。
  • 密碼：與帳戶相關聯的密碼。
• APIToken
  • 使用者名稱：用於建立 API 權杖的 Jira Service Management 使用者名稱。
  • API 權杖：使用者名稱的密碼是 API 權杖。選取 Secret Manager Secret，內含與 Jira Cloud 使用者名稱相關聯的 API 權杖。

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

系統限制

Jira Service Management 連接器每秒可處理 15 筆交易，每個節點也是如此，且會節流任何超出此限制的交易。根據預設，Integration Connectors 會為連線分配 2 個節點 (以提高可用性)。

如要瞭解 Integration Connectors 適用的限制，請參閱「限制」一文。

動作

Jira Service Management 連接器提供「AddAttachment」、「AttachTemporaryFile」和「CreateCustomer」等動作。如要瞭解如何設定動作，請參閱「動作範例」。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 附加暫時檔案

這個範例會附加暫時性檔案，並提供用於新增附件的附件 ID。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 AttachTemporaryFile 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

     {
       "Content": "test to create 1 temporaryid"
     }

如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似以下內容：

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

範例 - 新增附件

這個範例會將暫時檔案附加至輸入內容酬載中提供的要求 ID。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 AddAttachment 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
       "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
       "RequestId": "10032"
   }  

如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似以下內容：

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

範例 - 建立客戶

這個範例會建立顧客。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CreateCustomer 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
     "Email": "something@something.com",
     "FullName": "Something"
   } 

如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似以下內容：

[{
    "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"
}]

實體作業範例

範例 - 列出所有要求

這個範例會列出 Requests 實體中的所有要求。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「要求」。
3. 選取「LIST」作業，然後按一下「完成」。

範例 - 取得特定服務台 ID 的要求

這個範例會從 Requests 實體取得 RequestKey 為 DP1-14 的要求。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Requests。
3. 選取「LIST」作業，然後按一下「完成」。
4. 在「Connectors」(連接器) 工作的「Task Input」(工作輸入) 區段中，按一下「filterClause」，然後在「Default Value」(預設值) 欄位中輸入 RequestKey='DP1-14'。

   其中 RequestKey 是 Requests 實體的主鍵值。

範例 - 建立要求

這個範例會在 Requests 實體中建立要求。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Requests。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {, , ,) VALUES ('2', '1', '','test');
       "RequestTypeId": "2",
       "ServiceDeskId": "1",
       "Summary": "test",
       "Description": "test"
     }
     

   如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

    {
       "RequestId": "10032"
     } 
     

在整合項目中使用 Jira Service Management 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

• 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。
• 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。