開発者ガイド

最終更新日時 2024年10月25日

設定フィールド

Robot JavaScript SDK の [設定] プロパティを使用すると、ブラウザーアドオンの設定をカスタマイズし、制御を向上させることができます。

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

属性	説明
`portNumber`	バックエンドサービスを実行するカスタムポートを構成できます。既定のポート番号は 2323 です。これは、Enterprise Edition のインストールでのみ利用可能です。
`pollTimeInterval`	Robot JavaScript SDK が Web ページからのプロセスの実行を追跡する時間をミリ秒単位で指定できます。既定値は、250 ミリ秒です。この値は、Web ブラウザーからのポーリング間隔を決定します。
`disableTelemetry`	テレメトリフラグを無効化できます。既定値は `false` です。
`appOrigin`	SDK を使用するアプリケーションを指定できます。既定値は、`window.location.origin` クラスから取得されます。

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

アドオンの設定

アドオンの設定を変更するには、%ProgramFiles%\UiPath\Studio フォルダーの uipath.config ファイルを変更する必要があります。

構成ファイルには、以下が含まれている必要があります。

<robotJsSettings>
    <add key="ListenerPort" value="2323" />
    <add key="TokenExpiryInDays" value="30" />
</robotJsSettings><robotJsSettings>
    <add key="ListenerPort" value="2323" />
    <add key="TokenExpiryInDays" value="30" />
</robotJsSettings>

属性	説明
`ListenerPort`	`UiPath.RobotJS.ServiceHost.exe` は設定されたポートで HttpListener を開始します。そのシステム上でアクティブなユーザーセッションからの他のローカルリスナーに関する情報を含みます。ここでのポート値は、SDK の設定で設定した値と一致する必要がある点にご注意ください。
`TokenExpiryInDays`	新しいドメインからの要求には、Web アプリケーションから UiPath Robots のアクセスを許可するためのユーザーの同意が必要です。この同意は、この設定で指定されている日数の間有効です。

既定のオーバーレイ

新しいドメインから要求が発生したときに表示される同意画面をカスタマイズできます。現在、Robot JavaScript SDK には以下の 2 つの画面が含まれます。

同意プロンプト

consent-prompt オーバーレイは、新しいドメインから UiPath Assistant へのアクセス要求が発生した場合に表示されます。

コンポーネントの不足

missing-components オーバーレイは、必要なアドオンがローカルマシンに存在しない場合に表示されます。

オーバーレイメッセージは以下に示すように設定できます。

// Consent code will be written to the console instead of showing default overlay
// Error logged to console when required components are missing insread of showing
// default error overlay
const robot = UiPathRobot.init();
robot.on('consent-prompt', function(consentCode){ console.log(consentCode) });
robot.on('missing-components', function(){ console.log('Missing components') });// Consent code will be written to the console instead of showing default overlay
// Error logged to console when required components are missing insread of showing
// default error overlay
const robot = UiPathRobot.init();
robot.on('consent-prompt', function(consentCode){ console.log(consentCode) });
robot.on('missing-components', function(){ console.log('Missing components') });

SDK の設定

Robot JavaScript SDK の [設定] プロパティを使用すると、ブラウザーアドオンの設定をカスタマイズし、制御を向上させることができます。

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

属性	説明
`portNumber`	バックエンドサービスを実行するカスタムポートを構成できます。既定のポート番号は 2323 です。これは、Enterprise Edition のインストールでのみ利用可能です。
`pollTimeInterval`	Robot JavaScript SDK が Web ページからのプロセスの実行を追跡する時間をミリ秒単位で指定できます。既定値は、250 ミリ秒です。この値は、Web ブラウザーからのポーリング間隔を決定します。
`disableTelemetry`	テレメトリフラグを無効化できます。既定値は `false` です。
`appOrigin`	SDK を使用するアプリケーションを指定できます。既定値は、`window.location.origin` クラスから取得されます。

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