PDAutomationProvider:スコープ、グローバル

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：17分

    • PDAutomationProvider API を使用すると、実行中にオプションのアクティビティをプロセスに挿入できます。

    この API は プレイブック プラグイン (com.glide.pad.core) の一部であり、 sn_pad 名前空間で実行されます。

    この API を使用してスクリプトを呼び出すには、次のうち少なくとも 1 つが必要です。
    • 呼び出し元は、オプションのアクティビティトリガーが作成されたのと同じスコープ内にいる必要があります。
    • アドミン権限。

    プロセスは、レーン順に順序付けられた一連のアクティビティです。オプションのアクティビティは、プロセス設計時に事前定義されています。アクティビティが正確な時間に実行されるようにスケジュールされていません。アクティビティをレーンに割り当てて、レーンの実行中に実行できるようにすることができます。アクティビティをプロセスに割り当てて、レーンの実行中に実行できるようにすることができます。

    オプションのアクティビティを作成するには、アクティビティ [sys_pd_activity] テーブルで 開始ルール を [手動 ] に設定する必要があります。 プレイブック では現在、手動アクティビティの作成をサポートしていません。

    エージェントは、オプションのアクティビティを、別のアクティビティに関連するレーンまたはアクティビティに追加します。オプションのアクティビティを挿入するには、プロセスが実行されている必要があります。

    関連項目：

    PDAutomationProvider – activateProcess(文字列 processDefinitionSysId)

    プレイブックをアクティブ化します。

    表 : 1. パラメーター
    名前 タイプ 説明
    processDefinitionSysID 文字列 プレイブックのSys_id。

    テーブル:プロセス定義 [sys_pd_process_definition]
    表 : 2. 戻り値
    財産 説明
    オブジェクト プロセス定義のアクティブ化の詳細を含むオブジェクト。
    {
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}
    エラー エラーのリスト。成功した場合は空。

    データタイプ:文字列のアレイ
    process_definition アクティブ化されたプレイブックとそのプロパティ。

    データタイプ：オブジェクト

    "process_definition":
{
  "active": Boolean,
  "snapshot": {Object},
  "status": "String"
}
    process_definition.active 非アクティブ化されたプレイブックのプロセス定義がアクティブかどうかを示すフラグ。プロセス定義 [sys_pd_process_definition] リストでプロセス定義を検索します。
    有効な値：
    • true:非アクティブ化されたプレイブックのプロセス定義がアクティブです。
    • false:非アクティブ化されたプレイブックのプロセス定義は非アクティブです。

    データタイプ：ブール
    process_definition.snapshot アクティブ化時のプロセス定義に関する詳細が含まれています。

    データタイプ：オブジェクト

    {
  "snapshot":
    {
      "created": "String",
      "processDefinitionSysId": "String"
    }
}
    process_definition。スナップショット。作成日時 プレイブックが作成された日付。

    データタイプ：文字列
    process_definition。スナップショット。processDefinitionSysID アクティブ化されたプレイブックのsys_id。

    データタイプ：文字列
    process_definition.status プレイブックの公開ステータスを示します。
    可能な値：
    • draft:プレイブックはドラフトステータスです。
    • published:プレイブックは公開済みステータスです。

    データタイプ：文字列
    状況 アクティブ化の要求が成功したかどうかを示します。
    可能な値：
    • 成功:プレイブックが正常にアクティブ化されました。
    • エラー:プレイブックの ID が見つかりませんでした。

    データタイプ：オブジェクト

    次の例は、プレイブックをアクティブ化する方法を示しています。

    var myPlaybook = sn_pad.PDAutomationProvider.activateProcess('cdd1b85e43000210d96e29c28ab8f275');
gs.info(JSON.stringify(myPlaybook));
    出力： 
    {
  "process_definition": {
    "active": true,
    "snapshot": {
      "processDefinitionId": "cdd1b85e43000210d96e29c28ab8f275",
      "created": "2024-02-19 22:58:12"
    },
    "status": "published"
  },
  "state": "SUCCESS",
  "errors": []
}

    PDAutomationProvider – addOptionalActivityRelativeToActivityContext(String contextID, String activityId, String where, String relativeToId)

    指定されたオプションのアクティビティをプロセスに追加して、プロセスの実行中に別のアクティビティに相対的に実行されるようにします。

    プロセスが実行されると、各アクティビティにアクティビティコンテキストが作成されます。コンテキストは、アクティビティが実行をどのように処理するかも処理します。詳細については、「 プロセスオートメーションデザイナーのレーンとアクティビティ」を参照してください。

    表 : 3. パラメーター
    名前 タイプ 説明
    contextID 文字列 オプションのアクティビティを追加するアクティビティ実行のSys_id。アクセスするには、プロセス実行 [sys_pd_context] テーブルにリストされているプロセスをクリックします。選択した実行は、ステータスが [処理中] である必要があります。
    activityId 文字列 アクティビティ [sys_pd_activity] テーブルにリストされているオプションのアクティビティのSys_id。
    注:
    オプションのアクティビティを作成するには、アクティビティ [sys_pd_activity] テーブルで 開始ルール を [手動 ] に設定する必要があります。
    対象: 文字列 プロセス内のどこにアクティビティを配置するかを示します。
    有効な値：
    • AFTER - 相対アクティビティの後にこのアクティビティを実行します コンテキスト。
    • WITH – 別の相対アクティビティと同時にアクティビティを実行します コンテキスト。
    relativeToId 文字列 オプションのアクティビティが実行される相対アクティビティコンテキストの ID。アクティビティコンテキスト [sys_pd_activity_context] テーブルにリストされます。
    表 : 4. 戻り値
    タイプ 説明
    ブール アクティビティの実行が正常にスケジュールされたかどうかを示すフラグ。
    可能な値：
    • true:アクティビティの実行が正常にスケジュールされました。出力は 成功を示す文字列です。
    • false:アクティビティの実行が正常にスケジュールされていません。出力は、1 つ以上のエラーメッセージのアレイです。

    エラーの場合は、1 つ以上のエラーメッセージのリスト。それ以外の場合は 、0 以上の要素のアレイ を示すメッセージ。
    アレイ エラーの場合は、1 つ以上のエラーメッセージのリスト。それ以外の場合は 、0 以上の要素のアレイ を示すメッセージ。
    考えられるエラーメッセージ:
    • 無効なオプションアクティビティ ID: activityId パラメーターに指定されたsys_idが無効です。
    • 無効な PD コンテキスト ID: contextID パラメーターで指定されたプロセスデザイナー (PD) sys_idが無効です。
    • 無効なポジションタイプ:指定されたポジションタイプが無効です。有効なタイプについては、 where パラメーターの説明を参照してください。
    • 無効な相対 ID: relativeToId パラメーターに指定されたsys_idが無効です。
    • オプションアクティビティが見つかりません: activityId パラメーターに指定されたsys_idが見つかりませんでした。
    • プロセスはまだアクティブである必要がある:オプションのアクティビティを実行するには、このアクティビティを含むプロセスがアクティブである必要があります。
    • 相対アクティビティコンテキストが見つかりません relativeToIdパラメーターに指定されたsys_idが見つかりませんでした。

    次の例は、相対アクティビティコンテキストと同時にオプションアクティビティを実行する方法を示しています。

    var contextId = '<context_id>';
var optionalActivityId = '<optional_activity_id>';
var where = 'WITH'; // options AFTER, WITH
var relativeToId = '<relative_activity_context_id>'; // relative activity context ID

var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToActivityContext(contextId, optionalActivityId, where, relativeToId);

gs.info(JSUtil.describeObject(response));
    出力 (成功):
    success: boolean = true
errors: Array of 0 elements

    PDAutomationProvider – addOptionalActivityRelativeToLaneContext(String contextID, String activityId, String where, String relativeToId)

    レーンの実行コンテキスト中に実行するオプションのアクティビティをレーンに割り当てます。

    プロセスの実行時に、各レーンのレーンコンテキストが作成されます。コンテキストは、レーンが実行を処理する方法も処理します。詳細については、「 プロセスオートメーションデザイナーのレーンとアクティビティ」を参照してください。

    表 : 5. パラメーター
    名前 タイプ 説明
    contextID 文字列 オプションのアクティビティを追加するアクティビティ実行のSys_id。アクセスするには、プロセス実行 [sys_pd_context] テーブルにリストされているプロセスをクリックします。選択した実行は、ステータスが [処理中] である必要があります。
    activityId 文字列 アクティビティ [sys_pd_activity] テーブルにリストされているオプションのアクティビティのSys_id。
    注:
    オプションのアクティビティを作成するには、アクティビティ [sys_pd_activity] テーブルで 開始ルール を [手動 ] に設定する必要があります。
    対象: 文字列 プロセス内のどこにアクティビティを配置するかを示します。
    有効な値：
    • LAST – レーンの最後のアクティビティとして実行します コンテキスト。
    • NEXT – レーンの次のアクティビティで実行します コンテキスト。
    relativeToId 文字列 オプションのアクティビティが実行される相対レーンコンテキストの ID。レーンコンテキスト [sys_pd_lane_context] テーブルにリストされます。
    表 : 6. 戻り値
    タイプ 説明
    ブール アクティビティの実行が正常にスケジュールされたかどうかを示すフラグ。
    可能な値：
    • true:アクティビティの実行が正常にスケジュールされました。出力は 成功を示す文字列です。
    • false:アクティビティの実行が正常にスケジュールされていません。出力は、1 つ以上のエラーメッセージのアレイです。
    アレイ エラーの場合は、1 つ以上のエラーメッセージのリスト。それ以外の場合は 、0 以上の要素のアレイ を示すメッセージ。
    考えられるエラーメッセージ:
    • 無効なオプションアクティビティ ID: activityId パラメーターに指定されたsys_idが無効です。
    • 無効な PD コンテキスト ID: contextID パラメーターで指定されたプロセスデザイナー (PD) sys_idが無効です。
    • 無効なポジションタイプ:指定されたポジションタイプが無効です。有効なタイプについては、 where パラメーターの説明を参照してください。
    • 無効な相対 ID: relativeToId パラメーターに指定されたsys_idが無効です。
    • オプションアクティビティをレーンに追加できません: activityId パラメーターで指定されたオプションアクティビティを、 relativeToId パラメーターで指定されたレーンと比較して追加することはできません。選択した アクティビティの実行 が [ 処理中 ] ステータスであることを確認します。
    • オプションアクティビティが見つかりません: activityId パラメーターに指定されたsys_idが見つかりませんでした。
    • プロセスはまだアクティブである必要がある:オプションのアクティビティを実行するには、このアクティビティを含むプロセスがアクティブである必要があります。
    • 相対レーンコンテキストが見つかりません relativeToIdパラメーターに指定されたsys_idが見つかりませんでした。

    次の例は、オプションのアクティビティをレーンコンテキストで最後のアクティビティとして実行する方法を示しています。

    var contextId = '<context_id>';
var optionalActivityId = '<optional_activity_id>';
var where = 'LAST'; // options LAST, NEXT
var relativeToId = '<relative_lane_context_id>'; // relative lane context ID

var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToLaneContext(contextId, optionalActivityId, where, relativeToId);

gs.info(JSUtil.describeObject(response));
    出力 (成功):
    success: boolean = true
errors: Array of 0 elements

    PDAutomationProvider – deactivateProcess(String processDefinitionSysId)

    プレイブックを非アクティブ化します。

    表 : 7. パラメーター
    名前 タイプ 説明
    processDefinitionSysID 文字列 プレイブックのSys_id。

    テーブル:プロセス定義 [sys_pd_process_definition]
    表 : 8. 戻り値
    財産 説明
    オブジェクト プロセス定義の非アクティブ化の詳細を含むオブジェクト。
    {
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}
    エラー エラーのリスト。成功した場合は空。

    データタイプ:文字列のアレイ
    process_definition 非アクティブ化されたプレイブックとそのプロパティ。

    データタイプ：オブジェクト

    "process_definition":
{
  "active": Boolean,
  "snapshot": {Object},
  "status": "String"
}
    process_definition.active 非アクティブ化されたプレイブックのプロセス定義がアクティブかどうかを示します。プロセス定義 [sys_pd_process_definition] リストでプロセス定義を検索します。
    可能な値：
    • true:非アクティブ化されたプレイブックのプロセス定義がアクティブです。
    • false:非アクティブ化されたプレイブックのプロセス定義は非アクティブです。

    データタイプ：ブール
    process_definition.description 非アクティブ化されたプレイブックに関する詳細。

    データタイプ：文字列
    process_definition.label ユーザーに表示される非アクティブ化されたプレイブックの名前。

    データタイプ：文字列
    process_definition.name コード内の非アクティブ化されたプレイブックの名前。スクリプティングで要求パラメーターとしてのみ使用されます。

    データタイプ：文字列
    process_definition.scope プレイブックが非アクティブ化されるアプリケーションスコープのsys_id。

    データタイプ：文字列
    process_definition.status プレイブックが公開されると、ドラフトに戻ります。

    データタイプ：文字列
    状況 非アクティブ化が成功したかどうかを示します。
    可能な値：
    • 成功:プレイブックが正常に非アクティブ化されました。
    • エラー:プレイブックの ID が見つかりませんでした。

    データタイプ：文字列

    プレイブックを非アクティブ化します。

    sn_pad.PDAutomationProvider.deactivateProcess('cdd1b85e43000210d96e29c28ab8f275')

    出力：

    {"process_definition":{"scope":"global","name":"test","active":true,"description":"","label":"test","status":"draft"},"state":"SUCCESS"}

    PDAutomationProvider – duplicateProcess(String processDefinitionSysId, String label, String description, String scopeId, String triggerTypeId)

    プレイブックを複製します。

    表 : 9. パラメーター
    名前 タイプ 説明
    processDefinitionSysID 文字列 プレイブックのSys_id。

    テーブル:プロセス定義 [sys_pd_process_definition]
    ラベル 文字列 複製されたプレイブックの名前。
    説明 文字列 オプション。プレイブックの詳細を追加します。
    scopeId 文字列 プレイブックを実行するアプリケーションスコープのsys_id。スコープ対象の名前は、プロセス定義 [sys_pd_process_definition] テーブルからの形式 scope.name です。グローバルスコープのsys_idを入力すると、任意のアプリケーションスコープでプレイブックを実行できます。
    triggerTypeId 文字列 プレイブックの実行を開始するトリガーのsys_id。トリガータイプ [sys_pd_trigger_type] テーブルでトリガータイプを検索し、そのsys_idをコピーします。
    表 : 10. 戻り値
    財産 説明
    オブジェクト プロセス定義の重複の詳細を含むオブジェクト。
    {
  "errors": [Array]
  "processDefinitionSysId": "String",
  "state": "String"
}
    エラー エラーのリスト。成功した場合は空。

    データタイプ:文字列のアレイ

    考えられるエラーメッセージ:
    • scopeId:xyz のスコープが見つかりません
    • 次の ID のプロセス定義が見つかりません:xyz
    • triggerTypeId:xyz のトリガータイプが見つかりません
    processDefinitionSysID プロセス定義 [sys_pd_process_definition] テーブル内の新しいプレイブックのsys_id。

    データタイプ：文字列
    状況 プレイブックの複製が成功したかどうかを示します。
    可能な値：
    • 成功:プレイブックが正常に複製されました。
    • エラー:プレイブック、アプリケーションスコープ、またはトリガーの ID が見つかりませんでした。

    データタイプ：オブジェクト

    この例では、 sys_id f8ca6192ec210210f8772cbd595eab20 を使用してプレイブックを複製する方法を示します。新しいプレイブックは プレイブック 2.0 という名前で、アプリケーションスコープは [グローバル] で、レコードが作成されるとトリガーされます。レコード作成トリガータイプのsys_idは ab6951170f1200108c87f4f0ff767e4f です。

    sn_pad.PDAutomationProvider.duplicateProcess('f8ca6192ec210210f8772cbd595eab20', 'Playbook 2.0', '', 'global', 'ab6951170f1200108c87f4f0ff767e4f');

    出力：

    {"processDefinitionSysId":"6e4f0b8fece9c210f8772cbd595eabda","state":"SUCCESS"}