Manual Form Set Up in Device Magic

Derek Torres
Derek Torres
  • Updated

Important Note: ServiceForms is now ServiceTrade InspectionManager. InspectionManager retains all of the inspection automation benefits of its predecessor but with some important additions. To read more about this exciting change, read more here.

Important Note: The customization features discussed in this article are part of InspectionManager's new subscription plan -- Pro. If you're currently using our legacy ServiceForms plan, please be aware that these new features are not included in your existing subscription. To take advantage of these enhancements, consider upgrading to one of our new plans. For more information, please contact your Account Manager.

If you opt to customize your Standard Forms, you will not be eligible for future version updates.

Manual Form Set Up in Device Magic

Before you go further and set up your form manually, make sure you have read the article, Form Setup in InspectionManager. In that article, you will find instructions on automatic form setup, which is preferred over manual form setup.

If you still wish to continue with manual form set up, read on.

 

Steps to Manually Setup Forms in Device Magic

Manual form creation requires the following:

Step 1: Setting Up the Form in Device Magic

  1. Go to the Device Magic management console login page.
  2. Login with your username and password.
  3. Click on ‘Forms’ in the menu on the left.
    Manual-Step-3.png
  4. Click the ‘New Form’ button on the top right.
    Manual-Step-4.png
  5. Enter a name for your form where it says "Untitled Form".
    Manual-Step-5.png
  6. Add as many fields as necessary to meet your requirements. (For more information on form creation, visit the Device Magic help center here.)
    • Note: Your form MUST have a field whose identifier is servicetrade_job_id. It should be set up like this:
      Manual-Step-6.png***Make the Job ID field read-only and place it at the very bottom of the form. The technician user doesn't need it and should never change it. ***
  7. Click 'Save and Close' in the upper right.

 

Step 2: Creating a PDF Destination

Follow these additional instructions to add a PDF destination. This must be added for every form that will create a PDF to be attached to the ServiceTrade job.

  1. In the Device Magic management console, from the form details page, click ‘New Destination’.
    Manual-Step-8.png
  2. In the ‘Select a Destination’ section, choose ‘Amazon S3’.
  3. In the ‘Select a Format’ section, choose ‘Adobe .pdf’.
  4. In the ‘Deliver image, signatures, and sketches to’ drop-down, choose ‘None (inline).’
  5. In the ‘Destination Description’ section, enter a description (such as the name of the form followed by ‘ - PDF’). Leave the active checkbox checked.
  6. In the ‘Customize PDF file’ section, enter a filename. The filename MUST BE EXACTLY in the following format:
    • XXXX__{{fields.servicetrade_job_id}}__{{fields.servicetrade_job_number}}__{{submission_id}}.pdf
    • Where 'XXXX' is your ServiceTrade account ID.
  7. Click Upload a template.
    • (OR leave the template upload empty to use Device Magic's standard PDF template. It's fine to use the standard template for testing.)
  8. In the ‘Amazon S3 Options’ section, enter the Access Key ID, Secret Access Key, bucket name, and folder path for this form. For ‘Link settings’, choose ‘Files available publicly’.
  9. Click ‘Create Destination’.

 

Step 3: Create a InspectionManager Connector Destination

Follow these additional instructions to add the InspectionManager Connector destination. This must be added for every form that will cause any actions (create deficiencies, add assets, etc.) in ServiceTrade.

  1. In the Device Magic management console, from the form details page, click ‘New Destination’.
  2. In the ‘Select a Destination’ section, choose ‘HTTP(S)’.
  3. In the ‘Select a Format’ section, choose ‘JSON
  4. In the ‘Deliver images, signatures, and sketches to’ drop down, choose ‘Amazon S3’.
  5. In the ‘Destination Description’ section, enter a description (such as the name of the form followed by ‘ - Connector’). Leave the active checkbox checked.
  6. In the ‘HTTP(S) Options’ section, enter the Connector listener URL: https://serviceforms-api.servicetrade.com/dm/formsubmit
  7. Click ‘Add a custom header’.
  8. In the ‘Key’ field, enter account_id.
  9. In the ‘Value’ field, enter the ServiceTrade account ID for this customer.
  10. Click ‘Add a custom header’ again.
  11. In the ‘Key’ field, enter form_id.
  12. Copy the ID of this form from the URL of the form edit page in Device Magic, and paste it into the ‘Value’ field.
  13. In the ‘Binary Amazon S3 Options’ section, enter the Access Key ID, Secret Access Key, bucket name, and folder name for this form. For ‘Link settings’, choose ‘Files available publicly’.
  14. Click ‘Create Destination’.

 

You've completed the manual form set up in Device Magic, and now you need to continue with form set up in the InspectionManager Connector. You can read those instructions in the article Form Setup in InspectionManager, starting with "InspectionManager Connector Form Set Up"/Step 8.

 

All support requests for InspectionManager should be emailed here.

Was this article helpful?

/

Comments

0 comments

Please sign in to leave a comment.