Robot developer guide

Dernière mise à jour 5 déc. 2024

Champs des paramètres

La propriété Settings du Robot JavaScript SDK vous permet de personnaliser et d'améliorer votre contrôle sur la configuration de l'extension du navigateur.

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

Attribut	Description
`portNumber`	Vous permet de configurer des ports personnalisés sur lesquels les services back-end s’exécutent. Le numéro de port par défaut est 2323. Veuillez noter que cela n’est disponible que pour les installations Enterprise.
`pollTimeInterval`	Vous permet de spécifier la durée en millisecondes durant laquelle le Robot JavaScript SDK suit une exécution de processus à partir d’une page Web. La valeur par défaut est de 250 millisecondes. Cette valeur détermine la fréquence d'interrogation à partir du navigateur Web
`disableTelemetry`	Vous permet de désactiver le drapeau de télémétrie. La valeur par défaut est `false`.
`appOrigin`	Vous permet de spécifier l’application qui utilise le SDK. La valeur par défaut est récupérée dans la classe `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';

Paramètres de module complémentaire

Pour modifier les paramètres du module complémentaire, vous devez modifier le fichier uipath.config dans le dossier %ProgramFiles%\UiPath\Studio.

Le fichier de configuration doit contenir les éléments suivants :

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

Attribut	Description
`ListenerPort`	Le `UiPath.RobotJS.ServiceHost.exe` commence un HttpListener sur le port configuré et contient les informations sur les autres auditeurs locaux de la session d'utilisateur active sur ce système. Veuillez noter que la valeur du port doit correspondre à celle configurée dans les paramètres SDK.
`TokenExpiryInDays`	Toute demande provenant d’un nouveau domaine doit obtenir le consentement de l’utilisateur pour permettre l’accès aux UiPath Robots à partir d’une application Web. Ces consentements sont valables pour le nombre de jours mentionnés dans ce paramètre.

Superposition par défaut

Il est possible de personnaliser l’écran de consentement affiché lorsqu’une demande est formulée à partir d’un nouveau domaine. Il y a actuellement deux écrans qui sont livrés avec le Robot JavaScript SDK :

Invitation au consentement

La superposition consent-prompt s'affiche lorsqu’une demande d’accès à l’UiPath Assistant est levée à partir d’un nouveau domaine.

Composants manquants

La superposition missing-components s'affiche lorsque le module complémentaire requis n’est pas présent sur la machine locale.

Les messages de superposition peuvent être configurés comme illustré ci-dessous.

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

Paramètres du SDK

La propriété Settings du Robot JavaScript SDK vous permet de personnaliser et d'améliorer votre contrôle sur la configuration de l'extension du navigateur.

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

Attribut	Description
`portNumber`	Vous permet de configurer des ports personnalisés sur lesquels les services back-end s’exécutent. Le numéro de port par défaut est 2323. Veuillez noter que cela n’est disponible que pour les installations Enterprise.
`pollTimeInterval`	Vous permet de spécifier la durée en millisecondes durant laquelle le Robot JavaScript SDK suit une exécution de processus à partir d’une page Web. La valeur par défaut est de 250 millisecondes. Cette valeur détermine la fréquence d'interrogation à partir du navigateur Web
`disableTelemetry`	Vous permet de désactiver le drapeau de télémétrie. La valeur par défaut est `false`.
`appOrigin`	Vous permet de spécifier l’application qui utilise le SDK. La valeur par défaut est récupérée dans la classe `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';