サイト内のスクリプトは、自動化パネルのスクリプト実行アクションを使用して実行できます。これにより、ドキュメント、スプレッドシート、プレゼンテーションから手動でスクリプトを実行することができます。
「Customize Workiva」にはスクリプト機能が含まれています。スクリプティング機能を使用するには、ワークスペースで「Workivaのカスタマイズ/スクリプティング」が有効になっている必要があり、ユーザーには適切なスクリプティングロールとファイルへのアクセス権限が必要です。
要件
- ワークスペースで Workiva スクリプトを有効にする必要があります。Workivaスクリプトの詳細はこちら。
- スクリプトは、ホストされている同じワークスペースでのみ実行できます。詳細はこちら。
- 自動化を作成できるのはファイルオーナーだけです。
- スクリプトの作成には、スクリプト編集者 の役割が必要です。
自動化の作成
所有するファイルから自動化を作成する：
- ホーム から、ドキュメント、プレゼンテーション、スプレッドシートを開きます。
- 右側のサイドバーで、「Automations」の稲妻アイコンをクリックします。
- および またはをクリックし、「新しい自動化を作成」 を選択して、新しい自動化を追加してください。
-
自動化トリガー ドロップダウンメニューから、マニュアル実行 を選択する。
- （オプション）他のユーザーに、この自動化を手動で実行できる権限を付与するには、そのユーザーの名前を入力し、「」の「 」フィールドで「実行」を選択します。
-
アクションの詳細 で、スクリプトの実行 を選択する。
- スクリプトの URL の末尾にある ID「」を、「」のスクリプト ID フィールドに入力してください。
- （任意）スクリプトの入力データが含まれているスプレッドシートとセクションを選択してください。
- 作成をクリックして終了します。
自動化の実行と管理
新規自動化が「Automations」パネルに「Active」と表示されます。ファイルのオーナーとして、ドロップダウンメニューからいくつかのアクションを実行できます：
- 実行 ：自動化のスクリプトをマニュアルで実行する。
- 編集:トリガー条件など、自動化に関する詳細を更新する。
- Disable/Activate ：自動化が実行可能かどうかを選択する。
- アクティビティを表示：自動化のアクティビティ記録を開きます。
- 削除 ：ファイルから自動化を永久に削除する。
メモ: 複製実行を防ぐため、実行 オプションは、クリックしてから 20 秒間は無効になります。
スクリプトが受け取る情報
自動化が実行されると、スクリプトが読み取る情報を環境変数として送信する：
- DOCUMENT_ID: 自動化が実行されるドキュメントのID。
- INPUT_SHEET_ID: 自動化の入力パラメータを管理するために使 用されるスプレッドシートの WURL。
- INPUT_RESOURCE_ID: 前述のスプレッドシートにおけるセクションのWURL。
- INPUT_SPREADSHEET_ID ：前述のスプレッドシートのID。
- INPUT_SPREADSHEET_SHEET_ID: 前述のスプレッドシートにおけるセクションのID。
WURLは、スプレッドシートやセクションのIDやその他の情報を含む、Workiva独自のURLです。
パラメータからIDを取得するには、以下のスクリプトを使用する：
# Workiva Scripting へようこそ import requests import json import os DOCUMENT_ID = os.getenv('DOCUMENT_ID') SPREADSHEET_ID = os.getenv('INPUT_SPREADSHEET_ID') SHEET_ID = os.getenv('INPUT_SPREADSHEET_SHEET_ID')) print("RAWパラメータ:") print(os.environ) print("") print("実際のID:") print(DOCUMENT_ID) print(SPREADSHEET_ID) print(SHEET_ID)注 ：現在、この自動化機能では、クライアント ID やシークレットなどの Workiva パブリック API 認証情報をスクリプトに送信することはありません。これらの認証情報をスクリプトに直接コード化する必要があるかもしれない。
よくある質問
別のワークスペース、組織、またはリージョン（APAC、CA、EU、US）にホストされているスクリプトを実行することはできますか？
Workivaの自動化機能（ ）では、そのファイルと同じワークスペース内にあるスクリプトのみを実行できます。別のワークスペース、組織、またはリージョンでスクリプトを実行するには、のWorkiva Scriptingコネクタ（ ）またはのWorkiva Scripting API（ ）を使用してください。
Scripting API を使用する場合は、対象のスクリプトがホストされているワークスペースで API グラントを作成してください。この助成金では、script:execute が必須となります。また、統合機能によって実行ステータス、ログ、または出力が取得される場合は、script:read も必須となります。API グラントの作成または更新方法については、「Workiva API の設定」 を参照してください。
スクリプト実行時に実行時入力/パラメータを送信できますか？
現時点では、自動化機能では、スクリプトの実行時にスクリプトに送信される実行時入力を許可していません。
自動化からスクリプト実行に送信されるメタデータは何ですか？ ワークスペースIDは送信されていますか？
自動化からスクリプトが実行されると、以下のパラメータが送信されます：
- DOCUMENT_ID: 自動化が実行されるドキュメントのID。
- INPUT_SHEET_ID: 自動化の入力パラメータを管理するために使 用されるスプレッドシートの WURL。
- INPUT_RESOURCE_ID: 「input」スプレッドシート内のセクションのWURL。
- INPUT_SPREADSHEET_ID: 「入力」スプレッドシートのID。
- INPUT_SPREADSHEET_SHEET_ID: 「input」スプレッドシート内のセクションのID。
詳細については、Workivaのサポートページ（）および「オートメーションによるスクリプトの実行」（ ）をご覧ください。
スクリプトの実行から Workiva および Workiva 以外のシステムの認証情報にアクセスするにはどうすればよいですか？
スクリプトが自動化から実行される場合、唯一のオプションは、コード自体に認証情報をハードコードすることである。
同じスクリプトを2つ以上のファイルから同時に実行できますか？
はい、スクリプトは同じファイルからでも複数のファイルからでも同時に実行できます。