SDK-Spezifikationen

Die folgenden Methoden und Eigenschaften können in Ihrer benutzerdefinierten Anwendung oder Webseite enthalten sein:

SDK-Spezifikationen

Init

Die init-Methode ist optional. Sie gibt die IRobotSDK-Instanz zurück, mit der Sie sie als Variable für die spätere Verwendung speichern können.

UiPathRobot.init()

Prozess abrufen

Die Get Process-Methode ruft die Liste der verfügbaren Prozesse ab und zeigt sie an. Wenn der Roboter mit Orchestrator verbunden ist, ruft er die Prozesse aus der Umgebung und dem Ordner ab, der bzw. dem der Roboter angehört. Wenn er nicht mit Orchestrator verbunden ist, werden lokale Prozesse angezeigt.

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

Job starten (Start Job)

Die Start Job-Methode startet einen Prozess mit ihren ID- und Eingabeargumenten.

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

Auf

Die On-Methode wird verwendet, um Ereignishandler an das SDK anzufügen. Das UiPath JavaScript SDK wird mit einer integrierten Zustimmungseinblendung bereitgestellt, die jedes Mal angezeigt wird, wenn Ihre benutzerdefinierte Anwendung oder Webseite eine Verbindung mit dem Roboter herstellen muss. Diese Zustimmungseinblendung kann mit einem benutzerdefinierten Handler überschrieben werden.

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

Prozessstart

Die Process Start-Methode wird verwendet, um einen Prozess zu starten, indem sie Eingabeargumente an ihn übergibt, sofern verfügbar.

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

Prozessstart bei Status

Die Process Start On Status-Methode wird verwendet, um einen Prozess zu starten und den Statusrückruf anzufügen, indem der Rückrufhandler übergeben wird.

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

Prozess anhalten (Stop Process)

Die Stop Process-Methode wird verwendet, um einen laufenden oder ausgeführten Roboterprozess zu stoppen. Gibt eine Zusage zurück, die bei erfolgreichem Abbruch des laufenden Roboterprozesses aufgelöst wird.

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

Auftrag auf

Die Job On-Methode wird verwendet, um einen Ereignishandler anzufügen, um fortlaufende Prozessstatus abzurufen.

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

Einstellungen

Mit der Settings-Methode können Sie die Standardportnummer und Abrufintervallszeit in Millisekunden bearbeiten.

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

Modelldefinitionen

Einstellungen

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;
}

Auftrag

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