設定フィールド

Robot JavaScript SDK ブラウザー アドオンの設定フィールド (ポート番号、ポーリング間隔、テレメトリ、アプリ オリジンの設定オプションなど)。

SDK の設定

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

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

属性	説明
portNumber	Lets you configure custom ports on which the back-end services run on. The default port number is 2323.
pollTimeInterval	Robot JavaScript SDK が Web ページからプロセスの実行を追跡する時間をミリ秒単位で指定できます。既定値は 250 ミリ秒です。この値によって、Web ブラウザーからのポーリングの頻度が決まります
disableTelemetry	テレメトリ フラグを無効化できます。既定値は falseです。
appOrigin	Identifies the application that uses the SDK in the SDK telemetry. The default value is picked up from the window.location.origin property.

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

アドオンの設定

Add-on settings are configured in the UiPath.config file: %ProgramFiles%\UiPathPlatform\Robot\<version>\UiPath.config for a per-machine installation, or %LocalAppData%\Programs\UiPathPlatform\Robot\<version>\UiPath.config for a per-user installation. For details, see Configuration files.

The robotJsSettings section of the configuration file can contain the following keys. By default, the section is empty and the add-on uses the default values, 2323 for ListenerPort and 30 for TokenExpiryInDays:

<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 instead 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') });