AutomationEdge Core

AutomationEdge Core



AutomationEdge Core 

Audit Log

Description

The Audit Log step is used for logging Process/Workflow variables and fields into AutomationEdge audit log.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Log Level 

Select a value from the drop down list. Possible values are INFO and TRACE


Variables Tab

No.

Field Name

Description

1

variables

Accepts comma separated list of variables to be logged in.


Fields Tab: Contains table to accept fields to be logged in.

No.

Field Name

Description

1

Name

Name of field to be logged in.

2

Type

Auto populated once the field name is selected. It is not editable.

Notes: Secret variables are logged as ‘XXXX’




AutomationEdge File Download

Description

The AutomationEdge File Download is used to download files from AutomationEdge Server. 


This step downloads files uploaded by AutomationEdge File Upload step in one of the previous steps in a workflow using the File Identifier from the upload step. These files (such as .csv or .txt) are mostly used for operational purposes by a workflow.


Note: This step can be used to design a workflow however, it executes meaningfully only once published on AutomationEdge Server and when executed by Agents.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.





Download Files:


1

File Identifier

Provide a Field Name which contains unique identifier to access file on the server

2

Downloaded file path

Output field name which would contain the absolute file path with file name and extension of the downloaded file

3

Set Request Id

Defines whether the file scope is public or for the specific request id (Select Yes/No)



AutomationEdge File Upload

Description

The AutomationEdge File Upload is used to upload files to AutomationEdge Server. 


This step uploads files to be consumed by AutomationEdge File Download step in one of the next steps in a workflow using the File Identifier from the upload step. These files (such as .csv or .txt) are mostly used for operational purposes by a workflow.


Note: This step can be used to design a workflow however, it executes meaningfully only once published on AutomationEdge Server and when executed by Agents.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Upload Files:


1

File to upload

Provide a Field name which contains absolute file path with file name and extension to upload

2

Uploaded file identifier

Output field name which contains the unique identifier to access file on the server

3

Set Request Id

Defines whether the file scope is public or for the specific request id (Select Yes/No)

4

File Identifier(Optional)

To override the file identifier generated by AutomationEdge server (which is random and complex to remember) by a more user friendly user specified identifier.



Intermediate Status

Description

This step can be used in a workflow to set intermediate status of the workflow.

Currently, AutomationEdge has the set of states of a workflow: “New”, “ExecutionStarted”, “Complete”, “Failure” and “Diverted”. However, if a workflow is going to run for a long duration then there is no information at the server regarding the state of a running workflow. 

Intermediate Status can be used to set a user defined current status of a running workflow which will be displayed on the UI. Send Status to AE can be used to send the intermediate status of a workflow to AE Server. User can add multiple such steps in a single workflow. Last executed status will be shown at any given time.

Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Status

Specify status that is to be sent to AutomationEdge. It is a free textbox where user can set the status or message like % of completion or any other user defined status

3

Total row count Options

Choose from the drop down list:

  1. Implicit row count: Process Studio will calculate number of rows processed. The row count is maintained internally.
  2. Explicit row count: The row count can be set explicitly by the user.

4

Total row count

Provide a numeric value for the Total number of rows processed. It will only be enabled when Explicit Row Count is selected.

5

Successful row count

Enter a numeric value for Successful row count

6

Options

Choose from the drop down list:

  1. Send for all rows: will send status to AE for each row. This step would be executed for each row processed.
  2. Send for last row: will send status only for last row. This step would be executed after the specified batch size.
  3. Send for batch: you can specify after how many rows the status will be send to AE. This step would be executed after the specified batch size.

7

Batch size

Choose a batch size from the drop down list: you can specify batch size. Batch size after which this step would be executed.



Manual Intervention

Description

This step can be used in a workflow to enable manual intervention for users to complete some tasks or provide input values for a new field or existing field. A pop-up is displayed (always on top) and the workflow pauses until the ‘OK’ or ‘Cancel’ button is pressed.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Display Message

Specify a Display message to appear on the manual intervention pop-up.

3

Process this step for

Choose from the list,

  1. Each Row – Will pause for each row
  2. First Row – Will pause only for the first row
  3. Last Row – Will pause only for the last row


Additional Fields:

Provide a tabular list of fields in the workflow stream to be displayed.

1

Display name

Specify a Display name for the fields. This will be a user-friendly name of the field which will be shown at run time for taking input from the end user.

2

Type

Specified field type, possible values are: String, Number, List, Boolean, Date.

3

Format

Specify the format of specific types like Number, Date.

4

Secret

Specify whether field value would be secured or not (true/false).

5

Display Only

Specify whether value of the field is display only or editable by the end-user (true/false).

6

Optional

Specify whether field value is Optional (true/false)

7

List of Values

Type a list of Comma separated values here and at run time these will be converted to a dropdown where the user can choose one of the values.

8

Default Value

Specify a default value for the given field. This can be a previous field or static value. 

10

Field name

Specify names of fields to be created (in specific cases, details in Validation section) when the step is run. These fields will be available further in the workflow. 

If Default Value contains a previous field from drop down and Field name is left blank then field is updated.

11

Tooltip Description

Specify a desired Tooltip Description for the field.


Output Field:


11

Status Field Name

Specify an output fieldname to hold the user action (OK/Cancel) during step execution. The default value is status.


Send Email

Description

This step is used to send email via AE server. We need to set the SMTP server settings on AE to use this step.

Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Email Details:


1

To

Provide a comma separated list of email addresses.

2

CC

Provide a comma separated list of email addresses in carbon copy(CC)

3

BCC

Provide a comma separated list of email addresses in blind carbon copy(BCC)

4

Subject

Provide a subject for the email.

5

Email body

Provide contents of email body or a variable.

6

Synchronous

If it is checked the step will wait for response from AE Server. Enable checkbox to make it synchronous with workflow completion.

7

Send Email on last row

Enable checkbox to send one email upon completion of reading the last row.





Attachment Details:


1

Attachment

List of attachments




Set PS Variable

Description

Set PS Variable step sets PS Variables with global or local scope as specified; with value assigned from a field. These variables are available in the same workflow.

Configurations

No.

Field Name

Description

1

Step name

Name of the step.  This name has to be unique in a single workflow.

2

Execute even if no row is found

A checkbox to define if the step is to be executed in case no rows are received. By default it is unchecked.

3

Fail if field not found

A checkbox to define if the step is to be failed in case no field is specified. By default it is unchecked.


Field values (Tabular):


1

Field name

Specify the field value which is to be assigned to a variable.

2

Variable name

Specify the variable name which will be used further.

3

Variable scope type

Specify the scope of the variable (Global or Local).


Note:

Global variables are available throughout the lifecycle of the parent workflow/process. They can be created at any sub-level and it will be available after that to the entire scope. They will be destroyed after the main or parent workflow/process ends.

Local variables are available only in the workflow/process where it has been created. They are not available to the child workflow/process.

The same variable name can be used for global and local scopes simultaneously. The value modified or fetched is completely based on the scope specified as mentioned in the note below.


The PS variables are added to the existing list which pops up on Ctrl-Space where applicable. The format of these variables in the list will be as ${GLOBAL.varname} and ${LOCAL.varname}. The PS variables created in ‘User Defined Java Class’ or ‘Modified Java Script’, are not visible in this list.


However,

If the child workflow/process is already opened and a variable is added in the parent workflow/process. This variable is not reflected directly at design time (i.e. on Ctrl-Space) although there no issues during runtime. There are two options for this,

  1. The user can type the variable name where required
  2. Reopen the child workflow/process (from Open referenced object) after the variable is added.

4

Default value

Specify the default value of the variable. Depending on the value of the ‘Execute even if no row is found’ checkbox, it is considered if no row is received.


NoteThe PS variables set in this cannot be used for database connection details.


Common Buttons:

No.

Field Name

Description


Buttons:


1

OK

On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message.

If all the required field values are provided then it will save the field values.

2

Cancel

On click of this button, it will cancel the window and does not save any values.

3

Get Fields

Click this button to fetch the fields from the previous steps in the workflow stream.



Get PS Variables

Description

Get PS Variables step gets PS Variables and assigns to new fields.

Configurations

No.

Field Name

Description

1

Step name

Name of the step.  This name has to be unique in a single workflow.


Field values (Tabular):


1

Variable

Specify the variable which needs to be converted to a field.

2

Field name

Specify a new field name to contain the variable value.


Note: When the variable value will be converted to field the specified type, format and other attributes will be taken into consideration.

3

Type

Specify the type of the field by picking from the list as below.


4

Format

Specify the format of the field.

5

Length

Specify the length of the field. 

6

Precision

Specify the precision of the field.

7

Currency

Specify the currency of the field.

8

Decimal

Specify the number of decimals for the field.

9

Group

Specify the Group of the field.

10

Trim type

Specify the Trim type of the field from the following, 

  1. None
  2. left
  3. right
  4. both


Common Buttons:

No.

Field Name

Description


Buttons:


1

OK

On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message.

If all the required field values are provided then it will save the field values.

2

Get PS Variables

Click this button to fetch PS Variables. 

3

Cancel

On click of this button, it will cancel the window and does not save any values.



Set Workflow Result

Description

The Set Workflow Result is used to set the workflow result on AutomationEdge for the particular request.

Configurations

No.

Field Name

Description

1

Step name

Name of the step.  This name has to be unique in a single workflow.

2

Success

Boolean value (true or false) can be set to define the request status (Success or Failure). 

3

Status

Status can be set from one of the following: Complete, Failure or Diverted. Status can be set irrespective of value set in Success above.

4

Message

Write the success or error message to be set for the request in this field.

Since Success field can have two values and Status field has three values the following combinations are possible.

SUCCESS field

STATUS Field

True

Complete 

True

Diverted

True

Failure

False

Complete 

False

Diverted

False

Failure


The message format is governed by the Success field set above. If Success is true message is prefixed with Message: and if success is false message is prefixed with Error: 


The exceptions are the combinations of True-Failure and False-Complete. For these combinations no message is displayed.


5

Total Operations

Total number of operations performed (such as no. of lines processed in a file). The value in this field can be viewed in the

‘Status-wise Workflow Operations Report’.

6

Successful

Number of successful operations performed. The value in this field can be viewed in the ‘Status-wise Workflow Operations Report’.

7

Attribute 1

Additional Attribute 1. This attribute can be chosen for display as columns in Requests in AutomationEdge UI.

8

Attribute 2

Additional Attribute 2. This attribute can be chosen for display as columns in Requests in AutomationEdge UI.

9

Attribute 3

Additional Attribute 3. This attribute can be chosen for display as columns in Requests in AutomationEdge UI.

10

Attribute 4

Additional Attribute 4. This attribute can be chosen for display as columns in Requests in AutomationEdge UI.

11

Attribute 5

Additional Attribute 5. This attribute can be chosen for display as columns in Requests in AutomationEdge UI.

12

Attribute 6

Additional Attribute 6. This attribute can be chosen for display as columns in Requests in AutomationEdge UI.

13

Output file name patterns (separated by comma)

This field has been added for integration support. This field accepts a comma separated filename regex. These files would be available with the Service Request/Ticket on the Service Desk upon successful updation by an AE workflow.





Output Parameters:


1

Name

The internal name of the variable.

2

Display Name

Display name of the variable as seen on AutomationEdge UI

3

Type

Data type of the variable.

4

Value

Provide the value of the variable. Value could be static, field or a variable.


Debug Log

Description

The Debug Log step is used for logging Process/Workflow variables and fields into AutomationEdge Agent log (agent.log) file when Process/Workflow is run from AutomationEdge; or in Process Studio log (process-studio.log) file when Process/Workflow is run from Process Studio.

Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Log Level 

Select a value from the drop down list. Possible values are DEBUG, INFO, WARN, ERROR in ascending order of severity.

The debug log step will collect logs at the level selected here or at higher lever of severity.


However the base level is governed by the Agent Logger setting (DEBUG, INFO, WARN or ERROR) in the log4j2.xml file available in the agents conf folder. All logs at a higher level than this setting will be visible in Agent log file.


In case of Process Studio the base level is governed by the ProcessStudioLogger setting (DEBUG, INFO, WARN or ERROR) in the log4j2.xml file available in the Process Studio distribution conf folder. All logs at a higher level than this setting will be visible in Process Studio Log file.


Variables Tab

No.

Field Name

Description

1

variables

Accepts comma separated list of variables to be logged in.


Fields Tab: Contains table to accept fields to be logged in.

No.

Field Name

Description

1

Name

Name of field to be logged in.

2

Type

Auto populated once the field name is selected. It is not editable.

Notes: Secret variables are logged as ‘XXXX’

Agent logs are also accessible from AutomationEdge Agent Log menu. Debug logs are part of Agent Logs. Agent Logs are visible by navigating to the Logs menu and Agent Logs sub-menu in AutomationEdge. Agent logs can be obtained by clicking the New Request Button on the top right corner.  Source should be chosen at Agent or Workflow level as shown in the screenshot below.






      Links to better reach 

            Bot Store

             EPD