Retrieve - Lock status (model(s)/object(s))

This service determines the lock status for models and objects.

In/Out

Name

Details

Data type

In

Database name

Name of the database in which the function of type Automated task is carried out.

<Text>

In

Database language

Language the service uses for logging in to the database, for example, en for English. You can specify this in more detail, for example, en for English or en_US for English (United States). This is helpful, for example, if English (Australia) has been set in the database, but standard English (USA) has not been set.

If you want to add the country, you need to create a language constant and model it as a language in the data flow.

<Text> or <Language>

In

User login

Login name of the user that is used for carrying out the Automated task function. If no user is defined, arisservice is used.

<Text>

In

Password

Password of the user that is used for carrying out the Automated task function.

<Password>

Selected items

Select the models or objects you want to check. The model check will return the status of the models, not the status of objects having occurrences in the models.

In

Identification

Either connect models, objects, or groups from the preselection of another object of type Human task, Automated task, or Event (process instance started), or enter GUIDs and use the Create collection operator.

<Text collection>

Out

Error

If automation errors occur, context-specific error messages are displayed indicating, for example, that ARIS server is not available.

<Text>

Out

Result

Returns either TRUE or FALSE (Boolean), depending on whether or not the service was successfully performed.

<Boolean>

Out

No item locked

Returns TRUE (Boolean) if no item is locked. Returns FALSE (Boolean) if at least one item is locked.

<Boolean>

Out

At least one item not locked

Returns TRUE (Boolean) if at least one item is not locked. Returns FALSE (Boolean) if all items are locked.

<Boolean>

Out

All items locked

Returns TRUE (Boolean) if all items are locked. Returns FALSE (Boolean) if at least one item is not locked.

<Boolean>

Out

No item open

Returns TRUE (Boolean) if no item is open. Returns FALSE (Boolean) if at least one item is locked.

<Boolean>

Out

At least one item open

Returns TRUE (Boolean) if at least one item is open. Returns FALSE (Boolean) if no item is locked.

<Boolean>

Out

All items open

Returns TRUE (Boolean) if all items are open. Returns FALSE (Boolean) if at least one item is not open.

<Boolean>

Out

Names of locked items

Returns the list of names of locked items.

<Text collection>

Out

GUIDs of locked items

Returns the list of GUIDs of locked items.

<Text collection>

Out

Item owner

The list of item owners having locked the items is output.

<Text collection>

Out

Names of open items

Returns the list of names of open items.

<Text collection>

Out

GUIDs of open items

Returns the list of GUIDs of open items.

<Text collection>

Out

Item owners of open items

Returns the list of item owners who opened the items.

<Text collection>

Out

Names of non-locked items

Returns the list of names of non-locked items.

<Text collection>

Out

GUIDs of non-locked items

Returns the list of GUIDs of non-locked items.

<Text collection>

Check whether models or objects are locked