SDK の仕様

Robot JavaScript SDK methods, properties, and events reference, including init, getProcesses, startJob, stopJob, and the Settings and Process objects.

メソッドとプロパティ

以下のメソッドとプロパティは、カスタム アプリケーションまたは Web ページに含めることができます。

Init

init メソッドは任意です。IRobotSDK インスタンスを返します。後で使用するために変数として格納できます。

const robot = UiPathRobot.init();

設定

Settings 型の settings プロパティを使用すると、既定のポート番号とミリ秒単位のポーリング間隔を変更したり、テレメトリ データの送信を無効化したりできます。

const robot = UiPathRobot.init();
robot.settings.portNumber = 1234;
robot.settings.pollTimeInterval = 1000;
robot.settings.disableTelemetry = true;

On

on メソッドは、SDK にイベント ハンドラーをアタッチするために使用されます。

利用可能な SDK イベントは consent-prompt、missing-components、および open-uipath-protocol です。

consent-prompt

UIPath JavaScript SDK には、カスタム アプリケーションまたは Web ページがロボットに接続する必要があるたびに表示される同意オーバーレイが組み込まれています。

この同意オーバーレイはカスタム ハンドラーで上書きできます。

const robot = UiPathRobot.init();
robot.on('consent-prompt', consentCode => console.log(consentCode));

missing-components

missing-components イベントは、Robot JS サービスが実行されていない場合に生成されます。この場合、SDK によってエラーが表示されます。これはカスタム ハンドラーで上書きできます。

const robot = UiPathRobot.init();
robot.on('missing-components', () => console.log('Missing Components'));

open-uipath-protocol

同意プロンプトが表示される前に、ブラウザーが uipath-web の URL を関連付けられたアプリケーションで開くことを許可するよう求められる場合があります。

既定では、RobotJS は自動的にこの URL を開こうとしますが、ユーザーはカスタム イベント ハンドラーを提供することでこの動作を上書きできます。

const robot = UiPathRobot.init();
robot.on('open-uipath-protocol', (protocolUrl) => console.log('RobotJS protocol URL: ' + protocolUrl));

プロセスを取得

getProcesses メソッドは利用可能なプロセスのリストを取得します。RobotProcess オブジェクトの配列にプロミスを返します。ロボットが Orchestrator に接続されている場合は、そのロボットが属するロボット グループとフォルダーからプロセスを取得します。接続されていない場合は、ローカルにあるプロセスが取得されます。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
for(let i=0; i<processes.length; i++){
    console.log(processes[i].name + " (" + processes[i].description + ") - Id=" + processes[i].id);
}

入力引数の取得スキーマ

インストール済みのプロセスの inputArgumentsSchema プロパティを使用することで、プロセスの入力引数を取得できるようになりました。inputArgumentsSchema プロパティを使用する前に、プロセスをインストールする必要があります。

installProcess メソッドは、プロセスをインストールし、InputArgumentSchema オブジェクトの配列を含む InstallProcessResult 型のオブジェクトにプロミスを返します。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
const installedProcess = await robot.installProcess(processes[0].id);
for(let i=0; i<installedProcess.inputArgumentsSchema.length; i++){
    console.log("Argument " + i + ":");
    console.log("  name: " + installedProcess.inputArgumentsSchema[i].name)
    console.log("  type: " + installedProcess.inputArgumentsSchema[i].type)
    console.log("  isRequired: " + installedProcess.inputArgumentsSchema[i].isRequired)
    console.log("  hasDefault: " + installedProcess.inputArgumentsSchema[i].hasDefault)
}

注:

TypeScript では、RobotProcess オブジェクトのメソッド install を使用してプロセスをインストールできます。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
const myProcess = processes.find(p => p.name === "MyProcess");
const installedProcess = await myProcess.install();

ジョブを開始

startJob メソッドは、既に作成済みの Job を受け取り、開始します。出力引数を含む JobResult 型のオブジェクトにプロミスを返します。

createJob メソッドは、プロセス ID を使用してロボットのジョブを作成します。任意でジョブの入力引数を受け取ることができます。Job オブジェクトを返します。

注:

これまでは、プロセス リストの更新はプロセスの開始前に行われていましたが、v2022.10 からはプロセスの実行と並行して行われるようになりました。つまり、利用可能な更新があるプロセスを実行すると、古いバージョンのプロセスでジョブが実行される可能性があります。

robot = UiPathRobot.init();
processes = await robot.getProcesses();
const calculatorProcess = processes.find(p => p.name.includes('Calculator'));
const arguments = {
    "input1" : 23,
    "input2" : 42,
    "operation" : "add"
};
const job = robot.createJob(calculatorProcess.id, arguments);
const result = await robot.startJob(job);
console.log(result.Sum);

注:

TypeScript では、Job クラス コンストラクターを使用してジョブを作成できます。

robot = UiPathRobot.init();
processes = await robot.getProcesses();
const calculatorProcess = processes.find(p => p.name.includes('Calculator'));
const arguments = {
    "input1" : 23,
    "input2" : 42,
    "operation" : "add"
};
const job = new Job(calculatorProcess.id, arguments);
const result = await robot.startJob(job);
console.log(result.Sum);

Job On

Job オブジェクトの on メソッドは、ジョブにイベント ハンドラーをアタッチするために使用されます。利用可能なイベントは status と workflow-event です。

ステータス

status イベントは、ジョブの実行中に、ジョブのステータスが変更されるたびに生成されます。

また、[ステータスを報告] アクティビティが実行されるたびに生成されます。

const robot = UiPathRobot.init();
const job = robot.createJob('processId');
job.on('status', robotStatus => console.log(robotStatus));
await robot.startJob(job);

workflow-event

workflow-event イベントは、ジョブの実行中に、ワークフロー イベントを送信するアクティビティが実行されるたびに生成されます。[中間結果を送信] アクティビティを使用した部分的な結果の実装をサポートします。このイベント ハンドラーには、WorkflowEventData 型の引数があります。

const robot = UiPathRobot.init();
const job = robot.createJob('processId');
job.on('workflow-event', e => console.log(e.name));
await robot.startJob(job);

プロセスを開始

オブジェクト RobotProcess のstart メソッドは、プロセスに入力引数 (あれば) を渡して開始するために使用されます。

JobPromise 型のオブジェクトを返します。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
const myProcess = processes.find(p => p.name === "MyProcess");
const arguments = {
    "a" : 41,
    "b" " 27
};
const result = await myProcess.start(arguments);

Process On Status

onStatus メソッドは、ジョブの「status」イベントにイベント ハンドラーをアタッチするために使用されます。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
const myProcess = processes.find(p => p.name === "MyProcess");
const result = await myProcess.start().onStatus(status => console.log(status));

Process On Workflow Event

onWorkflowEvent メソッドは、ジョブの「workflow-event」イベントにイベント ハンドラーをアタッチするために使用されます。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
const myProcess = processes.find(p => p.name === "MyProcess");
const result = await myProcess.start().onWorkflowEvent(e => console.log(e.name));

Stop Process

stopProcess メソッドは、ロボット プロセスの実行を停止するために使用されます。

実行中のロボット プロセスが正常にキャンセルされると解決されるプロミスを返します。

const robot = UiPathRobot.init();
const processes = await robot.getProcesses();
const myProcess = processes.find(p => p.name === "MyProcess");
const result = await myProcess.start();
await robot.stopProcess(myProcess);

モデルの定義

IRobotSDK

interface IRobotSDK {
    settings: Settings;
    getProcesses(): Promise<Array<RobotProcess>>;
    init(): IRobotSDK;
    on(eventName: string, callback: (argument?: any) => void): void;
    startJob(job: Job): Promise<JobResult>;
    stopProcess(process: RobotProcess): Promise<void>;
    installProcess(processId: string): Promise<InstallProcessResult>;
}

設定

class Settings {
    portNumber: number;
    pollTimeInterval: number;
    disableTelemetry: boolean;
}

RobotProcess

class RobotProcess {
    id: string;
    name: string;
    description?: string;
    start: (inArguments?: any) => JobPromise;
    install: () => Promise<InstallProcessResult>;
}

InstallProcessResult

class InstallProcessResult {
    inputArgumentsSchema: InputArgumentSchema[]
}

InputArgumentSchema

class InputArgumentSchema {
    name: string;
    type: string;
    isRequired: boolean;
    hasDefault: boolean;
}

JobPromise

class JobPromise {
    onStatus(eventHanlder: (argument?: any) => void): JobPromise;
    onWorkflowEvent(eventHanlder: (argument?: any) => void): JobPromise;
}

Job

class Job {
    processId: string;
    argument?: any;
    jobId: string;
    on(eventName: string, eventHanlder: (argument?: any) => void): void;
}

JobResult

class JobResult {
    [Key: string]: any;
}

WorkflowEventData

class WorkflowEventData {
    name: string;
    payload: string;
}