Versions Compared

Old Version 9

changes.mady.by.user Simon Barlow

Saved on

compared with

New Version 10

changes.mady.by.user Elliot Dooleysmith

Saved on

Key

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

This integration was added in v1.4, check out the full release notes for this version here v1.4, v1.4HF1 - July 2019.

...

  • EMS Platform Services API version 44.1.19000.180 or higher. To check your version navigate to your Platform Services status URL e.g. http(s)://<servername>/EmsPlatform/status

  • An EMS Platform Services Integration Account, see the below Integration Account Configuration section for the account requirements

  • Access to the EMS Desktop Client and EMS SQL database

Expand
titleIntegration Account Configuration

An integration account is required to enable authentication and two way communication between ResourceXpress and EMS Platform Services. To create the integration account:

  • Log into the Platform Services admin page e.g. http(s)://<servername>/EmsPlatform/admin

  • Click Integrations from the left pane.

  • Click New Integration Client

Image Modified

  • Populate the required fields per the below

Name

<Enter a suitable name>

Type

Partner

Role

All Routes

Audience

Client Audience

Active

Yes

Enable Logging

No

Allow this client to book without Everyday User Templates and Ignore Booking Rules

Yes

Everyday User Authentication Required

No

User Authentication is Persistent

No

Everyday User Authentication Method

EMS Native

  • Click Save Changes

A client secret will now be generated and shown at the top of the page. Copy the newly created Client ID and Client Secret for later use.

Note

Once you close this page the client secret will not be viewable and cannot be retrieved.

Expand
titleResourceXpress System Settings

Once the Platform Services Integration Account has been created you can configure the integration details in ResourceXpress.

  • Navigate to Administration Settings - System Settings - Resource Server and populate the fields per the below

Server Host Name

Note

The URL entered here is case sensitive and should be entered in the exact format shown on the right including the last '/'

Enter your Platform Services URL in the format

http(s)://<servername>/EmsPlatform/api/v1/

Server Port

80 or 443

Resource Login User ID

Enter the Integration Account Client ID

Resource Login Password

Enter the Integration Account Client Secret

Resource Login Domain

Enter your company domain

  • Click Save

Expand
titleConfiguring Resource Profiles

Each resource profile in ResourceXpress is linked to a resource profile in EMS. Before configuring ResourceXpress you should have the EMS profiles already created.

For each profile in EMS you will need the individual ID number assigned during creation, to retrieve this ID number

  • Open the EMS Desktop Client

  • Navigate to Configuration - Facilities - Rooms

  • Open the properties of the profile you are adding to ResourceXpress and navigate to the Audit tab, make a note of the ID number shown at the bottom of this view

Image Modified

  • In ResourceXpress navigate to Administration Settings - Resource List and click +Create

  • Populate to below fields in the Resource Info tab

Resource Name

Enter the EMS ID number from the Desktop Client

Resource Name - Display

Enter the name you want to appear on the room panel/desk device

  • Ensure the Booking System type is set to EMS in the Connection Properties tab

Info

To configure the remaining Resource profile settings please refer to Create and Edit Resource Display Profiles

Expand
titleEMS User Authentication

ResourceXpress can utilise existing EMS user (group) accounts for device-level authentication via the Platform Services API.

To enable this feature navigate to Administration Settings - System Settings - User Authentication in the ResourceXpress admin console and select one of the below two options for the Authentication Protocol

  1. Use Resource Profile Settings - This option will utilize the Platform Services API settings specified in the Global Resource Credentials section under System Settings - Resource Server

  2. Use EMS Settings defined below - This option allows you to specify a different Platform Services URL and client credentials if required for example if the EMS user accounts are hosted in a different EMS instance than the resource profiles

Info

Once you have configured the User Authentication settings you can enable device-level authentication. For further information please see Interactive Tab

There are two values in the EMS group record used for User Authentication at the devices. By default the field used for Access (PIN) Code is Personnel Number and the field used for RFID is Badge Number