Versions Compared

Version Old Version 2 New Version Current
Changes made by

Documentation Reviewer

Kimberly Onnen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Active Dynamics Companies list includes all active Dynamics companies that may or may not have Signature and/or Schedule installed.
Excerpt

The XOi Integration Setup in Schedule is used by XOi Technologies to access a specific API that is used by XOi for the Deep Linking workflow feature. This information must be provided to XOi. (A Schedule Administrator can print the contents of this window from a browser.) The XOi Integration Setup section is conditionally enabled if the See feature is registered for MobileTech, otherwise this tab is hidden. After setting up the integration, two XOi user roles are created and are hidden from the User Roles window. The XOi user is hidden from the User Detail window.

XOi Deep Linking is:

  • Compatible with MobileTech v8 and higher.
  • Available for supported versions of Signature 2016 and Signature 2018.
  • Enabled in Schedule 4.5 and higher.
Note
titleIMPORTANT

XOi Deep Linking must be first be enabled in MobileTech Admin. See XOi Integration in the MobileTech 8.0 Installation & Administration Guide for more information.

To set up the XOi Integration in Schedule:

  1. In Schedule, select the menu Image Removed icon and then select Administration.
  2. Select the Integrations tab.
  3. Under Account Detail:
    • User Name
      Displays the user name for the XOi integration.
    • Password
      Enter the XOi password.
    • Confirm Password
      Enter your XOi password again. If you've mistyped the password, an error message displays that the passwords don't match.
  4. Under Integration Details, complete the following fields:
    • API URL
      Displays the Schedule API URL. 
    • Signature Version
      Displays the current Signature major version.

  5. In the Active Dynamics Companies section, all active companies' details (Company Name and Company ID) are shown as more than one company may need to be set up with XOi Technologies.

Note

Overview

With XOi Deep Linking turned on and XOi integration set up in Schedule, this is what you can expect to happen with Schedule service appointments. In XOi's Vision app, a job is the same as a service appointment in MobileTech.

  1. A new service call with an appointment is created in Schedule, Signature, or MobileTech. The appointment is assigned to a technician and scheduled.

    NoteIf the service appointment is created in MobileTech, the technician will need to sync their device to send the appointment to the back office. The XOi integration will run and the notes will be added to the appointment in the back office and will be available when the technician syncs again, however, it could take a while for the XOi Vision notes to be created (based on the XOi polling cycle, syncing of data, etc.).
  2. XOi polls for new appointments that are scheduled and assigned or completed for technicians whose email addresses are also valid XOi Vision email addresses. 
  3. In XOi Vision, the job is created automatically based on the service appointment in Service Management. 
  4. The Schedule API creates several read-only notes that are attached to the service appointment. 
    • XOi Site History
      This internal note contains the hyperlink to the Job Activity in the Vision app. This note is required to display the XOi Site History field on the service appointment.
    • XOi Workflow
      This internal note contains the hyperlink to the job. This note is required to display the XOi Workflow field on the service appointment.
    • XOi Resolution
      This note contains the URL to view any related photos and/or videos on the Vision website and is included in the Call (or Appointment) Summary report.

    • XOi Transcript 
      This note contains Vision's video transcription.

      note

      This note is generated after the Vision platform processes the audio, which may be hours after the appointment is completed, so the XOi Video Transcription note will not be included on the Appointment Summary report. There may be up to three XOi Transcript notes, named XOi Transcript, XOi Transcript 2, and XOi Transcript 3.