Script Tasks API

The platform provides the ability to create logic for script tasks (handlers) from within 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 Library module select the Script tasks:

Illustration 1. Script tasks tab window

A detailed description of creating scripts 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; // Complete the task and pass to the process the variables specified in the parameter and optionally changes in the data model
   handleFailure(cause: string): void;                        // Report an incident on the task (e.g. system error) with the reason specified in the parameter (the process pauses until intervention)    
   handleBpmnError(errorCode: string, cause?: string): void;  // Report a defined business error on the task with the error code and reason specified in the parameter (the BPMN error handling path is executed)
    
   // Deprecated
   getModel(String processInstanceId, List<String> fieldsNames): Map<String, String> // Call the data model by providing the process instance id and the list of keys whose values we want to retrieve.
                                                                                     // Deprecated 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 in the case list

Operations and access to process data

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("Finishing script task")
    context.complete({'result': testVariablePower});
 }

Calling REST services in a script task

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

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

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

Example of a script task that calls an external REST service:

function handle(task, context) {
    // Retrieve the process variable with key "testVariable"
    const value = task.getVariable('testVariable');
     
    // Retrieve the process variable with key "result"
    const result = task.getVariable('result');
 
    if (value == null || isNaN(value)) {
        // Report an error on the task with the 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 occured: {}", e.message);
        context.handleFailure("Failed to retrieve questionnaire list " + e.message);
    }      
}

Retrieving business application configuration

Call documentation: Scripts (scriptService)#Retrievingapplicationconfiguration

Example of a script task that retrieves configuration:

function handle(task, context) {
    // Retrieve variables from configuration
    const skipTask = api.config.v1.get("script.task.skip.task")
    const titleName = api.config.v1.getOrDefault("script.task.title.name", "Default title")
     
    // Complete 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 properly you must fill in the EXIMEE_STATUS_URL parameter pointing to the eximee-status API.

Methods that call eximee-status require the process variable statusId, which should contain the application number for which the indicated update is to 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 calling eximee-status:

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 occured: {}", e.message);
        context.handleFailure("Failed to retrieve questionnaire list " + e.message);
    }      
}

Retrieving Content contents

Functionality available from platform version: 3.332.0

From a script task you can retrieve the content of an artifact Content (textContent) created in Eximee Designerusing the function: api.repository.v1.textContent. This function returns an object that has contents for each defined translation. To get the content for a given translation we use the languagefunction. Example usage:

const artifactName = "footer";
const artifactVersion = "*";
const language = "pl";
  
const contentArtifact = api.repository.v1.textContent(artifactName, artifactVersion);
const footerPl = contentArtifact.language(language).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 artifactName = "footer";
const artifactVersion = "*";
const language = "pl";
  
let contentArtifact;
try {
    contentArtifact = api.repository.v1.textContent(artifactName, artifactVersion);
} catch (error) {
    context.handleFailure("No artifact found with name: " + artifactName + " and version: " + artifactVersion);
    return;
}
  
let footerPl;  
try {
    footerPl = contentArtifact.language(language).text(); 
} catch (error) {
    context.handleFailure("No translation found in the artifact for language: " + language);
    return;
}
 
context.complete({'output': footerPl});

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 it 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 = { "Settlement.Branch.Address": branchId, "Settlement.IsContractContentChangeRequired": isDocumentChangedRequired }
 
    if (isDocumentChangedRequired == "true") {
        modelUpdate['Settlement.Notes'] = documentsNotes
    }
    context.complete({}, modelUpdate);
}