---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# WFActivityHandler - グローバル

# WFActivityHandler - グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

WFActivityHandlerスクリプトインクルードは、すべてのワークフローアクティビティの基底クラスです。

すべてのワークフローアクティビティの基底クラスとして、このコードは常にアクティビティの一部として実行されます。

独自のワークフローアクティビティを開発する際は、このクラスから派生させる形でスクリプトオブジェクトを作成し、必要に応じてメソッドを上書きして必要な機能を実現します。意味のあるアクティビティ処理を実行するためには、クライアントコードでメソッド onExecute() を上書きする必要があります。

## WFActivityHandler - debug(文字列 msg, 文字列 args) {#ariaid-title2}

デバッグメッセージをログに記録します。
{#r_WFAH-debug_S_S__table_xdr_nf5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| msg | 文字列 | ログに送信するメッセージ。 |
| args | 文字列 | ログに送信する文字列 |
[表 : 1. パラメーター]

{#r_WFAH-debug_S_S__table_xdr_nf5_4t} {#r_WFAH-debug_S_S__table_ydr_nf5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 2. 返される内容]

{#r_WFAH-debug_S_S__table_ydr_nf5_4t}

## WFActivityHandler - debug(文字列 msg, アレイ args) {#ariaid-title3}

デバッグメッセージをログに記録します。
{#r_WFAH-debug_S_A__table_bv2_sh5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| msg | 文字列 | ログに送信するメッセージ。 |
| args | アレイ | ログに送信する値のアレイ |
[表 : 3. パラメーター]

{#r_WFAH-debug_S_A__table_bv2_sh5_4t} {#r_WFAH-debug_S_A__table_cv2_sh5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 4. 返される内容]

{#r_WFAH-debug_S_A__table_cv2_sh5_4t}

## WFActivityHandler - generate(文字列 activityId, 文字列 order, GlideDateTime startAtDspValue, ブーリアン noCreateFlag) {#ariaid-title4}

今後の作業のプレビューのため、アクティビティを実行する前に承認とタスクを生成します。
保留中ステータスのワークフローを開始する際にオブジェクトを生成できるようにします。関連情報については、「 [ワークフロー アクティビティの生成](https://www.servicenow.com/docs/access?context=r_Generate&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US)」を参照してください。
{#r_WFAH-generate_S_S_GDT_B__table_dv2_sh5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| activityId | 文字列 | この実行中アクティビティの sys_id。ワークフローアクティビティ \[wf_activity\] テーブルにあります。 |
| order | 文字列 | タスクまたは承認に関連付けられた順序番号。 |
| startAtDspValue | 文字列 | タスクまたは承認の、[GlideDateTime](https://servicenow-prod.fluidtopics.net/Dy1YseqYjRu0xSRsxt9hHQ#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。") 形式の開始時間。 |
| noCreateFlag | ブーリアン | 承認レコードの作成をスキップするかどうかを示すフラグ。 有効な値： * true：承認レコードを作成しない。 * false：承認レコードを作成する。 {#r_WFAH-generate_S_S_GDT_B__ul_cbr_ds4_f4b} デフォルト：true |
[表 : 5. パラメーター]

{#r_WFAH-generate_S_S_GDT_B__table_dv2_sh5_4t} {#r_WFAH-generate_S_S_GDT_B__table_ev2_sh5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | ワークフロースクラッチパッドに保存されている生成前のオブジェクト。例えば、オブジェクトが承認 ID のアレイであるとします。アクティビティが onExecute 関数を実行すると、次のいずれかの条件を判断するよう生成前のオブジェクトに要求できます。 * 承認がすでに保留中ステータスで作成されている。 * アクティビティが onExecute 関数を使用して承認を作成する必要がある。 {#r_WFAH-generate_S_S_GDT_B__ul_u13_mdp_f4b} |
[表 : 6. 返される内容]

{#r_WFAH-generate_S_S_GDT_B__table_ev2_sh5_4t}

## WFActivityHandler - info(文字列 msg, 文字列 args) {#ariaid-title5}

情報メッセージをログに記録します。
{#r_WFAH-info_S_S__table_pdr_nf5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| msg | 文字列 | ログに送信するメッセージ。 |
| args | 文字列 | ログに送信する文字列。 |
[表 : 7. パラメーター]

{#r_WFAH-info_S_S__table_pdr_nf5_4t} {#r_WFAH-info_S_S__table_qdr_nf5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 8. 返される内容]

{#r_WFAH-info_S_S__table_qdr_nf5_4t}

## WFActivityHandler - info(文字列 msg, アレイ args) {#ariaid-title6}

情報メッセージをログに記録します。
{#r_WFAH-info_S_A__table_rdr_nf5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| msg | 文字列 | ログに送信するメッセージ。 |
| args | アレイ | ログに送信する値のアレイ |
[表 : 9. パラメーター]

{#r_WFAH-info_S_A__table_rdr_nf5_4t} {#r_WFAH-info_S_A__table_qdr_nf5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 10. 返される内容]

{#r_WFAH-info_S_A__table_qdr_nf5_4t}

## WFActivityHandler - js(文字列 str) {#ariaid-title7}

スクリプト内のアクティビティ変数を評価します。
`${some script}` などの el 式を含む文字列または `javascript:` で始まる文字列を評価するために使用されます。使用例は、ほぼすべての既存のアクティビティに入っていますので参照してください。
{#r_WFAH-js_S__table_ndr_nf5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| str | 文字列 | el 式が埋め込まれている可能性がある文字列。 |
[表 : 11. パラメーター]

{#r_WFAH-js_S__table_ndr_nf5_4t} {#r_WFAH-js_S__table_odr_nf5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 評価済みの文字列。 |
[表 : 12. 返される内容]

{#r_WFAH-js_S__table_odr_nf5_4t}

## WFActivityHandler - onCancel( ) {#ariaid-title8}

cancel イベントのイベントハンドラー。
アクティビティスクリプトの基底クラスが、このアクティビティをキャンセルするように設定します。このアクティビティをキャンセルするために追加の処理が必要な場合は、派生クラス (アクティビティ) でこのメソッドを上書きできます。アクティビティ Manual Approvals は、このメソッドを上書きして、このアクティビティをキャンセルするための追加処理を実行する処理の例です。
{#r_WFAH-onCancel__table_pqd_1b5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 13. パラメーター]

{#r_WFAH-onCancel__table_pqd_1b5_4t} {#r_WFAH-onCancel__table_qqd_1b5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 14. 返される内容]

{#r_WFAH-onCancel__table_qqd_1b5_4t}

## WFActivityHandler - onExecute( ) {#ariaid-title9}

仮想的なメソッド。アクティビティに適した作業を実行するためには、アクティビティのサブクラスでこのメソッドを上書きする必要があります。
{#r_WFAH-onExecute__table_nqd_1b5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 15. パラメーター]

{#r_WFAH-onExecute__table_nqd_1b5_4t} {#r_WFAH-onExecute__table_oqd_1b5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 16. 返される内容]

{#r_WFAH-onExecute__table_oqd_1b5_4t}

## WFActivityHandler - runScript(文字列 script) {#ariaid-title10}

スクリプトタイプのアクティビティ変数に含まれるスクリプトをアクティビティで実行できるようにします。
このメソッドを使用するアクティビティの例としては、If、Wait for condition、および Approval - User があります。
{#r_WFAH-runScript_S__table_rqd_1b5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| スクリプト | 文字列 | 有効な Javascript を含む文字列。 |
[表 : 17. パラメーター]

{#r_WFAH-runScript_S__table_rqd_1b5_4t} {#r_WFAH-runScript_S__table_sqd_1b5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| 変数 | スクリプトがワークフロー変数 <var class="keyword varname">answer</var> を設定した場合、この値が返されます。そうでない場合は、スクリプトの実行結果が返されます。 |
[表 : 18. 返される内容]

{#r_WFAH-runScript_S__table_sqd_1b5_4t}

## WFActivityHandler - setActivityOutput( ) {#ariaid-title11}

アクティビティ出力プロパティを設定します。
「アクティビティ SOAP Message」を参照してください。
{#r_WFAH-setActivityOutput__table_lqd_1b5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 19. パラメーター]

{#r_WFAH-setActivityOutput__table_lqd_1b5_4t} {#r_WFAH-setActivityOutput__table_mqd_1b5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 20. 返される内容]

{#r_WFAH-setActivityOutput__table_mqd_1b5_4t}

## WFActivityHandler - setResultFailed(文字列 reason) {#ariaid-title12}

アクティビティの結果を失敗として設定し、オプションの reason 文字列を指定します。
「アクティビティ SOAP Message」を参照してください。
{#r_WFAH-setResultFailed_S__table_hqd_1b5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| reason | 文字列 | (オプション) このアクティビティが失敗した理由の説明。 |
[表 : 21. パラメーター]

{#r_WFAH-setResultFailed_S__table_hqd_1b5_4t} {#r_WFAH-setResultFailed_S__table_iqd_1b5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 22. 返される内容]

{#r_WFAH-setResultFailed_S__table_iqd_1b5_4t}

## WFActivityHandler - setResultSucceeded( ) {#ariaid-title13}

このアクティビティの結果を成功として設定します。
{#r_WFAH-setResultSucceeded__table_jqd_1b5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 23. パラメーター]

{#r_WFAH-setResultSucceeded__table_jqd_1b5_4t} {#r_WFAH-setResultSucceeded__table_kqd_1b5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 24. 返される内容]

{#r_WFAH-setResultSucceeded__table_kqd_1b5_4t}

## WFActivityHandler - warn(文字列 msg, 文字列 args) {#ariaid-title14}

警告メッセージをログに記録します。
{#r_WFAH-warn_S_S__table_tdr_nf5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| msg | 文字列 | ログに送信するメッセージ。 |
| args | 文字列 | ログに送信する文字列 |
[表 : 25. パラメーター]

{#r_WFAH-warn_S_S__table_tdr_nf5_4t} {#r_WFAH-warn_S_S__table_udr_nf5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 26. 返される内容]

{#r_WFAH-warn_S_S__table_udr_nf5_4t}

## WFActivityHandler - warn(文字列 msg, アレイ args) {#ariaid-title15}

警告メッセージをログに記録します。
{#r_WFAH-warn_S_A__table_vdr_nf5_4t__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| msg | 文字列 | ログに送信するメッセージ。 |
| args | アレイ | ログに送信する値のアレイ |
[表 : 27. パラメーター]

{#r_WFAH-warn_S_A__table_vdr_nf5_4t} {#r_WFAH-warn_S_A__table_udr_nf5_4t__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 28. 返される内容]

{#r_WFAH-warn_S_A__table_udr_nf5_4t}