---
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


---

# ワークフロー - スコープ対象

# ワークフロー - スコープ対象 {#ariaid-title1}

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

スコープ付き ワークフロー API は、アクティビティ定義スクリプトで使用できるメソッドを提供します。

スコープ指定のワークフローオブジェクトのインスタンスを作成するためのコンストラクターはありません。代わりに、アクティビティスクリプトで利用可能なグローバルの workflow オブジェクトを使用します。このワークフローオブジェクトは、ワークフロー内の任意のスクリプトの場所で利用できます。

## スコープ指定の Workflow - debug(文字列 message, オブジェクト args) {#ariaid-title2}

デバッグメッセージをログに追加します。
{#r_SWF-debug_S_O__table_q3h_rqz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| message | 文字列 | ログに追加するメッセージ。 |
| args | オブジェクト | メッセージに追加する引数。 |
[表 : 1. パラメーター]

{#r_SWF-debug_S_O__table_q3h_rqz_lt} {#r_SWF-debug_S_O__table_r3h_rqz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ログに追加されたメッセージ。 |
[表 : 2. 返される内容]

{#r_SWF-debug_S_O__table_r3h_rqz_lt}  

    var loggedMessage = workflow.debug("All is well");

## スコープ指定の Workflow - error(文字列 message, オブジェクト args) {#ariaid-title3}

エラーメッセージをログに追加します。
{#r_SWF-error_S_O__table_ttc_2rz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| message | 文字列 | ログに追加するメッセージ。 |
| args | オブジェクト | メッセージに追加する引数。 |
[表 : 3. パラメーター]

{#r_SWF-error_S_O__table_ttc_2rz_lt} {#r_SWF-error_S_O__table_utc_2rz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ログに記録されたメッセージ |
[表 : 4. 返される内容]

{#r_SWF-error_S_O__table_utc_2rz_lt}  

    var loggedMessage = workflow.error("An error has occurred. ");

## スコープ指定の Workflow - getVariable(文字列 name) {#ariaid-title4}

指定された変数の値を返します。
{#r_SWF-getVariable_S__table_rsb_psz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | 変数名 |
[表 : 5. パラメーター]

{#r_SWF-getVariable_S__table_rsb_psz_lt} {#r_SWF-getVariable_S__table_ssb_psz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 変数の値 |
[表 : 6. 返される内容]

{#r_SWF-getVariable_S__table_ssb_psz_lt}  

    var value = workflow.getVariable("task");

## スコープ指定の Workflow - info(文字列 message, オブジェクト args) {#ariaid-title5}

情報メッセージをログに追加します。
{#r_SWF-info_S_O__table_rz5_1qz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| message | 文字列 | ログに追加するメッセージ。 |
| args | オブジェクト | メッセージに追加する引数。 |
[表 : 7. パラメーター]

{#r_SWF-info_S_O__table_rz5_1qz_lt} {#r_SWF-info_S_O__table_sz5_1qz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ログに記録されるメッセージ。 |
[表 : 8. 返される内容]

{#r_SWF-info_S_O__table_sz5_1qz_lt}  

    var loggedMessage = workflow.info("All is well");

## スコープ指定の Workflow - inputs {#ariaid-title6}

ワークフロー変数を含むオブジェクト。
これはメソッドではなく、ワークフローオブジェクト (ユーザーなど) の変数を参照する方法です。ワークフロー変数は、ワークフローのプロパティの中で、またはスクリプト化されたアクティビティによって定義されます。
{#SWF-inputs__table_ry3_4h1_qfb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| inputs | オブジェクト | 名前と値のペアとしてのワークフロー変数。ワークフローオブジェクトの変数は、インテグレーターの実装に合わせてカスタマイズされています。 |
[表 : 9. フィールド]

{#SWF-inputs__table_ry3_4h1_qfb}  

    var user = workflow.inputs.u_user;

## スコープ指定の Workflow - name() {#ariaid-title7}

ワークフロー名を返します。
{#r_SWF-name__table_wm2_spz_lt__entry__3}

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

{#r_SWF-name__table_wm2_spz_lt} {#r_SWF-name__table_xm2_spz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ワークフロー名 |
[表 : 11. 返される内容]

{#r_SWF-name__table_xm2_spz_lt}  

    var name = workflow.name();

## スコープ指定の Workflow - removeVariable(文字列 name) {#ariaid-title8}

指定された変数をワークフローから削除します。
{#r_SWF-removeVariable_S__table_d2r_ysz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | 変数名 |
[表 : 12. パラメーター]

{#r_SWF-removeVariable_S__table_d2r_ysz_lt} {#r_SWF-removeVariable_S__table_e2r_ysz_lt__entry__2}

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

{#r_SWF-removeVariable_S__table_e2r_ysz_lt}  

    var value = workflow.removeVariable("task");

## スコープ指定の Workflow - result {#ariaid-title9}

ワークフローの結果を含むワークフローオブジェクトの要素。
これはメソッドではなく、ワークフローの結果を含むワークフローオブジェクトの要素です。
{#SWF-result__table_grb_p31_qfb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| result | 文字列 | ワークフローの結果。 |
[表 : 14. フィールド]

{#SWF-result__table_grb_p31_qfb}  

    var wfResult = workflow.result;

## スコープ指定の Workflow - scratchpad() {#ariaid-title10}

ワークフローのスクラッチパッドオブジェクトを返します。
{#r_SWF-scratchpad__table_tfn_hpz_lt__entry__3}

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

{#r_SWF-scratchpad__table_tfn_hpz_lt} {#r_SWF-scratchpad__table_ufn_hpz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | スクラッチパッドオブジェクト。 |
[表 : 16. 返される内容]

{#r_SWF-scratchpad__table_ufn_hpz_lt}  

    var scratchpad = workflow.scratchpad();

## スコープ指定の Workflow - setResult(文字列 result) {#ariaid-title11}

ワークフローの結果を設定します。
{#r_SWF-setResult_S__table_zvp_stz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| result | 文字列 | ワークフローの結果 |
[表 : 17. パラメーター]

{#r_SWF-setResult_S__table_zvp_stz_lt} {#r_SWF-setResult_S__table_awp_stz_lt__entry__2}

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

{#r_SWF-setResult_S__table_awp_stz_lt}  

    workflow.setResult("Success");

## スコープ指定の Workflow - setVariable(文字列 name, オブジェクト value) {#ariaid-title12}

指定の変数を指定の値に設定します。
{#r_SWF-setVariable_S_O__table_spj_2sz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | 変数名 |
| value | オブジェクト | 変数に割り当てられる値。 |
[表 : 19. パラメーター]

{#r_SWF-setVariable_S_O__table_spj_2sz_lt} {#r_SWF-setVariable_S_O__table_tpj_2sz_lt__entry__2}

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

{#r_SWF-setVariable_S_O__table_tpj_2sz_lt}  

    workflow.setVariable("task", "terrible");

## スコープ指定の Workflow - warn(文字列 message, オブジェクト args) {#ariaid-title13}

警告メッセージをログに追加します。
{#r_SWF-warn_S_O__table_gxm_qrz_lt__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| message | 文字列 | ログに追加するメッセージ。 |
| args | オブジェクト | メッセージに追加する引数。 |
[表 : 21. パラメーター]

{#r_SWF-warn_S_O__table_gxm_qrz_lt} {#r_SWF-warn_S_O__table_hxm_qrz_lt__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ログに記録されたメッセージ |
[表 : 22. 返される内容]

{#r_SWF-warn_S_O__table_hxm_qrz_lt}  

    var loggedMessage = workflow.warn("Check your permissions.");