Flowster Activities

Activities

Open

Connect To Flowster RestApi

This activity creates a new connection to the Flowster RestApi.

Activity Parameters

The Connect To Flowster RestApi activity parameters can be provided by manual inserted values or via IN arguments or variables:

Open

Parameters:

• Password (text box editor type) (type: string): enter the user password

• Pasword Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for connection. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal)

• Rest API Adress (text box editor type) (type: string): enter the Rest API Adress. It can be copied from the Flowster Administrator by selecting the ClientApp for the RestAPI

• Tenant Name (combo box editor type) (type: string): enter the Tenant Name for the RestAPI user

• Username (text box editor type) (type: string): enter the username with domain (example: “domain\\user“)

The Read Only Output variable are the possible output values that the activity will provide:

• Connection (text box editor type) (type: object): outputs the Flowster connection. The output from this activity should be used as input in all activities placed under the 'Flowster Activities/v5' category

Disconnect From Flowster RestAPI

This activity disconnects the specified Flowster RestAPI connection.

Activity Parameters

The Disconnect From Flowster RestAPI activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect To Flowster RestAPI activity should be used as Input for this parameter.

Approve Flowster Workflow

This activity allows you to respond to an approval request created with the Approval with Values activity.

Activity Parameters

The Approve Flowster Workflow activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Approval (text box editor type) (type: string): Enter the workflow guid of the workflow to be approved. You can retrieve this via the instanceID activity in the approval workflow.

• Approval User (text box editor type) (type: string): Authorizer specified as domain\samaccountname. Currently only AD Users are supported! The GroupChildId of the user must be specified for all other users. You can determine this from the GroubChild table in the database.

• Comment (text box editor type) (type: string): Optional comment if the request is rejected.

• Workflow GUID (text box editor type) (type: string): Enter the workflow guid of the workflow to be approved. You can retrieve this via the instanceID activity in the approval workflow.

The Read Only Output variable are the possible output values that the activity will provide:

• Successfully (type: boolean): Returns true, if the action was successfully executed

Edit Workflow Status

This activity activate or deactivate the specified workflow using the Flowster RestAPI.

Activity Parameters

The Edit Workflow Status activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect To Flowster RestAPI activity should be used as Input for this parameter.

• Status (combo box editor type)(type: string): choose the new status for the specified workflow

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow ID (text editor type)(type: int32): enter the ID for the workflow in which the workflow timestamps will be deactivated or the last timestamp will be activated

• Workflow Timestamp ID (text editor type)(type: int32): enter the ID for the workflow timestamp that you want to activate/deactivate. This parameter takes precedence over the 'Workflow ID' parameter.

The Read Only Output variable are the possible output values that the activity will provide:

• Output (text box editor)(type: boolean): outputs True if the operations succeeded, otherwise False

Get File Repository Content

This activity gets the content of the active version of the file. If variables/global variables/arguments are used in the file, they will be replaced during execution if they are declared in the workflow. Variables that store an encrypted value or global variables of type password will be replaced with the decrypted value.

Activity Parameters

The Get File Repository Content activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• File Path (text box editor type) (type: string): the path to the file in the following format: “RootFolder/SubFolder/File“

The Read Only Output variable are the possible output values that the activity will provide:

• File Content (type: string): returns the content of the file.

Get Workflow Execution Status

This activity retrieves the status for the specified workflow using the Flowster RestAPI.

Activity Parameters

The Get Workflow Execution Status activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow Guid (text editor type)(type: string): enter the Workflow Guid. This parameter can be obtained from the Output parameter of the 'Start Flowster Workflow' activity

The Read Only Output variable are the possible output values that the activity will provide:

• Output (text editor type)(type: string): outputs the Workflow Execution Status. Valid Status: ‘Completed',’Aborted','Terminated','Error','Denied','Expired','Exception','Started'

Get Workflow Parameters

This activity gets the specified workflow’s parameters using the Flowster RestAPI.

Activity Parameters

The Get Workflow Parameters activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow Category (text editor type)(type: string): filter the workflows by the category name. The timestamp must be a direct child of this category. NOTE: If this parameter is set, then a valid Display Name is needed as well

• Workflow Display Name (text editor type)(type: string): enter the display name for the active workflow that you want to start. If more timestamps exist with the given display name then try narrowing down the results using the 'Workflow Category' filter, otherwise the first one will be retrieved. It can be copied from the Flowster Administrator by selecting the desired timestamp

• Workflow ID (text editor type)(type: int32): enter the ID for the workflow that you want to start. This parameter takes precedence over the ‘Workflow Timestamp ID', ‘Workflow Display Name’ and 'Workflow Category’ parameters. The ID can be copied from the Flowster Administrator by selecting the desired timestamp

• Workflow Timestamp ID (text editor type)(type: int32): enter the ID for the workflow timestamp that you want to start. This parameter takes precedence over the ‘Workflow Display Name' and 'Workflow Category’ parameters. The Workflow Timestamp ID can be copied from the Flowster Administrator by selecting the desired timestamp

The Read Only Output variable are the possible output values that the activity will provide:

• Output (text editor type)(type: <Collection<Dictionary<String,String>>>): returns a collection of KeyValuePairs containing the parameters found with their Names and other properties. In order to use the output you can iterate through the elements and use the GetKeyValuePair activity with the keys: ‘Name', ‘DisplayName’, ‘ParameterType’ and 'IsRequired’

Get Workflow Tracking Data

This activity retrieves the Tracking Data for the specified workflow using the Flowster RestAPI.

Activity Parameters

The Get Workflow Tracking Data activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow Guid (text editor type)(type: string): enter the Workflow Guid. This parameter can be obtained from the Output parameter ofe the 'Start Flowster Workflow' activity

The Read Only Output variable are the possible output values that the activity will provide:

• Output (text editor type)(type: <Collection<String>>): outputs the Workflow Tracking Data lines

• Output Error Message (text editor type)(type: string): outputs the exception message in case of unsuccessful execution and empty otherwise

• Output Workflow Output (text editor type)(type: <List<Dictionary<String,Object>>>): outputs a list of dictionaries containing the OutArgument’s Name, Value and Type. In order to use the output you can use the GetKeyValuePair activity with the keys: ‘Name', ‘Type’ and 'Value’

Get Workflow Out Arguments

This activity retrieves the Out Arguments for the specified workflow using the Flowster RestAPI.

Activity Parameters

The Get Workflow Out Arguments activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow Guid (text editor type)(type: string): enter the Workflow Guid. This parameter can be obtained from the Output parameter ofe the 'Start Flowster Workflow' activity

The Read Only Output variable are the possible output values that the activity will provide:

• Output Workflow Output (text editor type)(type: <List<KeyValuePair<String,Object>>>): Outputs a list of dictionaries containing the OutArgument's as Key (Parametername as String) Value (Parametervalue as Object) pair. Values can be accessed by the activity “GetKeyValuePair” or by accessing the index and the value of the output variable. The value will be returned as object and must be converted into the correct datatype.

Start Flowster Workflow

This activity starts the specified workflow using the Flowster RestApi.

Activity Parameters

The Start Flowster Workflow activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Comments (text editor type)(type: string): specify a comment

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Execution Agent (text editor type)(type: string): enter the IP or Computer Name for the Execution agent that will execute the workflow

• Fallback (combobox editor type)(type: string): please select this option if you want the workflow to be executed even in case of system failure

• Linux Execution Group (text editor type)(type: string): enter the name of the Linux Execution Group containing the Linux Agent that will execute the workflow

• Parameters Collection (text editor type)(type: ObservableCollection<NameObjectValuePair>): specify the parameters you want to send with the request. Arguments/Variables of type Array (e.g. String[], Int32[]), Collection<T> (e.g. Collection<String>), List <T> (e.g. List<KeyValuePair<String,String>>). MUST be initialized before they can be used as binding. E.g. If a parameter of type Collection<String> is bound to a workflow parameter, it MUST be initialized either by setting value New Collection (Of String) in the Default Value column in the Designer - Arguments area or by using Assign (or other initializing activities) activity to assign New Collection(Of String) value to the argument/variable

• Schedule Time (text editor type)(type: string): specify the schedule time if you want the workflow to be scheduled. Accepted format is: dd-mm-yyyy HH-MM (e.g. 31-03-2015 12-06)

• StartedBy (text editor type)(type: string): enter the username with domain for the user that starts the Flowster Workflow. If left empty the specified 'Username' will be used. (example: “domain\\user“)

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow Category (text editor type)(type: string): filter the workflows by the category name. The timestamp must be a direct child of this category. NOTE: If this parameter is set, then a valid Display Name is needed as well

• Workflow Display Name (text editor type)(type: string): enter the display name for the active workflow that you want to start. If more timestamps exist with the given display name then try narrowing down the results using the 'Workflow Category' filter, otherwise the first one will be retrieved. It can be copied from the Flowster Administrator by selecting the desired timestamp

• Workflow ID (text editor type)(type: int32): enter the ID for the workflow that you want to start. This parameter takes precedence over the ‘Workflow Timestamp ID', ‘Workflow Display Name’ and 'Workflow Category’ parameters. The ID can be copied from the Flowster Administrator by selecting the desired timestamp

• Workflow Timestamp ID (text editor type)(type: int32): enter the ID for the workflow timestamp that you want to start. This parameter takes precedence over the ‘Workflow Display Name' and 'Workflow Category’ parameters. The Workflow Timestamp ID can be copied from the Flowster Administrator by selecting the desired timestamp

The Read Only Output variable are the possible output values that the activity will provide:

• Output (text editor type)(type: boolean): outputs True if the workflow was started, otherwise False

• Output Guid (text editor type)(type: string): outputs the Workflow Guid

• OutputScheduledWfID (text editor type)(type: string): outputs the scheduled Workflow’s ID

Stop Flowster Workflow

This activity stops the specified workflow using the Flowster RestAPI.

Activity Parameters

The Stop Flowster Workflow activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): Flowster Connection. The Output from Connect to Flowster RestApi activity should be used as Input for this parameter.

• Scheduled Workflow ID (text editor type)(type: int32): enter the ID for the scheduled workflow that you want to stop, or bind this parameter to the ‘OutputScheduledWfID' from the 'Start Flowster Workflow’ activity

• Timeout (text editor type)(type: int32): specify the number of minutes to wait the operation

• Workflow Guid (text editor type)(type: string): enter the GUID for the workflow timestamp that you want to stop, or bind this parameter to the ‘Output Guid' from the ‘Start Flowster workflow’ activity. This parameter takes precedence over the 'Scheduled Workflow ID’ parameter

The Read Only Output variable are the possible output values that the activity will provide:

• Output (text editor type)(type: boolean): outputs True if the operation succeeded, otherwise False