Script tasks API

The platform provides the ability to create handler script task logic from Eximee Designer. The process designer only needs to write the handler logic and attach it in the process.

Creating a script task

We can create and edit script tasks using the Eximee Designer application. To do this, in the module Library select the tab Script tasks:

Figure 1. Script tasks tab window

A detailed description of script creation is available in: Script tasks.

Handler API

interface Task {
   getVariable(name): string;                                 // Retrieve the process variable with the identifier specified in the parameter
   getAllVariables(): {[key: string]: string};                // Retrieve all variables in the process
   getProcessIntanceId(): string;                             // Returns the process instance identifier
}
 
interface Context {
   complete(variables: [key: string]: string, modelChanges?: [key: string]: string): void; // Finish the task and pass the variables specified in the parameter, and optionally changes in the data model, to the process
   handleFailure(cause: string): void;                        // Report an incident on the task (e.g. system error) together with the reason specified in the parameter (the process stops until intervention)    
   handleBpmnError(errorCode: string, cause?: string): void;  // Report a planned business error on the task together with the error code and the reason specified in the parameter (the BPMN error handling path is triggered)
    
   // Deprecated
   getModel(String processInstanceId, List<String> fieldsNames): Map<String, String> // Call the data model by providing the process instance id and a list of keys whose values we want to retrieve.
                                                                                     // Obsolete method. Use api.model
}
 
interface Logger {
    info(message: string, ...args: any);                      // Logging at INFO level                
    debug(message: string, ...args: any);                     // Logging at DEBUG level
    warn(message: string, ...args: any);                      // Logging at WARN level
    error(message: string, ...args: any);                     // Logging at ERROR level
    trace(message: string, ...args: any);                     // Logging at TRACE level
}
 
function nonsensitive(arg: any): String;
 
function handle(task: Task, context: Context): void {}

Setting the list of groups that will have access to the process instance on the case list

Process data operations and access

Example script tasks

The script retrieves the variable with the identifier “testVariable”, multiplies it by itself, and assigns the result to a new variable “result”:

function handle(task, context) {
    Logger.info("Starting script task sensitiveName={}, nonSensitiveName={}", 'SECRET_DATA', nonsensitive('NON_SECRET_DATA'))
 
    const testVariableNumber = task.getVariable('testVariable');
    const testVariablePower = testVariableNumber * testVariableNumber;
     
    Logger.info("Ending script task")
    context.complete({'result': testVariablePower});
 }

Calling REST services in a script task

Invocation documentation: [Rest] Calling external REST services (ScriptCode)

The only change compared to the above documentation is the configuration file.

The one for ScriptCode Handler is called script-handler-api.xml and is located in the directory /etc/eximee/webforms/script-handler-config

Example script task with a call to an external REST service:

function handle(task, context) {
    // Retrieve the process variable with key "testVariable"
    let value = task.getVariable('testVariable');
     
    // Retrieve the process variable with key "result"
    let result = task.getVariable('result');
 
    if (value == null || isNaN(value)) {
        // Report an error on the task with error code "errorCode"
         context.handleBpmnError("errorCode", "No value for the process variable with key testVariable");
    }
 
    value = value * 5
    result = result * 5
    Logger.info("Passed: [value={}, result={}]", value, result);
          
    try {
        let response = api.rest.v1.get("questionnaire", {}, {});
 
        Logger.info("Task ended successfully");
        context.complete({'variable1': value, 'variable2': result, 'Questionnaires': response.body});
    }
    catch(e) {
        Logger.warn("Exception occurred: {}", e.message);
        context.handleFailure("Failed to retrieve questionnaire list " + e.message);
    }      
}

Retrieving business application configuration

Invocation documentation: Scripts (scriptService)#Retrieving application configuration

Example script task with configuration retrieval:

function handle(task, context) {
    // Retrieve variables from the configuration
    const skipTask = api.config.v1.get("script.task.skip.task")
    const titleName = api.config.v1.getOrDefault("script.task.title.name", "Default title")
     
    // Finish the task and pass variables (skipTask, titleName) to the process
    context.complete({'skipTask': skipTask, 'titleName': titleName});
}

Calling Eximee Status in the ScriptCode Handler

For the call to work correctly, fill in the EXIMEE_STATUS_URL parameter pointing to the eximee-status API.

The methods calling eximee-status require the process variable statusId, which should contain the application number for which the specified update should occur.

Status API

interface EximeeStatusClient {
   updateStatus(statusName: string, statusDescription: string): void;   // Update the status name and description
   updateMetadata(metadata: string): void;                               // Update the application metadata
   getMetadata(): Object;                                               // Retrieve the application metadata
   getClientFormsBasicInfo(): Object;                                   // Retrieve the list of application statuses for the logged-in client (Method available from version 4.154.0. The client must be logged in for the functionality to work.)
 }

Example ScriptCodeHandler with eximee-status call:

function handle(task, context) {
    try {
        api.status.v1.updateStatus("NEW_STATUS", "STATUS_DESC");
 
        Logger.info("Task ended successfully");
        context.complete({});
    }
    catch(e) {
        Logger.warn("Exception occurred: {}", e.message);
        context.handleFailure("Failed to retrieve questionnaire list " + e.message);
    }      
}

Retrieving Content

Functionality available since platform version: 3.332.0

From a script task, you can retrieve the content of the artifact Content (TextContent) created in Eximee Designer, using the function: api.repository.v1.textContent. This function returns an object that contains content for each of the defined translations. To retrieve the content for a given translation, we use the function language. Example usage:

const nazwaArtefaktu = "footer";
const wersjaArtefakut = "*";
const język = "pl";
  
const artefaktTresci = api.repository.v1.textContent(nazwaArtefaktu, wersjaArtefakut);
const stopkaPl = artefaktTresci.language(jezyk).text();

1. The function textContent throws an exception if it does not find an artifact with the given parameters.
2. The function language throws an exception if it does not find a translation in the given language.

If we are not sure that the parameters we provided are correct, we can handle exceptions using try catch:

const nazwaArtefaktu = "footer";
const wersjaArtefaktu = "*";
const jezyk = "pl";
  
let artefaktTresci;
try {
    artefaktTresci = api.repository.v1.textContent(nazwaArtefaktu, wersjaArtefaktu);
} catch (error) {
    context.handleFailure("No artifact with name: " + nazwaArtefaktu + " and version: " + wersjaArtefaktu);
    return;
}
  
let stopkaPl;  
try {
    stopkaPl = artefaktTresci.language(jezyk).text(); 
} catch (error) {
    context.handleFailure("No translation found in the artifact for language: " + jezyk);
    return;
}
 
context.complete({'output': stopkaPl});

Data model

More information in Data model API

Saving data in the data model

In script tasks, we can save data to the model using the 'complete' method; the first parameter saves data to the process, and the second parameter saves data to the model:

The model key must exist in the data model for the data to be saved correctly.

function handle(task, context) {
    const branchId = task.getVariable('branchId');
    const isDocumentChangedRequired = task.getVariable('isDocumentChangedRequired');
    const documentsNotes = task.getVariable('documentsNotes');
 
    let modelUpdate = { "Ugoda.Adres.Oddzial": branchId, "Ugoda.CzyWymaganaZmianaTresciUmowy": isDocumentChangedRequired }
 
    if (isDocumentChangedRequired == "true") {
        modelUpdate['Ugoda.Uwagi'] = documentsNotes
    }
    context.complete({}, modelUpdate);
}