Inter Application Exchange (Overview)
Serhii Toropov avatar
Written by Serhii Toropov
Updated over a week ago

Inter Application Exchange is used for copying inspections and work orders from one Back Office application to another.

Important! At the moment you can configure copying work orders only. 

Required Subscriptions

  • Features: InterApplicationExchange

For example, you can specify that work orders of a particular type created for a particular client and assigned to a particular technician in one Back Office application must be automatically copied to another Back Office application as work orders with a certain type, customer, and technician.

Note The Back Office application to which inspections and work orders are copied is called Inviting Application, while the Back Office from which inspections and work orders are copied is called Accepting Application. The same Back Office application can be Inviting for one application and Accepting for another application. 

On the Inter Application Exchange Configuration page you can see the following tabs:

  • Registration

  • Sending

  • Receiving

  • Log

Registration

On the 'Registration' tab you can generate and accept registration codes, as well as view, edit, and delete registrations.

  • To generate a registration code and create a new registration, in the Inviting Application, click Generate on the toolbar.

  • To accept registration code, copy the code in the Reg.Code column of the new registration in the Inviting Application, and then in the Accepting Application, paste it into the Code box on the toolbar and click Accept.

  • To give registration a name (by default its name is the registration code), click (Edit) next to the appropriate registration, and then in the Application Exchange Registration dialog box, in the Link Name box, type the name that you want, and click OK.

  • To remove a registration, click (Delete) next to the appropriate registration, and then click OK in the confirmation message. 

Note When you generate a registration code, the new registration automatically appears in the Inviting Application. When you accept the registration code, the new registration automatically appears in the Accepting Application and becomes accepted in both Office applications.

Sending

On the Sending tab, you can create profiles with rules that specify what inspections and work orders must be copied to Inviting Application.

  • To create a new sending profile, click Add Profile below the appropriate registration, enter settings in the Profile Details dialog box, and then click Insert.

  • To edit a sending profile, click next to the appropriate profile, change settings in the Profile Details dialog box, and then click Update.

  • To delete a sending profile, click next to the appropriate profile, and then click OK in the confirmation message. 

  • To create a new rule for sending profile, click Add Rule below the sending profile, enter settings in the Filter Rule dialog box, and click Insert.

  • To edit a rule, click Edit next to the appropriate rule, change settings in the Filter Rule dialog box, and then click Update.

  • To delete a rule, click Delete next to the appropriate profile, and then click OK in the confirmation message.

  • To refresh the view, click Refresh next to the appropriate profile or rule.

In the Profile Details dialog box, you can enter the following settings:

  • Name

  • Document Type defines whether inspections or work orders must be copied.

  • Entity Type defines the type of inspections or work orders that must be copied.

  • Send From defines that inspections or work orders created earlier selected date must not be copied.

  • Active defines whether the profile is activated. The Active checkbox is available only if profile rules for the Client, Team, and Employee entities are created.

In the Filter Rule dialog box, you can enter the following settings:

  • Name

  • Entity Type allows selecting the type of entity to which the rule will be applied. 

  • Include All means that the rule will work for all entities of the given type.

  • Include Selected allows selecting particular entities for which the rule will work. 

  • Exclude Selected allows selecting particular entities for which the rule will not work.

Note If you create more than one rule for the same entity, and choose 'Exclude Selected' for one of the rules, selected entities will be excluded even if you choose 'Include All' for another rule. If you create more than one rule for the same entity, choose Include Selected for one of the rules and choose 'Include All' for another rule, all entities will be included even if they are not specified in the Include Selected rule. 

Receiving

On the Receiving tab, you can create receiving profiles with rules and map them to the appropriate sending profiles with rules in order to specify types, customers, assigned technicians,  etc. for inspections and work orders copied from Accepting Application.

  • To create a new receiving profile, click Add Profile below the appropriate registration, enter settings in the Profile Details dialog box, and then click Insert.

  • To edit a receiving profile, click Edit next to the appropriate profile, change settings in the Profile Details dialog box, and then click Update.

  • To delete a receiving profile, click Delete next to the appropriate profile, and then click OK in the confirmation message. 

  • To create a new rule for receiving profile, click Add Rule below the receiving profile, enter settings in the Filter Rule dialog box, and click Insert.

  • To edit a rule, click Edit next to the appropriate rule, change settings in the Filter Rule dialog box, and then click Update.

  • To delete a rule, click Edit next to the appropriate profile, and then click OK in the confirmation message.

  • To refresh the view, click Refresh next to the appropriate profile or rule.

 In the Profile Details dialog  box, you can enter the following settings:

  • Name

  • Sharing Profile defines the sharing profile to which the mapping profile will be linked.

  • Document Type defines whether inspections or work orders must be copied depending on the mapped sharing profile.

  • Entity Type defines the type to which inspections or work orders must be copied.

  • Receive After defines that inspections and work orders created earlier selected date must not be copied.

  • Default Client allows selecting a client to which copied inspections and work orders will be assigned by default. Note that you can select from wholesale clients only. 

  • Default Team allows selecting a team of employees to which services of copied inspections and work orders will be assigned by default. 

  • Default Employee allows selecting an employee to which services of copied inspections and work orders will be assigned by default. Note that you can select an employee that belongs to the default team. 

  • Default Service allows selecting a service that will be shown by default instead of services from copied inspections and work orders. Note that you can select a service that belongs to service package of selected entity type (including bundle service items, but excluding services with the Percentage, Parts, and Fee Bundle types).

  • Active defines whether the profile is activated. The Active checkbox is available only if default client, team, and employee are selected or profile rules for the Client, Team, and Employee entities are created.

In the Receiving Rule dialog  box, you can enter the following settings:

  • Name

  • Entity Type allows selecting the type of entity to which the rule will be applied and particular entities of the given type to which sharing entities will be mapped.

Log

On the Log tab, you can check if there were any issues with copying inspections and work orders from one Back Office application to another.

  • To find particular logs, enter the appropriate filter settings, and then click Search

Note If inspections or work orders are not successfully copied, notifications are also sent by email to Back Office users with the Administrator role. Once the issue is fixed and inspections or work orders are successfully copied, the appropriate records on the Log tab are automatically updated.

Did this answer your question?