Setup

Reach out to your IDI Account Manager to establish a relationship with Zinier and enable the functionality in your IDI platform. Both IDI and Zinier professional service teams can assist with configuration and set up.

Preliminary Setup in Zinier

Create a Zinier Web Service User

Create a web service user in the Zinier Application.  This user will be used to communicate from the IDI application to the Zinier APIs.

Install the IDI Implementation Bundle in the Zinier App Store

The IDI bundle contains the prebuilt features and functionality required for integration.  Reach out to your Zinier support representative if you do not see it or need help installing it. The IDI implementation bundle:

• Enables Zinier to communicate work order status information to IDI.

• Lets IDI Workflow request and receive work order information from Zinier.

From Zinier’s Z Studio, go to App Store > Available Apps and select IDIImplementation. Install the app in your Zinier organization.

Configure IDI Connection Information in Zinier

Once the IDI Implementation bundle is installed in the Zinier application, configure the connection to IDI. This involves configuring the External System and Entity configuration in the Admin app.

External System Configuration

• Go to Admin > Org Config > External Systems > idiCredentials and select Edit.

• Paste the following JSON string in the Security Credentials box and replace the bolded values with your environment and credentials.

{
“IDI_Host”: “api.idibilling.com“,
“IDI_Environment”: “IDI01_S_Stage“,
“payload”: {
“Environment”: “IDI01_S_Stage“,
“Primary”: {
“AppliesTo”: “http://idibilling.com/webservices”,
“Password”: “****“,
“Username”: “IDI\\idi_ws_user”
}
}
}

Update Entity Configuration

• Go to Admin > Orig Config > Entity Config> idiIntegrationLogin

• Update the following values in the Config Value text box.

• Environment: IDI environment you want to integrate with (Prod, Test, Stage, etc.)

• Password:   Password for the established IDI web service integration user.

• Username:  Username for established IDI web service integration user.

Update Network API

Go to Z Studio > Object > Network APIs > idiFieldServiceManagement.

Update the Header Paramas box and post in the following text:

{“Authorization”:”{@Authorization}”}

Create Work Order Templates in Zinier

The API call IDI uses to create a work order in Zinier is based on Zinier work order templates. Each template corresponds to a different type of service request, for example Internet & WiFi Installation or Break Fix. To create these templates:

• Manually create a work order using an existing work order type.

• Edit the work order and select Save as Template.

  

• Enter the template name and description and save.

Update Service Windows

Verify the IDI Implementation Service Window was added with the solution bundled. Go to Settings > General Settings > Service Windows.

Ensure the service window is set as the default.

Edit the service window and set your company’s weekly hours and public holidays.

Preliminary Setup in the IDI Platform

Permissions

Those responsible for viewing and managing work orders will require several permissions related to field service management in the IDI Security web module.

Create an Integration User Account in IDI Security

Submit a service request to have an IDI web service user created in the IDI security module. This user communicates from Zinier to the IDI APIs.

Configure Zinier Connection Parameters in Workflow

In the IDI Workflow web module, select CONFIGURE > Field Service Configuration.

In the Field Service Configuration form, enter the required information as provided by Zinier.