ClearTouch Integration

ClearTouch requires a different "token" (password) for every combination of alert and site. This means it doesn't work well with variables and creates more manual work to set up and test.

If you have 5 sites and 4 alert types (e.g. evacuated, hold, lockdown, shelter, etc), that means creating and testing up to 45 integrations:

• 4 integrations (for each alert type) times 2 (if you also want a drill equivalent of each alert type)
• times 5 sites
• plus 5 resolutions (one for each site)

1. In ClearTouch, gather the details.

   1. On the dashboard, choose Alert (in header).

      

   2. Chose a group (that corresponds with a site).
   3. Optionally select an alert sound and alert image.
   4. Choose API generator.

   5. Open the downloaded file in a text editor.

      

   6. In the first item, "header" section, note the value for the x-open-app-key ("1" in the screenshot above) and the value for the x-open-token ("2" in the screenshot above).
   7. In the "body" section, copy the value for raw ("3" in the screenshot above).
      1. Find and replace all the backslash-quotes (\") with quotes only (").
      2. Copy your updated value (the version without the backslash-quotes).
      3. Wait to paste this into CatapultEMS' "Content of Payload" (instructions below).
2. In CatapultEMS, create a new integration for initiating alerts.
   1. Name: Displays (ClearTouch), SITE_NAME (Replace SITE_NAME with the school/site you exported from ClearTouch.)
   2. Bearer Token: x-open-app-key:APP_KEY_VALUE|x-open-token:TOKEN_VALUE (Replace APP_KEY_VALUE and TOKEN_VALUE with the values you got from "header" above.)
   3. Payload URL: https://open.ifpserver.com/dms/api/v1/sendAlert
   4. Content of Payload (Copy from the body that you updated to not have backslash-quotes.)
   5. Event Trigger
      1. Initiate Action Alert
      2. Initiate Drill (If you want a different alert image/sound for drills, you need to create a separate integration for drill instead of selecting both here. The advantage of grouping drill and Action Alerts, is that it ensures your drills test the integration used for the real action alert. The disadvantage is it isn't clear from looking at the ClearTouch screen whether it is real or a drill.)
   6. Action Types: select the alert type you exported from ClearTouch.
3. Repeat the first two steps for each alert type at the current site.
4. Return to the text file from step 1 above (for a text file from the current site).
   1. Scroll down to the item named "Cancel Alert to Groups". Under that "header" section, note the value for the x-open-app-key and the value for the x-open-token.
   2. In the "body" section, copy the value for raw.
      1. Find and replace all the backslash-quotes (\") with quotes only (").
      2. Copy your updated value (the version without the backslash-quotes).
      3. Wait to paste this into CatapultEMS' "Content of Payload" (instructions below).
5. In CatapultEMS create an additional integration for clearing the ClearTouch screens after an alert resolves. The payload is the same for all alert types, so you only need one resolve integration per site.
   1. Name: Displays (ClearTouch), Resolve - SITE_NAME
   2. Bearer Token: x-open-app-key:APP_KEY_VALUE|x-open-token:TOKEN_VALUE (Ask Cleartouch to fill in the secret key)
   3. Payload URL: https://open.ifpserver.com/dms/api/v1/cancelAlert
   4. Content of Payload (Copy from the body that you updated to not have backslash-quotes.)
   5. Event Trigger:
      1. Resolve Action Alert
      2. Resolve Drill
   6. Action Types: Select all (or match the ones you selected for the initiation integration).
6. Repeat all the previous steps for each site.

Old, experimental method for gathering details from ClearTouch

1. In ClearTouch, gather the following details
   1. On the dashboard, look for the Organization Code. Copy and paste into the payload on the CatapultEMS side. It should replace the 0000 after “code”:
   2. In the left pane, choose Devices > Device groups.
      1. In the main pane, drop down menu, choose the device group you want. Copy the number from the end of the URL and paste into CatapultEMS under the MAPPED_SITE_ID section. Repeat for each site.
2. In CatapultEMS, create a new integration for initiating alerts.
   1. Name: Displays (ClearTouch), Initiate FILL_IN_NAME_OF_ALERT
   2. Bearer Token: x-open-app-key:FILL_IN_KEY|x-open-token:FILL_IN_X_OPEN_TOKEN (ask ClearTouch to fill in the key)
   3. Payload URL: https://open.ifpserver.com/dms/api/v1/sendAlert

   4. Content of Payload (copy from the body that you updated to not have backslash-quotes:

      {

      "code": "00000",

      "groupIds": ["$$MAPPED_SITE_ID$$"],

      "url":

      "https://www.catapultems.com/downloads/cleartouch/$$ACTION_TYPE$$.jpg",

      "md5": "$$MAPPED_ACTION_TYPE_ID$$"

      }

   5. Event Trigger:
      1. Initiate Action Alert
      2. Initiate Drill
   6. Action Types: Select all (unless you want fewer). 
   7. Fill in the $$MAPPED_ACTION_TYPE_ID$$ with the md5 codes for each image. 
3. In CatapultEMS create a second integration for resolving the alerts.
   1. Name: Displays (ClearTouch), Resolve
   2. Bearer Token: x-open-app-key:FILL_IN_KEY|x-open-token:FILL_IN_TOKEN (Ask Cleartouch to fill in the secret key)
   3. Payload URL: https://open.ifpserver.com/dms/api/v1/cancelAlert

   4. Content of Payload:

      {

      "code": "00000",

      "groupIds": ["$$MAPPED_SITE_ID$$"]

      }

   5. Event Trigger:
      1. Resolve Action Alert
      2. Resolve Drill
   6. Action Types: Select all (or match the ones you selected for the initiation integration). 
   7. Fill in the MAPPED_SITE_ID section with the same values you specified for the initiation.