Overview
You can set up Mirata forms to securely exchange data with other systems by following the steps detailed in this article. The initial two steps in the Admin Tool should be handled by someone with an understanding of your system's network APIs and security. Following that, non-technical form builders can seamlessly incorporate the integrations at the preferred points within their forms and workflows in the Designer.
While examples used in this article are for integrating with SAP, these steps are for integrating Mirata with any outside system.
Outline of Steps to Integrate with Another System
System Administrator: Create a Connection in the Admin Tool (one-time setup for each outside system)
Techno-Functional Resource: Create Integration Action(s) in the Admin Tool
Non-Technical Form Builder: Select the Integration Actions at the desired steps in your Form/Workflow in the Designer
To send data from another system to Mirata
To pull data into a Mirata form from another system
Creating a Connection
For each system you want to integrate with, you’ll need to create a Connection. This only needs to be set up once per API and should be done by a System Administrator. To create a Connection, navigate to the "Admin" tab within the ADMIN tool, and select the connections icon. The select the "+ ADD CONNECTION INFO" button.
On the first page of the connection setup, you will need to indicate what type of connection is going to be built. In Mirata, you can set up an SAP connection or an HTTP connection.
After naming your connection, and selecting what type of connection, you will need to specify a base URL.
Following this, navigate to the "AUTHENTICATION" tab. You will need to select an Authentication Type. In Mirata, there are three types of authentication types:
SAP Basic Authentication
Mirata OAuth Token
None
If the authentication type is SAP Basic Authentication or Mirata OAuth Token, you will be given the option to set up a login URL path.
You can also request secret keys, which are values used for authentication which are securely stored in AWS. Values supported are: userId, password, and certificates. Secret Keys are configured by Mirata. If the Authentication Type is SAP Basic Connection, the Secrets will default to a userid and password.
After setting up any Secret keys, navigate to the "CONFIGURATION" tab. The first section to edit/add to is Request Headers - this is for standard/custom headers that will be added to any Integration Action that uses this Connection Info.
The next thing to set up is the VPC Configuration. VPC (Forwarding) Connection is he name of a Mirata Lambda that requests are forwarded to. This value will be needed if the Lambda is setup to run in a customer VPN . This will need to be set up with Mirata and your System Administrator.
Lastly, you will can add to the Response Transformation which includes:
Success Script: A JSONata script, used to retrieve response data from a successful network response.
Status Text Script: A JSONata script, used to retrieve a status code from a network response.
Success Codes: A list of codes that will be treated as a “successful” response.
Common Success Codes: Select any common success codes form a pre-set list of options: 200, 201, 202, 203, 204, 205, or 206
Create an HTTP Request Integration Action to Utilize the Connection
To pull in data from or send data to another system, you will use Integration Actions. Integration Actions are a versatile way of creating network requests to interact with other systems. They can be used by the form designer to facility updates to/from the form, without needing to know the technical details of the integration system. To set up your integration, use an Integration Action with the type "HTTP Request". For more general information about integrations, please visit our Integration Action article.
After creating the integration action, navigate to the "REQUEST" tab. You will need to specify the following information:
Url Path: Specify the endpoint for the request
Headers and Query Parameters: You can provide any header or query parameter key/value pairs that are needed by this request
Body Type: Define the type of data being sent in the body of the HTTP Request. The Content-Type header for the HTTP Request will get set automatically based on the Body Type you select. Your options are:
String, Content Type: text/plain
JSON, Content Type: application/json
OData, Content Type: application/json
XML, Content Type: application/xml
Form URL Encoded, Content Type: application/x-www-form-urlencoded
Multipart Form Data, Content Type: multipart/form-data
Document Upload, Content Type: application/pdf or image/*
JSON Transformation (JSONata), Content Type: application/json
Body: Provide the body of the API call, in the format selected in the Body Type dropdown
Using Input Parameters: You can use Input Parameters in the HTTP Request Body and Url Path fields. To use them, wrap the Input Parameter's name in curly brackets. For example, use the Input Parameter "FirstName" in the request body as follows: "Hello {FirstName}...".
NOTE: The Input Parameters you create will be data that can be mapped directly to input fields on the form/workflow by your form builders. Make sure to use user-friendly names for Input Parameters so it’s easy for form builders to figure out what data to provide.
After you’ve set up your Http Request, you can go to the TEST tab in the top right of the Integration Action page to test the call from Mirata. If you set up any Input Parameters, you’ll see them here so you can provide values. After the test is run, you’ll see success or error messages as well as the API response, if available.
After you’ve tested your Integration Action and see the proper API response in Mirata, your Form Builders are now ready to use this Action in any of their forms.
Adding the Integration Action to Mirata Form (High-Level Details)
To learn more about using integration actions in Form Workflows, please visit the Connecting Integration Actions to Workflow article.
In the Workflow Designer, you can add Integration Actions to transitions. When the Form User clicks to run a transition, the Actions associated with the transition will run.
To add an Integration Action to a transition
Go to the INTEGRATION ACTIONS tab and then click the + button. Make sure you have the right transition selected.
Select the Integration Action that contains the HTTP Request.
Map any fields from the form or the transition/transaction dialog to any fields that have been previously specified as required input parameters on the Integration Action.
For Each In Array: Optionally, you can run the action for each row in an array on your form or transition dialog by selecting the array. If you leave this blank, then the Action will run just once when the transition runs.
Filter: Optionally, you can configure a calculation for when the Action should run during this transition. If you leave this blank, then the Action will always run when this transition runs.