Automating tasks by using AutomationEdge processes

As an application business analyst, automate tasks and repetitive actions, such as onboarding employees, scheduling systems, and data processing, by using the processes in AutomationEdge. To trigger an AutomationEdge process, create a process in your application by using the Run AE Process and Get AE Process Status elements in the Process designer.

Before you begin

Make sure an administrator has configured a webhook callback and AutomationEdge connector.

For more information, see Adding-an-AutomationEdge-connector-configuration.

Related topics

Creating-a-document-instance

Process-variables-and-data-types

Viewing-and-managing-process-execution

To create a process to trigger an AutomationEdge process

Log in to BMC Helix Innovation Studio.
Navigate to the Workspace tab, and select the application in which you want to create a process.
In the application, select Processes, and click New.
In the Process designer, drag the Run AE Process element to the canvas.

In the Run AE Process element Properties pane, enter the values of the following input properties:

Property	Description
Connection ID	Connection ID of the AutomationEdge connector.
Process Or Workflow Name	Select the name of the AutomationEdge process or workflow from the list. Important: The values in the list are fetched from the server configured in the respective connector.
Process Correlation ID	Correlation ID that can be used to uniquely identify a process instance execution. This property is used with AutomationEdge callback.
(Optional) Parameters	Value for the parameters defined in your process. Important: The supported data types are String, Number, Integer, Boolean, and Date.

The Run AE Process output is JSON that provides the response and status of the AutomationEdge process or workflow. For example:

{ "sourceId": "<Source ID>", "responseDetails": null, "source": null, "inputAttribute6": null, "inputAttribute5": null, "userId": null, "inputAttribute4": null, "parentId": null, "inputAttribute3": null, "responseCode": "RequestCreated", "inputAttribute2": null, "inputAttribute1": null, "responseMailSubject": null, "success": true, "automationRequestId": <Automation Request ID>, "errorDetails": null }

To create a process to get the status of an AutomationEdge process

Log in to BMC Helix Innovation Studio.
Navigate to the Workspace tab, and select the application in which you want to create a process.
In the application, select Processes, and click New.
In the Process designer, drag the Get AE Process Status element to the canvas.

In the Get AE Process Status element Properties pane, enter the values of the following input properties:

Property	Description
Connection ID	Connection ID of the AutomationEdge connector.
Automation Request ID	The automation request ID of the process or workflow that you trigger in the AutomationEdge console. If you use the Get AE Process Status element and the Run AE Process element in a process, map the output property automationRequestId of the Run AE Process element to this property.

The Get AE Process Status output is JSON that provides the response and status of the AutomationEdge process or workflow. For example:

{
"container": false,
"sourceId": "<Source ID>",
"failureReasonDescription": null,
"totalOperations": 0,
"retriedCount": 0,
"source": null,
"inputAttribute1": null,
"workflowConfiguration": {
"id": <Workflow configuration ID>,
"name": "<Process name>"
},
"workflowResponse": {
"message": null,
"error": null,
"currentStatus": null,
"outputParameters": [
{
"name": "param1",
"value": "pr1",
"type": "String",
"uiControlType": null,
"order": 0,
"secret": false,
"optional": false,
"defaultValue": null,
"displayName": "outputParam1",
"extension": null,
"poolCredential": false,
"listOfValues": null,
"valueSeparator": null
},
{
"name": "<Process name>.txt",
"value": "f014fb58-f592-44e0-9153-dd366075a523",
"type": "File",
"uiControlType": null,
"order": 1,
"secret": false,
"optional": false,
"defaultValue": null,
"displayName": "<Process name>.txt",
"extension": "txt",
"poolCredential": false,
"listOfValues": null,
"valueSeparator": null
}
]
},
"id": 23587,
"enableTermination": false,
"agentName": "<Agent name>",
"workflowName": "<Process name>",
"inputAttribute6": null,
"priority": "DEFAULT",
"inputAttribute5": null,
"userId": null,
"inputAttribute4": null,
"completedDate": 1629882766847,
"inputAttribute3": null,
"inputAttribute2": null,
"lastUpdatedDate": 1629882766853,
"createdDate": 1629882760712,
"agentDeleted": false,
"attribute5": null,
"attribute4": null,
"createdBy": 434,
"failureReason": null,
"attribute6": null,
"successfulOperations": 0,
"attribute1": "attr1",
"attribute3": "attr3",
"executionStartTime": 1629882763456,
"attribute2": "attr2",
"status": "Complete"
}

If required, add the other process elements and specify the flow of execution that you want to create for your business logic.
Save the process.

Example: Automating the task of writing in a file by using an AutomationEdge process

Ajay is an application business analyst at Apex Global. He wants to automate the task of writing in a file by using an AutomationEdge process so that minimal manual intervention is required to complete the task. Ajay performs the following actions to create a process to trigger the AutomationEdge process that performs the task:

Step	Description	Example
1	Create the process.
2	Add the process properties to map them with the AutomationEdge process input variables.
3	Add Create Document properties.
	a. To add a document, select the AutomationEdgeParameters document definition.
	b. To add values for the document nodes, click Add/Remove Document Nodes, and select the key and value checkboxes of nodes.
4	a. In the Run Automation Edge Process properties pane, in the Input Map section, enter the Connection ID.
	b. Select a process from the Process Or Workflow Name drop-down list that you want to trigger.
	c. Enter the Process Correlation ID.
	d. Add the output from the Process Parameters as inputs to the Run AE process.
5	Add Get Automation Edge Process Status properties.
6	Add Receive Task properties.
7	Add Timer properties.
8	Add Send User Message properties.
9	Save the process.

Example: Using AutomationEdge callback to receive notifications about process completion

Ajay is an application business analyst at Apex Global. He automates a task by using an RPA process in AutomationEdge. He wants to receive a notification about the process completion. Ajay performs the following actions to automate the task and receive notification about the completion or failure of the task:

Step	Description	Example
1	In your application, create the process to automate the task.
	a. Add the process properties to map the AutomationEdge process input variables.
	b. Add Run AE Process properties. Important In the AutomationEdge process that you use, make sure that you expose the callbackUrl, callbackAuthKeyOrUserName, callbackPassword, and processCorrelationId parameters and use these parameters to provide a callback.
	c. Add Receive Task properties.
	d. Add Timer properties.
	e. Add Send In App Notification properties.
	f. Add Send In App Notification properties.
	g. Save the process.
2	Create the rule that is triggered by the AutomationEdge callback.
	a. Add the Trigger properties.
	b. Add the Qualification properties. AutomationEdgeConfig is the callback configuration name.
	c. Add the Signal Process properties.
	d. Save the rule.