Overview
There are a few steps you must take so that you can use a form within SSAM.
If you're attempted to use a form within SSAM and running into an issue, then double check that you've followed each step in this article!
1. Set Assignment for Create Transition
Set the form to assign to current user on "create" transition in the Assignments tab like so:
2. Add Hidden Fields to tie to Work Order and Operation
Create 3 fields under the "Layers" tab on the left side of Designer, 1 boolean field and 2 string fields.
One string will be named "work-order-id" and the other will be named "operation-id". These names are standard for SSAM. It is standard to have both string fields in the form, however specific client needs may require only one of the two string fields to be present.
The boolean must be named "mobile-complete" and must have an initial value of "False" (configured in the boolean's 'calculations' tab).
Create a Boolean Field for Mobile Completion Status
To track the mobile completion status of the form, add a new boolean field to your form's layers. In the Layers panel, select 'Configure New Field', choose 'Field', and set the 'Type' to 'boolean'. Initialize the Mobile Completion Field to false.
Create String Fields for Work Order and Operation IDs
To include hidden fields for work order and operation IDs, essential for SAM compatibility, add a new string field to your form's layers.
Name the string fields "work-order-id" and "operation-id" respectively.
Initial Calculation on Work Order and Operation IDs
Put an initial calculation on work-order-id and operation-id, so that the values are pulled from SSAM data using Integration Data Mappings with the "integration-data" calculation.
3. Configure Form Header/Search Fields Information
Include Work Order and Operation IDs in Header Info
This may be labeled "Header Info" or "Search Fields", depending on your version of Mirata
Add the "work-order-id" and "operation-id" fields to the form's header information. Navigate to 'Form Details' and add these fields within the 'HEADER INFO' section.
4. Configure Integration Actions in the Workflow
Add Integration Action for Form Start
Add the "MDK form start" integration action to the 'create' transition in your form's workflow.
Add Integration Action for Form Completion
Add the "MDK form complete" integration action to the final transition in your form's workflow, which will occur in SSAM. In most examples this is a transaction called something like 'complete'. NOTE: You may have additional steps like approval that occur after the complete transition and that is ok, as long as this step should be the last that the technician can complete in SSAM.
There is no need to specify "For Each in Array" or "Filter" for the MDK Start and Complete integration actions.
If you do not see either action as an option, then please contact your Mirata admin to get it added.
5. Set Mobile Complete to True on Completion
In the same transition that you added the "MDK form complete" integration action, you also need to add a form update which will set the mobile-complete checkbox you created in step 1 to true.
To do this, follow the below steps:
Add a boolean field to the dialog of the complete transition
Set the initial value of the field to true
Add a form update which sets the mobile-complete checkbox on the form to true using this new field in the dialog
You can also hide this field from the end user by setting the visible property to false