PDAutomationProvider - スコープ指定、グローバル

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む9読むのに数分

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

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

    この API でスクリプトを呼び出すには、次のうちの 1 つまたは両方に該当する必要があります。
    • 発信者が、オプションのアクティビティトリガーが作成されたのと同じスコープ内にいる必要がある。
    • 管理者権限がある。

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

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

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

    関連項目：

    PDAutomationProvider – addOptionalActivityRelativeToActivityContext(文字列 contextID, 文字列 activityId, 文字列 where, 文字列 relatedToId)

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

    プロセスが実行されると、アクティビティごとにアクティビティコンテキストが作成されます。このコンテキストは、アクティビティが実行を処理する方法も処理します。詳細については、「 Process Automation Designer のレーンとアクティビティ」を参照してください。

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

    エラーが発生した場合は、1 つ以上のエラーメッセージのリスト。それ以外の場合は、0 個以上の要素のアレイを示すメッセージ。
    アレイ エラーが発生した場合は、1 つ以上のエラーメッセージのリスト。それ以外の場合は、0 個以上の要素のアレイを示すメッセージ。
    考えられるエラーメッセージ：
    • 無効なオプションのアクティビティ ID - activityId パラメーターに指定された sys_id が無効です。
    • 無効な PD コンテキスト ID - contextID パラメーターで指定されたプロセスデザイナー (PD) の sys_id が無効です。
    • 無効なポジションタイプ - 指定されたポジションタイプは無効です。有効なタイプについては、where パラメーターの説明を参照してください。
    • 無効な Relative-to ID - relativeToId パラメーターに指定された sys_id が無効です。
    • オプションのアクティビティが見つかりません - activityId パラメーターに指定された 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(文字列 contextID, 文字列 activityId, 文字列 where, 文字列 relatedToId)

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

    プロセスが実行されると、レーンごとにレーンコンテキストが作成されます。このコンテキストは、レーンが実行を処理する方法も処理します。詳細については、「 Process Automation Designer のレーンとアクティビティ」を参照してください。

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