Paramètres du SDK

Les méthodes et propriétés suivantes peuvent être incluses dans votre application personnalisée ou votre page Web :

Paramètres du SDK

Init

La méthode init est facultative. Elle renvoie l'instance IRobotSDK, ce qui vous permet de la stocker comme une variable pour une utilisation ultérieure.

UiPathRobot.init()

Obtenir le processus

La méthode Get Process récupère et affiche la liste des processus disponibles. Si le robot est connecté à Orchestrator, il récupère les processus de l’environnement et le dossier dont le robot fait partie. S’il n’est pas connecté à Orchestrator, les processus locaux s'affichent.

const robot = UiPathRobot.init();
robot.getProcesses()
.then(result => {
  for(let i=0; i<result.length;i++){
    console.log(result[i].name);
  }
}, err => {
  console.log(err);
});

Démarrer la tâche (Start Job)

La méthode Start Job lance un processus par ses arguments d’identification et d’entrée, le cas échéant.

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

Sur

La méthode On est utilisée pour joindre les gestionnaires d’événements sur le SDK. Le SDK JavaScript UiPath est livré avec une superposition de consentement intégrée affichée chaque fois que votre application personnalisée ou votre page Web doit se connecter au robot. Cette superposition de consentement peut être remplacée par un gestionnaire personnalisé.

const robot = UiPathRobot.init();
robot.on('consent-prompt', (consentCode) => {console.log(consentCode)});
robot.on('mising-components', () => {console.log('Missing Components')});

Début du processus

La méthode Process Start est utilisée pour démarrer un processus en lui transmettant des arguments d’entrée, le cas dernier.

let arguments = {
  "input1" : 23,
  "input2" " 42,
  "operation" : "add"
};
const robot = UiPathRobot.init();
robot.getProcesses()
.then(process => {
  let process = processes.find(p => p.name.includes('Calculator'));
  process.start(arguments).then(result => {
    console.log(result.Sum);
  }, err => {
    console.log(err);
  })
}, err => {
  console.log(err);
});

Début du processus sur l’état

La méthode Process Start On Status est utilisée pour démarrer un processus et joindre le rappel d’état en passant le gestionnaire de rappel.

let arguments = {
  "input1" : 23,
  "input2" " 42,
  "operation" : "add"
};
let globalHandler = (status) => {console.log(status)};
const robot = UiPathRobot.init();
robot.getProcesses()
.then(processes => {
  let statusHandler = (status) => {console.log('Calculator Process Status -' + status)};
  let process = processes.find(p => p.name.includes('Calculator'));
  process.start(arguments)
  .onStatus(globalHandler)
  .onStatus(statusHandler)
  .then(result => {
    console.log(result.Sum);
  }, err => {
    console.log(err);
  })
}, err => {
  console.log(err);
});

Stop Process (Arrêter le processus)

La méthode Stop Process est utilisée pour arrêter un processus de robot en cours de démarrage ou d'exécution. Elle retourne une promesse qui sera résolue après l’annulation réussie du processus de robot en cours d’exécution.

try {
  const robot = UiPathRobot.init();
  const robotProcessId = 'MyRunningRobot';
  const processes = await robot.getProcesses();
  const myProcess = processes.find(function(process){return process.name.includes(robotProcessId)});
  await robot.stopProcess(myProcess);
  console.log(robotProcessId +' cancelled successfully');
} catch (e) {
  console.log(robotProcessId +' cancellation failed -'+ e);
}

Travail sur

La méthode Job On est utilisée pour joindre un gestionnaire d’événements pour récupérer les statuts de processus en cours.

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

Paramètres

La méthode Settings vous permet de modifier le numéro de port par défaut et le temps d’intervalle de sondage en millisecondes.

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

Définitions de modèles

Paramètres

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

RobotProcess

class RobotProcess {
    id: string;
    name: string;
    constructor(id: string, name: string);
    start: (inArguments?: any) => JobPromise;
}

IRobotSDK

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

JobResult

/**
 * Job result model containing all output arguments from the process.
 * Empty if there are no out arguments.
 */
class JobResult {
    [Key: string]: any;
}

Job

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