AzureDevOps連携の送信設定ファイル(LMIS_OutboundHookSetting)

Owned by ユニリタ
3月 17, 2022
2 min read

AzureDevOps連携の送信設定ファイルは、Lightning Experience環境でのLMISからAzureDevOpsへの連携機能で使用します。

AzureDevOps連携の送信設定ファイル(LMIS_OutboundHookSetting)の基本情報、定義内容、定義例などについて説明します。


＜目次＞

ファイルの基本情報

項目

内容

項目

内容

ドキュメントの一意の名前

任意

ドキュメント名

LMIS_OutboundHookSetting

ファイル保管先

LMISドキュメントフォルダ

ファイル反映のタイミング

本ファイルをLMIS上に配置したときに反映します。

フォーマット

テキスト形式ファイル

改行コード

LF

文字コード

UTF-8(BOMなし)

定義内容

属性

以下の属性を、JSON形式で記述します。
連携元となるオブジェクト、およびレコードタイプ毎に設定を行うことができます。

属性

説明

省略可否

レコード値の使用

省略値

属性

説明

省略可否

レコード値の使用

省略値

endpoint

「https://dev.azure.com」を指定します。

×

×

-

operator

「AzureDevOps」を指定します。

×

×

-

objectFrom

連携元レコードのオブジェクトのAPI参照名を指定します。

×

×

-

recordTypeFrom

連携元レコードのレコードタイプのAPI参照名を指定します。
オブジェクトのレコードタイプ毎に設定を行いたい場合に指定します。
連携元レコードタイプが一致する設定と、レコードタイプが未指定の設定が存在した場合は、
レコードタイプが一致する設定を優先して使用します。

○

×

マスタ、またはすべてのレコードタイプ

parameters

AzureDevOps特有のパラメータを設定します。

×

×

-



organization

AzureDevOpsのOrganizationを指定します。

×

○

-

project

AzureDevOpsのProjectを指定します。

×

○

-

type

AzureDevOpsのWorkitemのTypeを指定します。

例："type" : "issue"

×

○

-

authUser

AzureDevOpsとの連携に使用するアカウントのIDを指定します。

詳細は、「AzureDevOpsのアクセストークンを取得する」を参照してください。

×

○

-

authToken

AzureDevOpsとの連携に使用するアカウントで発行した、アクセストークン値を指定します。

詳細は、「AzureDevOpsのアクセストークンを取得する」を参照してください。

×

○

-

api-version

AzureDevOpsとの連携に使用するAPIのバージョンを指定します。

「5.0」を指定します。

×

○

-

connectionTo

AzureDevOpsのWorkItemのIDを保持するテキスト項目のAPI参照名を指定します。

LMISのレコードとAzureDevOpsのレコードを1:1で関連付ける場合は、必ず指定してください。
指定しない場合、LMISからAzureDevOpsへの連携は、常にレコードを作成する動作となります。

○

○

IDを保持しません。
レコードを更新しません。

connectionUrl

AzureDevOpsのWorkItemのURLを保持するテキスト項目のAPI参照名を指定します。

ロングテキストエリア等、改行を含む項目を指定することで、LMISのレコードに、
連携先のWorkItemへのリンクを表示することができます。

○

○

URLを保持しません。

items

連携するAzureDevOpsのWorkItemのFieldに対する操作を指定します。

連携する項目の数だけ指定します。

×

○

-



field

AzureDevOpsの項目IDを指定します。
設定例

  • 標準項目
    field : "/fields/System.Description"

  • 追加項目
    field : "/fields/Custom.CustomNum01"

×

×

-

value

AzureDevOpsに連携する値を指定します。
設定例

  • レコード値
    value : "{!SMOC__ox_txt_subject__c}"

  • 数値
    value : 1.5

  • 論理値
    value : true

  • 文字列
    value : "LMIS"

レコード値以外の内容は、すべて文字列の入力として認識されます。

×

○

-

adaptor

連携する値を変換します。

  • 未指定：変換しません。

  • BooleanAdaptor：文字列を論理値に変換します。論理値("true","false")以外を変換した場合、連携は失敗します。

  • DecimalAdaptor：文字列を数値に変換します。空白、数値以外を変換した場合、連携は失敗します。

  • StringAdaptor：文字列以外の値を文字列に変換します。

  • DevOpsLongTextAdaptor：ロングテキストをAzureDevOps形式テキストに変換します。

  • DevOpsRichTextAdaptor：リッチテキストをAzureDevOps形式テキストに変換します。
    連携時に画像が削除されます。

○

×

未指定

operation

連携するタイミングを変更できます。

  • onInsert：レコードの作成時に連携を行います。

  • onUpdate：レコードの更新時に連携を行います。

  • onUpsert：レコードの作成、更新時に連携を行います。

○

×

onUpsert

レコード値の使用

一部の設定、および連携値に連携元レコードの内容、型情報を使用することができます。

属性="{!連携元オブジェクトのAPI参照名}"

の形式で記載することで、レコード値を連携に利用できます。

用途例

設定例

用途例

設定例

AzureDevOpsのWorkitemのTypeに、
連携元レコードの値を使用する

parameters:{
～省略～
type:"{!SMOC__ox_sel_category__c}"
～省略～
}

連携値のvalueに、
連携元レコードの値を使用する

items:[
～省略～
{
field:"/fields/System.Title",
value:"{!SMOC__ox_txt_subject__c}"
},
～省略～
]

定義例

[ { "endpoint" : "https://dev.azure.com", "operator" : "AzureDevOps", "objectFrom" : "SMOC__ox_obj_incident__c", "recordtypeFrom" : "", "parameters": { "organization": "lmisdevopstest", "project": "test01", "type" : "issue", "authUser" : "devopsuser@devops2lmis.com", "authToken": "e27uargot4evnjlqqhegs5k6gledoimppddzoj4xqtmhy7lnstha", "api-version": "5.0", /* connectionToパラメータ(AzureDevOpsのWorkItemIdの連携) 連携したAzureDevOpsの「WorkitemのId」を、カスタム項目(API参照名：Custom_IntegrationId__c)に保存します。 この値は、LMISからAzureDevOpsの連携の際に、AzureDevOpsのWorkItem更新のキー項目として使用されます。 */ "connectionTo" : "Custom_IntegrationId__c", /* connectionUrlパラメータ 連携したAzureDevOpsのWorkitemのUrlを、カスタム項目(API参照名：Custom_IntegrationUrl__c)に保存します。 */ "connectionUrl" : "Custom_IntegrationUrl__c" }, "items": [ { /* LMISのレコードIdの連携 LMISの「レコードID」項目(API参照名：Id)を、AzureDevOpsのWorkitemのカスタム項目「CustomId」項目に連携します。 この値は、AzureDevOpsからLMISの連携の際に、LMISのレコード更新のキー項目として使用されます。 */ "field" : "/fields/Custom.CustomId", "value" : "{!Id}" }, { /* LMISの「件名」項目(API参照名：SMOC__ox_txt_subject__c)を、AzureDevOpsのWorkitemの標準項目「Title」項目に連携します。 本例では、operationパラメータにonInsertを指定しているため、登録時のみ連携します。 */ "field" : "/fields/System.Title", "value" : "{!SMOC__ox_txt_subject__c}", "operation":"onInsert" }, { /* LMISの「内容」項目(API参照名：SMOC__ox_ltx_content__c)を、AzureDevOpsのWorkitemの標準項目「Description」項目に連携します。 本例では、adaptorパラメータにDevOpsLongTextAdaptorを指定しているため、ロングテキストをAzureDevOps形式テキストに変換して連携します。 */ "field" : "/fields/System.Description", "value" : "{!SMOC__ox_ltx_content__c}", "adaptor" : "DevOpsLongTextAdaptor" } ] } ]

注意事項

  • 必ずUTF-8形式で保存してください。UTF-8形式以外の文字コードで保存した場合、正しく設定されないことがあります。

  • 改行コードとしては「LF」を使用してください。間違って「CRLF」の改行コードを使用してファイルを編集して保存した場合、設定が正しく機能しない場合があります。

  • 定義例には説明のためにコメント(赤字部分)が含まれていますが、設定ファイルにコメントを使用することはできません。定義例を複製して利用する場合は、コメントを削除して利用してください。

  • パラメータを省略する場合には、属性を削除するか値を空白にします。

参考情報