Understanding a Vocera Voice Group Sync Adapter Configuration |
The minimum requirements for a Vocera Voice Group Sync Adapter installation are described here.
This adapter requires Vocera Voice Server version 4.4.3 or greater. This adapter also requires a Vocera Platform version of 6.1 or higher.
Use the following ports. Refer to Configuring a Vocera Voice Group Sync Adapter for details.
Port | Port Use |
---|---|
80 | By default, port 80 is used to communicate real time updates of assignment information. |
443 | Used when port 80 is assigned to SSL for the adapter. |
5251 | Used to communicate VMI data (polls, and importing groups and or users. |
An adapter defines a default Dataset structure in order to function. Attributes are organized by Datasets and store the information required by the adapter. Adapters use this data during the process of receiving and sending messages.
Not all adapters require Datasets to function. When an adapter does require Datasets, the system will determine if they already exist. If they do not exist, the system will create the needed Datasets.
When creating or editing an adapter, use the following information to select the appropriate datasets in the Required Datasets section.
ACTORS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Link | contact_details | actor | False | True | N/A | One-to-many | The ACTORS Dataset is linked to the CONTACT_DETAILS Dataset, and the link order is 1:n (one actor associated to many contact_details) |
Link | groups | actor | False | True | N/A | One-to-many | The ACTORS Dataset is linked to the GROUP_MEMBERS Dataset, and the link order is 1:n (one actor associated to many group_members) |
Link | voice_profile | owner | False | True | N/A | One-to-one | The ACTORS Dataset is linked to the USER_VOICE_PROFILES Dataset, and the link order is 1:1 (one actor associated to one user_voice_profile) |
CONTACT_DETAILS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | detail_type | N/A | True | N/A | N/A | String | Attribute that stores the type of the contact detail, such as phone or email. |
Attribute | value | N/A | False | N/A | False | String | Attribute that stores the value of the contact detail. |
Link | actor | contact_details | True | False | N/A | Many-to-one | The CONTACT_DETAILS Dataset is linked to the ACTORS Dataset, and the link order is n:1 (many contact_details associated to one actor) |
FACILITIES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the unique name for the facility. |
Link | groups | facility | False | True | N/A | One-to-many | The FACILITIES Dataset is linked to the GROUPS Dataset, and the link order is 1:n (one facility associated to many groups) |
GROUPS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the name of the group. |
Link | facility | groups | True | False | N/A | Many-to-one | The GROUPS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many groups associated to one facility) |
Link | members | group | False | True | N/A | One-to-many | The GROUPS Dataset is linked to the GROUP_MEMBERS Dataset, and the link order is 1:n (one group associated to many group_members) |
Link | target | group | False | False | N/A | One-to-one | The GROUPS Dataset is linked to the TARGET_GROUPS Dataset, and the link order is 1:1 (one group associated to one target_group) |
GROUP_MEMBERS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Link | actor | groups | True | False | N/A | Many-to-one | The GROUP_MEMBERS Dataset is linked to the ACTORS Dataset, and the link order is n:1 (many group_members associated to one actor) |
Link | group | members | True | False | N/A | Many-to-one | The GROUP_MEMBERS Dataset is linked to the GROUPS Dataset, and the link order is n:1 (many group_members associated to one group) |
TARGET_GROUPS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | number | N/A | True | N/A | N/A | String | Attribute that stores the number of the recipient. |
Link | group | target | False | False | N/A | One-to-one | The TARGET_GROUPS Dataset is linked to the GROUPS Dataset, and the link order is 1:1 (one target_group associated to one group) |
USERS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | login | N/A | True | N/A | N/A | String | Attribute that stores the login name of the user. |
Attribute | first_name | N/A | False | N/A | False | String | Attribute that stores the first name of the user. |
Attribute | last_name | N/A | False | N/A | False | String | Attribute that stores the last name of the user. |
USER_VOICE_PROFILES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | forwarding_enabled | N/A | False | N/A | False | Boolean | Attribute that stores whether or not call forwarding is enabled. |
Attribute | forwarding_number | N/A | False | N/A | False | String | Attribute that stores the forwarding number for the user voice profile. |
Attribute | forwarding_type | N/A | False | N/A | False | String | Attribute that stores the type of forwarding for the user voice profile. |
Attribute | forwarding_when | N/A | False | N/A | False | String | Attribute that stores the calls that should be forwarded. Possible values are All, Unanswered, and Offline. |
Link | owner | voice_profile | True | False | N/A | One-to-one | The USER_VOICE_PROFILES Dataset is linked to the ACTORS Dataset, and the link order is 1:1 (one user_voice_profile associated to one actor) |