Custom Code#

This task allows custom code to be executed in the system, similar to what happens with DEE Actions, creating an abstraction layer of code that can be used to aggregate several commands that can be more complex to create through the regular workflow editor.

Inputs#

Outputs#

Settings#

On the General Tab, you have the usual settings and the following settings:

On the Inputs Tab, there are the following settings:

On the Outputs Tab, there are the following settings:

On the Code Tab, there is a editor with syntax highlighting and intelligent code completion that allows the user to edit the code that should be run in this Task. This is the main focus point of the Task and should be used with care since it permits access to the MES itself through API calls, as well as storing values in a database table and perform logging of important values.

Here is an example of a direct MES interaction, where this Task calls a business method that removes all filled positions from a Container by the use of the EmptyContainer method:

import { Framework } from 'framework';

export default class {
    /** Allows accessing external functions */
    public framework: Framework;
    constructor(framework: Framework) {
        this.framework = framework;
    }
    /*
        * Entry point of the class (IMPORTANT: don't change the signature of this method)
        * Should return an object containing the values for each output to emit
        * If necessary, use the parameter "outputs" to emit data while running the code.
    */
    public async main(inputs: any, outputs: any): Promise<any> {
        // Add code here
        this.framework.logger.warning(inputs.xx);
        const input = new this.framework.LBOS.Cmf.Navigo.BusinessOrchestration.ContainerManagement.InputObjects.EmptyContainerInput();
        input.Container = new this.framework.LBOS.Cmf.Navigo.BusinessObjects.Container();
        input.Container.Name = "Container001";
        input.IgnoreLastServiceId = true;
        const output = await this.framework.system.call(input);
        this.framework.logger.error(JSON.stringify(output));
        // emit output during execution: outputs.output1.emit("something");
        // return example: return { output1: inputs.input1, output2: "Hello World" };
    }
}

Behavior#

This task executes the (TypeScript) code created by the user in the Code section of the Task settings. This code is executed with the received inputs and emits all the outputs defined in the code. Although similar to what happens in the execution of DEE Actions in MES, in this particular situation the user can have full control over the inputs and outputs of the block, with added configuration options for both scalar and reference types.

A main class must be defined and the name MUST be the following:

export class CustomCode

Within the code, the execution layer MUST define the following properties:

public api: Api = null;
public customApi: CustomApi = null;

Afterwards, those properties can be used in a method that MUST have the following signature:

public async main(inputs: any, outputs: any): Promise<any>

Inside the main method the user can create code to access multiple namespaces. Here is a list of the available API namespaces and the methods and classes that can be used:

Datastore#

Driver#

Logger#

MessageBus#

System#

Utils#

Remarks#

This Task should be used with care since a user may unwittingly introduce extra complexity in a workflow where a more simple way to perform specific tasks can be achieved by using simpler, more straightforward Tasks. Due to possible breaking changes (method signature changes, parameter renaming, among others), this Task should be used sparingly and when no other form of automation workflow is possible.