Overview
Connect Mirata with other systems and automate tasks by using integration actions. This allows you to streamline workflows and improve data management.
Types of Integration Actions
Mirata provides several types of integration actions:
Data Table Requests: Add, update, delete, or query Mirata Data Table data.
Email Notification Requests: Send configurable emails.
Embedded Integration Events: Send messages to Integration Applications (e.g., MDK).
HTTP Requests: Perform any HTTP request (various body types supported).
Submission Requests: Run update actions for Inbox submissions (including deletion).
Creating an Integration Action
Navigate to the Integration Actions tab in the Admin tab of the Admin Tool.
Click the + ADD INTEGRATION ACTION button.
Provide a name for the action. Designer users will see this name.
Select the Action Request Type.
This will open the DETAILS tab.
Configure the specific settings for the action type. View the screenshot below for an example of an Email integration action.
Input Parameters
Input parameters pull data from forms into your integration action requests. You configure these parameters in the action's Input Parameters tab.
You can use input parameters to store form values in a Mirata Data Table or external system, send emails, or trigger external notifications. Create input parameters for each value you want to use in your integration action.
Use Case | How to utilize input parameters |
You want to store the reading values entered by a tech on a form in a Mirata Data Table or send those values to another system when the form is submitted. | Use a data table or http request and create an input parameter for each of the values that you’re sending to the table or other system. |
You want your form to send an email to the person selected on the form as the approver whenever there’s one ready for their approval. | Use an email notification request and create an input parameter for the recipient email address list. You might also create input parameters for the form’s ID number, the technician’s name, and the datetime of form completion so that you can insert this data in the subject and/or body of the email. |
If a reading is out of bounds, you want the form to automatically create a notification in some other system. | Use an http request and create an input parameter for each piece of data that you need to send in order to create the notification, such as: technician name, datetime of reading, and reading value. |
Here is an example of Input Parameters for the Email Integration action.
Referencing Input Parameters in the Request
Different types of Integration Actions have different types of "Requests" which is where the input parameters are being used to complete the action. The following screenshot is the Request tab for the Email integration action. The input parameters that were previously created, are being referenced in {} notation. That tells the integration action that these fields will be populated when connecting the integration action to a transition/transaction on a form.
Testing Integration Actions
Each action type has a TEST tab in the Admin Tool.
Always test your integration actions in the Admin Tool before using them in Designer forms.
CAUTION: Running the action in TEST tab will actually execute the action. For Data Table Requests, records in your Data Table may be added/deleted/updated. For Form Submission Requests, the Form Submission with the provided Submission ID will actually be deleted.
Tying an Integration Action to a Workflow Transition
In the Designer, select the workflow transition where you want the integration action to run.
Click the + button in the Integration Actions tab.
Search for and select the action.
Map the input parameters to the corresponding data from the form. You can map data directly or use calculations.
You can optionally run the action per array row and/or add a filter.