BMC Remedy コネクタリファレンス

設定

パラメータ

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

Basic Configuration (基本設定)

この設定に指定できる接続種別。

x

Expiration Policy (有効期限ポリシー)

ExpirationPolicy

ランタイムで有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最小時間を設定します。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

Basic Configuration (基本設定) 型

パラメータ

名前 説明 デフォルト値 必須

Username (ユーザ名)

String (文字列)

エンドユーザの認証に必要なユーザ名。

x

Password (パスワード)

String (文字列)

ユーザ名に関連付けられているパスワード。

x

Server (サーバ)

String (文字列)

接続する Remedy サーバ URL。

x

Server Port (サーバポート)

Number (数値)

使用する serverPort。

Authentication (認証)

String (文字列)

Locale (ロケール)

String (文字列)

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Cache Timeout Seconds (キャッシュタイムアウト (秒))

Number (数値)

3600

Attachment As String (添付ファイル (文字列))

Boolean (ブール)

true

Enum As Id (列挙 (ID))

Boolean (ブール)

false

操作

  • Create

  • Create Single

  • Delete Entry

  • Disconnect Server

  • Get

  • Get Single

  • Query

  • Update

  • Update Single

  • Upsert

  • Upsert Single

Create

<remedy:create>

指定された Remedy フォームのエントリを作成します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry (エントリ)

Array of Object (オブジェクトの配列)

作成するオブジェクトを表すマップのリスト。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Array of String (文字列の配列)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Create Single

<remedy:create-single>

指定された Remedy フォームの 1 つのエントリを作成します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry (エントリ)

Object (オブジェクト)

作成するオブジェクトを表すマップ。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Delete Entry

<remedy:delete-entry>

指定されたサーバから指定された ID のフォームエントリを削除します。ベースフォームのエントリのみを削除できます。結合フォームのエントリを削除するには、基盤となるベースフォームからエントリを削除します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

エントリが含まれる Remedy フォーム

x

Entry ID (エントリ ID)

String (文字列)

削除するエントリの ID。

x

Delete Optio (削除オプション)

Number (数値)

このパラメータには 0 (将来の使用のために保持) を指定します。

x

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Disconnect Server

<remedy:disconnect-server>

手動でサーバから切断できるようにします。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Get

<remedy:get>

指定された Remedy フォームの指定された ID のエントリを取得します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry ID (エントリ ID)

Array of String (文字列の配列)

取得するオブジェクトの ID が含まれるリスト

#[payload]

Results use Field IDs (結果で項目 ID を使用)

Boolean (ブール)

省略可能 - 戻り値でキーとして項目 ID が使用されるかどうか。

false

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

Array of Object (オブジェクトの配列)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Get Single

<remedy:get-single>

指定された Remedy フォームの指定された ID の 1 つのエントリを取得します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry ID (エントリ ID)

String (文字列)

取得するオブジェクトの ID。

#[payload]

Result uses Field IDs (結果で項目 ID を使用)

Boolean (ブール)

省略可能 - 戻り値でキーとして項目 ID が使用されるかどうか。

false

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Query

<remedy:query>

クエリ文字列に一致する、指定された Remedy フォームのエントリを取得します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Query (クエリ)

String (文字列)

解析する評価文字列

#[payload]

Result with Field ID (項目 ID が含まれる結果)

Boolean (ブール)

省略可能 - 戻り値でキーとして項目 ID が使用されるかどうか。

false

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

Array of Object (オブジェクトの配列)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Update

<remedy:update>

指定された Remedy フォームのエントリを更新します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry (エントリ)

Array of Object (オブジェクトの配列)

更新するオブジェクトの新しいバージョンを表すマップのリスト。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Update Single

<remedy:update-single>

指定された Remedy フォームの 1 つのエントリを更新します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry (エントリ)

Object (オブジェクト)

更新するオブジェクトの新しいバージョンを表すマップ。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Upsert

<remedy:upsert>

指定された Remedy フォームのエントリを作成します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry (エントリ)

Array of Object (オブジェクトの配列)

作成または更新するオブジェクトを表すマップのリスト。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Array of String (文字列の配列)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Upsert Single

<remedy:upsert-single>

指定された Remedy フォームの 1 つのエントリを更新/挿入します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Remedy Form Type (Remedy フォーム種別)

String (文字列)

使用する Remedy フォーム。

x

Entry (エントリ)

Object (オブジェクト)

作成または更新するオブジェクトを表すマップ

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

  • config

スロー

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Reconnection (再接続) 型

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

  • reconnect

  • reconnect-forever

使用する再接続戦略。

Reconnect (再接続) 型

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

Count (カウント)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続) 型

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれか:

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

maxIdleTime 属性に使用できる時間単位。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub