Devices

About

Devices are used to send tickets out of UtiliSphere to an external location.  

  1. On the top menu bar, click System Management ( ) > Administration > General > Devices
  2. On the Device Overview page, click Go to Fax Device Summary
  3. On the Fax Device Summary page, click Add a Fax Device
  4. On the Add a Fax Device page, fill in the fields. See Modify a Fax Device, step 3, below

 

  1. On the Fax Device Summary page, in the Name column, click the fax device
  2. On the Fax Device Detail page, click Modify this Device

  3. On the Modify a Fax Device page, fill in the fields:

     

    Field Description
    Name The name of the device
    Phone Number The phone number of the device used to receive the fax

     

     

    Field Description
    Max Count The number of tickets in the queue that causes them to be sent. For example, a max count of 10 means that every time the number of tickets in the queue reaches 10, they are sent
    Max Retry If the system's attempt to send tickets fails, this setting determines how many times the system will retry sending them. Attempts to send are recorded in System Management ( ) > Administration > Communication > Transmission > Transmission History
    Max Time (min)

    The interval (in minutes) at which the system sends the tickets in the queue

    The number of minutes since the last time the system sent the tickets in the queue that causes them to be sent to the device
    Queue The system places tickets in the queue. If Send is not checked, tickets are placed in the queue but are not sent
    Send The system sends the tickets in the Queue as specified in the Max Count, Max Retry, and Max Time settings. If Queue is not checked, the system sends any tickets in the queue, but no more are placed in the queue
    Use Flush Time Flush Time sends all tickets in the queue at the specified flush time regardless of the Max Count and Max Time settings

     

     

    Field Description
    Port Speed The speed of the device (Baud rate)

     

     

    Field Description
    Fixed The system sends a fixed number of tickets from the queue each time. Use if the fax device you are sending to has limits on the number of faxes it can receive per connection
    Infinite The system sends all tickets in the queue

     

     

  4. Click Save

 

 

  1. On the Fax Device Summary page, click View Fax Header Settings
  2. On the Fax Header Settings page, click Modify these Settings

  3. On the Modify Fax Header Settings page, fill in the fields:

    Field Description
    Preferred Company Name The name of the company that sends faxes using the fax device
    Fax Header Number Fax number of the fax device used to send the fax

    Both of the above are stored in the system with the company (Nick)

  4. Click Save

 

A web request device is a system, web site, or a piece of technical infrastructure (web service, API, endpoint, webhook, etc.) that receives data from your Irth system.

  1. On the top menu bar, click System Management ( ) > Administration > General > Devices
  2. On the Device Overview page, click Go to Web Request Device Summary
  3. On the Web Request Device Summary page, click Add a Web Request Device
  4. On the Add a Web Request Device page, fill in the fields. See Modify a Web Request Device, step 3, below

 

  1. On the Web Request Device Summary page, in the Name column, click the web request device
  2. On the Web Request Device Detail page, click Modify this Device

  3. On the Modify a Web Request Device page, fill in the fields:

     

    Field Description
    Name The name of the device
    Protocol

    IRTHNet Ticket: Use to send tickets in one of the ticket formats below

    Webhook: Use to allow web request device to send data automatically from the system
    Format The standard format for the Webhook protocol is JSON. Message templates with an item type of "All Forms" automatically appear as formats and can be used to send PDF files
    Ticket Format

    These are the standard ticket formats used by the IRTHNet Ticket protocol. You may also see custom ticket formats that only your company uses. See your company administrator for more information

    • Irthnet Historical Responsibility
    • Irthnet Standard
    • Irthnet SuperStandard
    • Irthnet Ticket
    • Smart Score Update
    • Ticket Score
    URL The URL of the web request device

     

     

    Field Description
    Attachments Attachments sent with template
    Attachments Inline Attached files put into email/PDF of the template (not attached as separate files)
    History Audit history sent with template
    Related Items Related items sent with template
    Related Items Inline Related items put into email/PDF of the template (not attached as separate files)

     

     

    Field Description
    Secret Authentication information that the system puts in the header of requests sent to another API

     

     

    Field Description
    Max Count The number of tickets in the queue that causes them to be sent. For example, a max count of 10 means that every time the number of tickets in the queue reaches 10, they are sent
    Max Retry If the system's attempt to send tickets fails, this setting determines how many times the system will retry sending them. Attempts to send are recorded in System Management ( ) > Administration > Communication > Transmission > Transmission History
    Max Time (min)

    The interval (in minutes) at which the system sends the tickets in the queue

    The number of minutes since the last time the system sent the tickets in the queue that causes them to be sent to the device
    Queue The system places tickets in the queue. If Send is not checked, tickets are placed in the queue but are not sent
    Send The system sends the tickets in the Queue as specified in the Max Count, Max Retry, and Max Time settings. If Queue is not checked, the system sends any tickets in the queue, but no more are placed in the queue
    Use Flush Time Flush Time sends all tickets in the queue at the specified flush time regardless of the Max Count and Max Time settings

     

     

    Field Description
    Fixed The system sends a fixed number of tickets from the queue each time. Use if the device you are sending to has limits on the number of tickets or data it can receive per connection
    Infinite The system sends all tickets in the queue

     

  4. Click Save

 

 

An alert notification must be set up and configured to send to a device. For an overview of notifications, see Alert Notifications.

A ticket notification can be set up for web request devices. For details, see Ticket Notifications.