You can configure and manage the integrations enabled with third-party software in SI. You must be an SI administrator to configure and manage the integrations.
Go to Start > Setup > Control Panel and double-click the Manage Integrations icon in the Integrations settings group.
The Manage Integrations modal will be displayed, listing the enabled integrations.
The following is a screenshot with a few integrations.
Click the View API link to view/copy your API key for any given integration.
The Settings button allows you to configure automation for the integration between SI and the third-party software.
The following are the integration settings.
General
Here, you will see the general settings for integrations.
The following are the settings.
Setting | Description |
Send labor items based on labor type as line items | Setting this to Yes will send the labor line items in a project, based on phase, as line items when the project is exported to one or more integrations selected under Project Automation settings.
Setting this to No will send it as a phase item. |
Aggregate labor types | Here, you can specify how labor types should be aggregated when the project is exported to one or more integrations selected under Project Automation settings.
|
Aggregate variable labor line items | Here, you can specify how variable labor line items should be aggregated when the project is exported to one or more integrations selected under Project Automation settings.. |
Create revision on update project | Setting this to Yes will create a revision of the project when it is updated via the Update Project setting under Automation settings. |
Export allowance items | Setting this to Yes will export the allowance items in the project when projects are exported to one or more integrations selected under Project Automation settings. |
Export bundled cable items | Setting this to Yes will export the bundled cable items in the project when projects are exported to one or more integrations selected under Project Automation settings. |
Export optional items | Setting this to Yes will export the optional items in the project when projects are exported to one or more integrations selected under Project Automation settings. |
Export project comments | Setting this to Yes will export comments in the project when projects are exported to one or more integrations selected under Project Automation settings. |
Automation (Integration to SI)
These automation settings, when set to "Yes," allow the SI Server to poll the relevant integrations for new updates made in them. SI Server polls the integrations once every 4 hours, and the latest updates made are added to the SI database.
The following are the settings. For every setting, you will see the documentation link to the relevant API at the bottom of the modal. Click the link to see more details about the API.
Setting | Description |
Update Clients | Setting this to Yes will update the clients in SI when they have been updated in the integration. |
Create Project | Setting this to Yes will create new products in SI when new projects are created in the integration. |
Notify users when a project with items is created in SI | This setting is enabled only when the Create Project setting is set to Yes.
Here, you can specify the email addresses of users who should be notified when new projects created in SI via the Create Project setting include items. |
Update Project | Setting this to Yes will update projects created in SI via the Create Project setting. |
Create Change Orders | Setting this to Yes will add new change orders created for a project in the integration to the relevant project in SI. |
Create Catalog Products | Setting this to Yes will add new products created in the integration to the SI catalog. |
Update Catalog Products | Setting this to Yes will update products created in SI via the Create Catalog Products setting. |
Create Service Orders | Setting this to Yes will add new service orders created in the integration to SI. |
Import Project Comments | Setting this to Yes will enable importing comments made in the project in the integration to the relevant SI project. |
Catalog Automation (SI to Integration)
The Catalog automation settings allow you to specify how new and updated products in the catalog are exported to the designated integration.
Select Yes in the Export Catalog Products to integration automatically dropdown, and you will see the following settings:
Integration - here, select the integration.
Price Type - here, select the price type of the product that should be used when exporting.
Export Interval (hrs) - here, set the time interval. The minimum interval is 2 hours, and the maximum is 24 hours.
Project Automation (SI to Integration)
The Project automation settings allow you to specify when to export projects to one or more integrations.
Export on check-in
Select the Export to these integrations on check-in (regardless of project status) checkbox and select the integration to export projects every time they are checked in. Projects are overwritten each time they are exported.
Export only if status changes
This setting is selected by default. In the table below, you can choose to export projects when a specific status is set.
With both options, you can choose whether to export the data every time the project is checked in or only when the status changes from one status to the selected status.
In the following screenshot, projects are exported to the Power BI integration only when the project status changes to Proposal Presented.
Project Change Order Automation (SI to Integration)
The Project Change Order automation settings enable you to specify the integration to which a change order should be exported when the change order is in the Pending status and when the status of a change order changes as follows:
Pending change order is marked as approved
Pending change order is marked as rejected
Approved change order is marked as pending
Rejected change order is marked as pending
Select the relevant checkboxes and select the integration.
Task Automation (SI to Integration)
The Task automation settings allow you to specify when to export tasks to one or more integrations.
Export on save
Select the Export to these integrations on save (regardless of task status) checkbox and select the integration to export tasks every time they are saved. Tasks are overwritten each time they are exported.
Export only if status changes
This setting is selected by default. In the table below, you can choose to export tasks when a specific status is set.
With both options, you can choose whether to export the task when it is saved or only when its status is changed from one status to the selected status.
In the following screenshot, tasks are exported to the Excel integration when it is saved.
Service Order Automation (SI to Integration)
The Service Order automation settings allow you to specify when to export service orders to one or more integrations.
Export on save
Select the Export to these integrations on save (regardless of service order status) checkbox and select the integration to export service orders every time they are saved. Service orders are overwritten each time they are exported.
Export only if status changes
This setting is selected by default. In the table below, you can choose to export service orders when a specific status is set.
With both options, you can choose whether to export the service order when it is saved or only when its status is changed from one status to the selected status.
In the following screenshot, service orders are exported to the Excel integration only when their status is changed to Completed.
Service Plan Automation (SI to Integration)
The Service Plan automation settings allow you to specify when to export service plans to one or more integrations.
Export on save
Select the Export to these integrations on save (regardless of service plan status) checkbox and select the integration to export service plans every time they are saved. Service plans are overwritten each time they are exported.
Export only if status changes
This setting is selected by default. In the table below, you can choose to export service plans when a specific status is set.
With both options, you can choose whether to export the service plan when it is saved or only when its status is changed from one status to the selected status.
In the following screenshot, service plans are exported to the Power BI integration only when their status changes to Approved.
Purchase Order Automation (SI to Integration)
The Purchase Order automation settings allow you to specify when to export purchase orders to one or more integrations.
Export on save
Select the Export to these integrations on save (regardless of purchase order status) checkbox and select the integration to export purchase orders every time they are saved. Purchase orders are overwritten each time they are exported.
Export only if status changes
This setting is selected by default. In the table below, you can choose to export purchase orders when a specific status is set.
With both options, you can choose whether to export the purchase order when it is saved or only when its status is changed from one status to the selected status.
In the following screenshot, purchase orders are exported to the Excel integration only when their status changes to Issued.
Time Sheet Automation (SI to Integration)
The Time Sheet automation settings enable you to specify the integration to which a timesheet should be exported when it is approved and saved.
Select the Approve Time Sheet checkbox and the Save Time Sheet checkbox, and select the integration.
If you have any questions, please feel free to reach out to our support by sending an email to api@d-toolshelp.com.