Custom actions

API

Examples

Redirecting to an edit view 

workflow ActionRunTest;

function main(s as selection) as navigation {
    var result as navigation;

    foreach k in ui->getKeys(s) {
        var runKey = test->run(k);

        result.openEditViewKey = runKey;
        result.openEditView = "wfTestRunEditor";
    }

    return result;
}

Showing a message 

workflow ActionRunTest;

function main(s as selection) as navigation {
    var result as navigation;
	result.message = "Hello world...";
    return result;
}

Downloading a file 

workflow ActionRunTest;

function main(s as selection) as navigation {
    var result as navigation;
	result.storageFileKey = 100;
	result.storageFileDownload = true; //Download
    return result;
}

Displaying a file 

workflow ActionRunTest;

function main(s as selection) as navigation {
    var result as navigation;
	result.storageFileKey = 100;
	result.storageFileDownload = false; //Just display, do not download
    return result;
}

Types

type navigation {     var openEditView as string;     var openEditViewKey as int;     var storageFileKey as int;     var storageFileDownload as boolean;     var message as string; }

Every entity can have many configured actions.

There are two options for configuring the entity actions.

Directly in the designer

Select the Actions tab and click the Add button.

If the entity action already exists, select it from the list in the field Action.

If the entity action doesn’t exist, click the navigate arrow next to the Action field.

Under the Entity action section, fill the following fields:

  • Name - the name of the action
  • Entity - select the entity for the action
  • Start workflow - select the workflow that will run for the action
  • Allow multiple - fill it if the action will run on multiple selection

If there are any inputs required for the action, under the Inputs section, click the Add button and fill the following fields:

  • Title - the title of the input that will be displayed on the interface
  • Argument name - the name of the argument that will be used on the workflow
  • Input type - the data type of the input
  • Is list - fill it if the input is a list
  • Catalog - select the catalog, if the type is “FixedList” or “DynamicList”
  • Default value - the input can have a default value (optional field)
  • Is optional - fill it if the input is an optional field
  • Rank - the order of the inputs on the interface

Save the new entity action, then save the edit view.

From the Develop app menu

Click the Develop app, and then click on the Entity action section.

Click the Add button located above the list and enter the following:

  • Name - the name of the action
  • Entity - select the entity for the action
  • Start workflow - select the workflow that will run for the action
  • Allow multiple - fill it if the action will run on multiple selection

If there are any inputs required for the action, under the Inputs section, click the Add button and fill the following fields:

  • Title - the title of the input that will be displayed on the interface
  • Argument name - the name of the argument that will be used on the workflow
  • Input type - the data type of the input
  • Is list - fill it if the input is a list
  • Catalog - select the catalog, if the type is “FixedList” or “DynamicList”
  • Default value - the input can have a default value (optional field)
  • Is optional - fill it if the input is an optional field
  • Rank - the order of the inputs on the interface

Save the new entity action.

For adding the entity action on the edit view:

  • open the edit view
  • click the Actions tab
  • click the Add button
  • select the action from the list in the field Action
  • save the Edit view
← Catalogs
Environment variables →