Application

Functions to manipulate an application

Methods

attach_file(file_variable, file_widget_id) → {array}

Attach a file or a list of files to an application.

Attach a file or a list of files to an application. This function only works when computed in 'Input variables' of a manual task.
Parameters:
Name Type Argument Description
file_variable string | array The variable of an uploaded file widget, containing one file identifier or a list of file identifiers
file_widget_id string <optional>
Identifier of the uploaded file widget to which the file(s) should be attached. Necessary if several uploaded file widgets are present in the application.
Returns:
Descriptors of the attached files.
Type
array

detach_file(file_variable, instance_id) → {array}

Detach a file or a list of files from an application.

Parameters:
Name Type Description
file_variable string | array One file identifier or a list of file identifiers in a JSONArray format or the variable of an uploaded file widget
instance_id string Application instance from which the file(s) shall be detached.
Returns:
Descriptors of the detached files.
Type
array

get_history() → {array}

Get the history of modifications of application instances.

Get the history of modifications of application instances during a process, just as the history widget would do it
Returns:
Array of historymetadata
Type
array

get_instance_info(instanceId) → {applimetadata}

Get the metadata describing an application instance

Parameters:
Name Type Description
instanceId string Identifier of the application instance
Returns:
Application instance description
Type
applimetadata

i18n(key, defaultValue) → {string}

Internationalization method. Get the translation of a key in a given language.

Parameters:
Name Type Description
key string -
defaultValue string Default value if key is not found in language
Returns:
Target translation or defaultValue if nothing found.
Type
string

list_attached_file(instance_id) → {array}

List the files attached to an application.

Parameters:
Name Type Description
instance_id string Application instance
Returns:
Descriptors of the attached files.
Type
array