AzureDevOps連携の受信設定ファイル(LMIS_RestAPISetting)
- ユニリタ
- ユニリタ
AzureDevOps連携の送信設定ファイルは、Lightning Experience環境でAzureDevOpsからLMISへの連携機能で使用します。
AzureDevOps連携の受信設定ファイル(LMIS_RestAPISetting)の基本情報、定義内容、定義例などについて説明します。
＜目次＞
ファイルの基本情報
項目 | 内容 |
|---|---|
ドキュメントの一意の名前 | 任意 |
ドキュメント名 | LMIS_RestAPISetting |
ファイル保管先 | LMISドキュメントフォルダ |
ファイル反映のタイミング | 本ファイルをLMIS上に配置したときに反映します。 |
フォーマット | テキスト形式ファイル |
改行コード | LF |
文字コード | UTF-8(BOMなし) |
定義内容
属性
以下の属性を、JSON形式で記述します。
処理識別子(name)毎に設定を行うことで、連携先の組織、またはサービスごとの設定を記載できます。
属性 | 説明 | 省略可否 | レコード値の使用 | 省略値 | |
|---|---|---|---|---|---|
name | 任意の処理識別子を指定します。指定した内容は、AzureDevOpsの設定の際に使用します。 詳細は、「AzureDevOpsのService hooksを構成する」を参照してください。 | × | × | - | |
operator | 要求処理タイプを設定します。 | × | × | - | |
auth | 認証有無を指定します。
| ○ | × | None | |
parameters | 認証パラメータ、連携するLMISのオブジェクトを設定します。 | × | × | - | |
clientId | 認証に使用する、任意の文字列を指定します。指定した内容は、AzureDevOpsの設定の際に使用します。 詳細は、「AzureDevOpsのService hooksを構成する」を参照してください。 | authがIdToken時に省略不可 | × | - | |
accessToken | 認証に使用する、任意の文字列を指定します。指定した内容は、AzureDevOpsの設定の際に使用します。 詳細は、「AzureDevOpsのService hooksを構成する」を参照してください。 | authがIdToken時に省略不可 | × | - | |
type | 連携するLMISのオブジェクトのAPI参照名を指定します。 例："type": "SMOC__ox_obj_incident__c" | itemsに、field:"type"が存在すれば省略可 | ○ | - | |
items | 連携するLMISの項目に対する操作を指定します。 連携する項目の数だけ指定します。 | × | ○ | - | |
field | LMISの項目のAPI参照名を指定します。 field : "SMOC__ox_txt_subject__c" | × | × | - | |
value | LMISに連携する値を指定します。
レコード値以外の内容は、すべて文字列の入力として認識されます。 | × | ○ | - | |
adaptor | 連携する値を変換します。
| ○ | × | 未指定 | |
operation | 連携するタイミングを変更できます。
| ○ | × | onUpsert | |
レコード値の使用
一部の設定、および連携値にAzureDevOpsのWorkItemの内容を使用することができます。
属性="{!WorkItemの項目ID}"
の形式で記載することで、レコード値を連携に利用できます。
また、WorkItemの項目IDは、以下の形式で指定します。
標準項目の例
{!resource:revision:fields:System.Title}追加項目の例
{!resource:revision:fields:Custom.ObjectCategory}}AzureDevOpsのWorkItemのID
{!resource:workItemId}
用途例 | 設定例 |
|---|---|
連携するLMISのオブジェクトに、 | parameters:{ |
連携値のvalueに、 | items:[ |
定義例
[
{
"name": "test_devops",
"operator": "Path",
"auth": "IdToken",
"parameters": {
"clientId": "post_clientid",
"accessToken": "post_accessToken",
"type": "SMOC__ox_obj_incident__c"
},
"items": [
{
/*
LMISのレコードIdの連携
AzureDevOpsのWorkitemのカスタム項目「CustomId」項目の内容を、LMISの「レコードID」項目(API参照名：Id)に連携します。
この値は、AzureDevOpsからLMISの連携の際に、LMISのレコード更新のキー項目として使用されます。
*/
"field": "Id",
"value": "{!resource:revision:fields:Custom.customId}"
},
{
/*
AzureDevOpsのWorkItemIdの連携
AzureDevOpsの「WorkitemのId」を、カスタム項目(API参照名：Custom_IntegrationId__c)に連携します。
この値は、LMISからAzureDevOpsの連携の際に、AzureDevOpsのWorkItem更新のキー項目として使用されます。
*/
"field": "Custom_IntegrationId__c",
"value": "{!resource:workItemId}"
},
{
/*
AzureDevOpsのWorkitemの標準項目「Title」項目を、LMISの「内容」項目(API参照名：SMOC__ox_ltx_content__c)に連携します。
*/
"field": "SMOC__ox_txt_subject__c",
"value": "{!resource:revision:fields:System.Title}"
},
{
/*
LMISの「問い合わせ方法」項目(API参照名：SMOC__ox_sel_inquiry__c)に、固定値「Web」を連携します。
*/
"field": "SMOC__ox_sel_inquiry__c",
"value": "Web"
},
{
/*
LMISの「内容」項目(API参照名：SMOC__ox_ltx_content__c)に、AzureDevOpsのWorkitemの標準項目「Description」項目を連携します。
本例では、adaptorパラメータにDevOpsLongTextAdaptorを指定しているため、AzureDevOps形式テキストをロングテキストエリア値に変換して連携します。
*/
"field": "SMOC__ox_ltx_content__c",
"value": "{!resource:revision:fields:System.Description}",
"adaptor": "DevOpsLongTextAdaptor"
}
]
}
]注意事項
必ずUTF-8形式で保存してください。UTF-8形式以外の文字コードで保存した場合、正しく設定されないことがあります。
改行コードとしては「LF」を使用してください。間違って「CRLF」の改行コードを使用してファイルを編集して保存した場合、設定が正しく機能しない場合があります。
定義例には説明のためにコメント(赤字部分)が含まれていますが、設定ファイルにコメントを使用することはできません。定義例を複製して利用する場合は、コメントを削除して利用してください。
パラメータを省略する場合には、属性を削除するか値を空白にします。
参考情報
AzureDevOpsからLMISへの連携については、「AzureDevOpsからLMISに連携する」を参照してください。
LMISのオブジェクト、および項目のAPI参照名の確認方法については「オブジェクトの項目のAPI参照名とデータ型を確認する」を参照してください。
連携可能な項目型の詳細については、「AzureDevOps連携項目の変換早見表」を参照してください。