Integrate with ServiceMax

Estimated Effort ~ 1-2 hours

Learning Objectives

After completing this unit, you will be able to:

  • Configure connection between ProntoForms and ServiceMax

  • Configure a User Defined Custom Action in ServiceMax

  • Launch ProntoForms from the ServiceMax App, complete a form, updating the Work Order details in ServiceMax

Prerequisites 

In order to configure an integration between ProntoForms and ServiceMax, you will require:

  • An active ServiceMax subscription 

  • The ServiceMax Go or ServiceMax FSA App installed on mobile devices

  • An active ProntoForms account

  • The ProntoForms app installed on mobile devices

  • A target form in ProntoForms which will receive data from ServiceMax

  • A Work Order dispatched to your user in ServiceMax

Getting Started with ServiceMax

ServiceMax is the global market-leader in Service Execution Management, providing a cloud-based software platform that improves the productivity of complex, equipment-centric service execution for OEMs, operators, and 3rd-party service providers. ServiceMax FSM optimizes execution of both short cycle operations - emergency work, meter services, compliance jobs, maintenance and inspection-and long cycle operations, such as outage management, that encompass multiple days, tasks, and people.

Step-by-Step

Your Use Case - Launch a form in ProntoForms which is populated with data from ServiceMax

Here is a common use case: A technician who has been assigned a work order in ServiceMax must complete an extensive checklist in ProntoForms. 

In ProntoForms

  1. Create a Salesforce Connection between ProntoForms and your ServiceMax org by navigating to Manage Forms > Connections > Create Connection

  2. Name the Connection, and select the FormSpace where the form to be dispatched to can be found. 

  3. Establish your connection by clicking Connect, and entering your ServiceMax Admin user credentials. 

  4. Navigate to the form which you would like to Dispatch from the ServiceMax App. (Form > Pages & Questions Tab > Label column). You will need to reference the Question Labels when setting up your User Defined Custom Action in ServiceMax. 

In ServiceMax

  1. Navigate to ServiceMax Setup in the ServiceMax Admin menu. 

  2. Navigate to Service Flow Manager SFM Custom Actions.

  3. Manage Customer Actions For > Select Work Order from the dropdown menu. 

  4. In User-defined Custom Actions click the New button. 

  5. Select your Action Type:
    To integrate with the ServiceMax Go or FSA applications, proceed to 1. App-to-App. If you are running ServiceMax in a browser on Windows 10 and calling the ProntoForms Windows 10 application, proceed to 2. URL.

    1. App-to-App.

      • Action Title: <Name your action>

      • Action ID: <Give your action an ID>

      • Scheme Name: prontoforms

        mceclip0.png

      • Path: x-callback-url/open

    2. URL

      • Action Title: <Name your action>

      • Action ID: <Give your action an ID>

      • Open URL in: Existing Window

      • URL to Launch: prontoforms://x-callback-url/open

        mceclip2.png

  6. Define your Parameters Next, define the list of parameters to be sent from the ServiceMax app to the ProntoForms app. The name parameter is required, and should be used to identify the correct form to be opened in the ProntoForms application. In the example below, the form to be opened is called Inspection Checklist. All other parameters are mapped based on what data you wish to dispatch into ProntoForms, from the relevant Work Order in ServiceMax. The Parameter Name on the left hand side is the the question label, as found in ProntoForms.

    mceclip4.png

    In this example, the Record ID (ProntoForms question label: recordID, ServiceMax work order parameter value: Record ID) will be mapped to the question Work Order ID.

    Screen_Shot_2019-11-06_at_3.32.37_PM.png

    To send strings of text, select Value as the Parameter Value Type. To send the value which is stored within a field in the given Work Order in ServiceMax, select Field Name as the Parameter Value Type, and then select the ServiceMax field you wish to map.

    Exclusively for use in app-to-app configurations, configure x-success, x-cancel, and x-error parameters with parameter values following the table below, to bring the originating ServiceMax application back to the foreground upon a success, error or cancel event in the ProntoForms application.

    App

    Callback parameter

    Example

    ServiceMax Go

    https://go.servicemax.io/

    prontoforms://x-callback-url/launch?reconcile=1&x-success=https://go.servicemax.io/

    ServiceMax FSA

    svmx://x-callback-url

    prontoforms://x-callback-url/launch?reconcile=1&x-success=svmx://x-callback-url

     Please refer to ServiceMax support documentation for other callback parameter details.

    Note: These callback parameters are not compatible with a URL configuration. To return to ServiceMax, users must manually return to their browser.

  7. When you have completed the mapping of your parameters, ensure that you Save & Close the page. 

In ServiceMax - Add a new FSM Wizard Step

  1. Navigate to ServiceMax Setup in the ServiceMax Admin menu. 

  2. Navigate to Service Flow Manager SFM Wizards.

  3. Select Object > Work Order. 

  4. Under the Custom SFM Wizards, select the Wizard which applies to your users, and click Edit

  5. Navigate to the Manage Wizard Steps tab, and click on the New Step button.

    • Wizard Step Type select Others.

    • Step Name select your action, as named in the Action Title above. 

    • Title, enter the name of the step as you would like it to show up for your users in the ServiceMax app. 

  6. When you have completed the set-up of your FSM Wizard Step, ensure that you Save & Close the page. 

In ServiceMax Go

  1. Ensure that your configuration has synced to your device. Open the ServiceMax Go app, press More, in the bottom right hand corner. SyncRun Configuration Sync

  2. Navigate to a Work Order assigned to the user you are logged in as. Open the Work Order, press the Work Order number to see the Work Order overview.

  3. Open the burger menu in the bottom right hand corner. Your new User Defined Custom Action will appear in the Actions menu with the step name as defined by you in step 6 above. 

  4. Selecting the action will open the ProntoForms app, taking you directly into the app, and dispatching the work order details, as per your configuration.

Troubleshooting Tips

A common approach to troubleshooting involves creating a new SFM custom action with only the prontoforms://x-callback-url/open parameter configured. If the app launches successfully, then you can continue building from there. For more information on app-to-app communication, see the topic App-to-App Communication.

Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request

Comments