コンテンツにスキップ
ドキュメント

アクション

アクションエディタ

アクションスクリプトの記述について、デスクトップやモバイルアプリのアクションと異なる点があります。 ここではバッチアプリケーションで利用できるオブジェクト・ビルトイン関数などの注意点について説明します。

オブジェクト

バッチアプリケーションのアクションスクリプト内で使用できるオブジェクトについて説明します。

オブジェクト説明
$paramバッチではパラメータに指定した内容を$paramオブジェクトとして参照できます。
$global$globalを参照してください。
$const$constを参照してください。
$fnビルトイン関数を呼び出すことができます。
使用できる関数については、下記の表を参照してください。
$env$envを参照してください。

ビルトイン関数

バッチアプリケーションのアクションスクリプト内で使用できるビルトイン関数について説明します。

ビルトイン関数説明
$fn.getFile(path)$fn.getFile(path)を参照してください。
$fn.getFileNames(path)$fn.getFileNames(path)を参照してください。
$fn.putFile(path, parameters)$fn.putFile(path, parameters)を参照してください。
$fn.deleteFile(path)$fn.deleteFile(path)を参照してください。
$fn.getUsers(groupName?,option)$fn.getUsers(groupName?,option)を参照してください。
$fn.createUser(param)$fn.createUser(param)を参照してください。
$fn.updateUser(param)$fn.updateUser(param)を参照してください。
$fn.deleteUser(email)$fn.deleteUser(email)を参照してください。
$fn.exit(exitCode)ジョブを指定した終了コードで終了します。
引数：終了コード (数値)
戻り値：なし

Tips
本ビルトイン関数はバッチスクリプト専用となっています。アクションでは使用できません。
$fn.resetPassword(param)$fn.resetPassword(param)を参照してください。
$fn.getGroups(option)$fn.getGroups(option)を参照してください。
$fn.createGroup(param)$fn.createGroup(param)を参照してください。
$fn.addUsers(param)$fn.addUsers(param)を参照してください。
$fn.removeUsers(param)$fn.removeUsers(param)を参照してください。
$fn.svf.oauth2.token()$fn.svf.oauth2.token()を参照してください。
$fn.svf.oauth2.revoke()$fn.svf.oauth2.revoke()を参照してください。
$fn.svf.artifacts.print()$fn.svf.artifacts.print()を参照してください。
$fn.svf.artifacts.info()$fn.svf.artifacts.info()を参照してください。
$fn.svf.artifacts.download()$fn.svf.artifacts.download()を参照してください。
$fn.svf.actions.status()$fn.svf.actions.status()を参照してください。
$fn.sendMail(param)$fn.sendMail(param)を参照してください。
$fn.csvToObject(csv)$fn.csvToObject(csv)を参照してください。
$fn.getPresignedUrl(path,options)$fn.getPresignedUrl(path,options)を参照してください。
$fn.listUsersByEmail(email,option)$fn.listUsersByEmail(email,option)を参照してください。
$fn.listUsersByName(name,option)$fn.listUsersByName(name,option)を参照してください。