[Index]

Model: relation/HcsSiteREL

Sites

Full HTML Help

This procedure creates a site.

Note

  1. Log in as Provider, Reseller, or Customer administrator.
  2. Set the hierarchy to the Customer for whom you are creating the site.
  3. Go to (default menus) Site Management > Sites to open the Sites page.
  4. Click Add, then fill out the following fields:
Option Description
Site Name

The name of the site. This field is mandatory.

Note:

Any spaces in the site name are converted to underscores in the site local administrator name and email, if the Create Local Admin check box is selected.

You cannot migrate a customer location to a site if the customer for the site is different than the customer associated with the customer location.

When migrating a customer location to a site, an NDL is not selected for the site. You can set the NDL for the site later.

Note (Provider deployments): A customer location that has been configured in HCM-F and synced into VOSS Automate may exist at the sys.hcs hierarchy. If the Site Name you enter matches this customer location, the Migrate from HCM-F to VOSS Automate check box is displayed. Click Save to migrate this customer location to a site at the current hierarchy level. The fields are populated with the values that were configured in HCM-F. If you do not want to migrate the customer location, enter a different Site Name.
Description A description for the site
Extended Name

Provider deployments.

External clients can use the Extended Name of the site if needed. This field is not used by other components within Cisco HCS.

Note:

This field exists in the Customer Location record in SDR. When the customer is managed by Cisco Unified Communications Domain Manager 8.1(x), the Extended Name is synced from Cisco Unified Communications Domain Manager 8.1(x) to the Customer Location record in SDR. When the customer is managed by VOSS Automate, the Extended Name is synced from VOSS Automate to the Customer Location record in SDR.
External ID

Provider deployments.

External clients can use the External ID of the site if needed. This field is not used by other components within Cisco HCS.
Create Local Admin Controls whether a default local administrator is created for the site.
Option Description
Cloned Admin Role The customer role used to create a new role prefixed with the site name. The created site role, shown in the Default Admin Role field, is assigned to the default local administrator user. This field appears only if the Create Local Admin check box is selected.
Default Admin Role The created site role that is assigned to the default local administrator. This field is read-only and appears only if the Create Local Admin check box is selected.
Default Admin Password The password to assign to the default local administrator. This field appears only if the Create Local Admin check box is selected.
Repeat Default Admin Password Confirm the default local administrator password. This field appears only if the Create Local Admin check box is selected.
Country The country is used to determine which dial plan to download to the site when the dial plan is configured on the site. This field is mandatory.
Network Device List Choose the NDL containing the UC applications and WebEx to be used by the site. Once an NDL has been set for the site, it cannot be removed from the site, nor can the NDL be changed to another NDL.
Auto Push Users to CUCM

If enabled, users are automatically pushed to the Cisco Unified Communications Manager that is associated with the NDL. The default is disabled. Note: You can edit the site later, and select this check box for one of the following reasons:

  • To automatically push users at the site to the Cisco Unified Communications Manager. User surname must be filled in.
  • To perform an Auto User Push when an NDL is added to the site.
  • To perform an Auto User Push when a Cisco Unified Communications Manager is associated with an NDL.

Only users with user type "End User" are pushed to the Cisco Unified Communications Manager.
  1. Click Save.

Add Custom Fields to Site Configuration Screens

VOSS Automate allows you to add up to ten custom string fields and up to 10 custom boolean fields to the field display policy you apply to the Site model (relation/HcsSiteREL). This provides flexibility to add additional details for a site, if required.

The summary attributes in the Sites list view always display three Boolean fields and three String fields, regardless whether they've been included in the FDP. If you wish to change the title of these fields in the summary attributes you can add a field override entry in the FDP.

When configuring a site (add or update), you may specify field values or use named macros to populate values for these fields.

Macros for custom string fields for relation/HcsSiteREL:

Macros for custom boolean fields for relation/HcsSiteREL:

The macros can be applied in workflows and configuration templates to reference the custom field values. For example, executing macro.BaseSiteDAT_custom_string_9 will return the value in the field where the macro is used.

To expose custom fields for relation/HcsSiteREL

  1. Log in to VOSS Automate as Provider admin or higher.

  2. Create or update the Customers data model field display policy:

  3. Update the menu layout to apply the field display policy:

  4. Log out, then log in again as Provider admin.

    This allows the role-based access profile changes to refresh so that you can view the updated menu layouts and field display policies you applied, including new custom fields.

Sites

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Note

  1. Log in as provider, reseller, or customer administrator.
  2. Make sure that the hierarchy is set to the customer for whom you are creating the site.
  3. On the Sites form (default menu Site Management > Sites), click Add.
  4. Complete the following fields:
Option Description
Site Name

The name of the site. This field is mandatory.

Note:

Any spaces in the site name are converted to underscores in the site local administrator name and email, if the Create Local Admin check box is selected.

Note: A customer location that has been configured in HCM-F and synced into VOSS Automate may exist at the sys.hcs hierarchy. If the Site Name you enter matches this customer location, the Migrate from HCM-F to VOSS Automate check box is displayed. Click Save to migrate this customer location to a site at the current hierarchy level. The fields are populated with the values that were configured in HCM-F. If you do not want to migrate the customer location, enter a different Site Name.

You cannot migrate a customer location to a site if the customer for the site is different than the customer associated with the customer location.

When migrating a customer location to a site, an NDL is not selected for the site. You can set the NDL for the site later.
Description A description for the site.
Extended Name

External clients can use the Extended Name of the site if needed. This field is not used by other components within Cisco HCS.

Note:

This field exists in the Customer Location record in SDR. When the customer is managed by Cisco Unified Communications Domain Manager 8.1(x), the Extended Name is synced from Cisco Unified Communications Domain Manager 8.1(x) to the Customer Location record in SDR. When the customer is managed by VOSS Automate, the Extended Name is synced from VOSS Automate to the Customer Location record in SDR.
External ID External clients can use the External ID of the site if needed. This field is not used by other components within Cisco HCS.
Create Local Admin Controls whether a default local administrator is created for the site.
Option Description
Cloned Admin Role The customer role used to create a new role prefixed with the site name. The created site role, shown in the Default Admin Role field, is assigned to the default local administrator user. This field appears only if the Create Local Admin check box is selected.
Default Admin Role The created site role that is assigned to the default local administrator. This field is read-only and appears only if the Create Local Admin check box is selected.
Default Admin Password The password to assign to the default local administrator. This field appears only if the Create Local Admin check box is selected.
Repeat Default Admin Password Confirm the default local administrator password. This field appears only if the Create Local Admin check box is selected.
Country The country is used to determine which dial plan to download to the site when the dial plan is configured on the site. This field is mandatory.
Network Device List Choose the NDL containing the UC applications and WebEx to be used by the site. Once an NDL has been set for the site, it cannot be removed from the site, nor can the NDL be changed to another NDL.
Auto Push Users to CUCM

If enabled, users are automatically pushed to the Cisco Unified Communications Manager that is associated with the NDL. The default is disabled. Note: You can edit the site later, and select this check box for one of the following reasons:

  • To automatically push users at the site to the Cisco Unified Communications Manager. User surname must be filled in.
  • To perform an Auto User Push when an NDL is added to the site.
  • To perform an Auto User Push when a Cisco Unified Communications Manager is associated with an NDL.

Only users with user type "End User" are pushed to the Cisco Unified Communications Manager.
  1. Click Save.

Once saved, the following occurs:

Model Details: relation/HcsSiteREL

Title Description Details
Site Name *
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[\w\ -]+$
Site ID
  • Field Name: SiteID
  • Type: String
Description
  • Field Name: Description
  • Type: String
Network Device List Reference
  • Field Name: ndlr
  • Type: String
  • Target: /api/data/NetworkDeviceList/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24qyJx8rV5k4qJOIvK%24o3OZE/qLSDZrq7DWxMTSxRnYN95syLQfNlVMjGkvNom8qACcWbBkcRheK%2Bsghg4I4rnWXihkEvExPU%2BU1Osov4Fc2sU/mSgfGMNNXQeoKhYmFTyHej5HSPiXRKxuWw1ja9E5b9kwgacQfP48GykxmDJ2MkgS1xlpisDxXntDChVsaL1APgcolcHtQONh1S2FOuC8nwEucEck9i5V00DqUT7CmtmZvN95N58pSYrbpgqrl/Bw//bRYxoI0%2BU0LF22ohxyK0Z37gBIdKkRQWwin2W%2B4oGCFqS385vR5LaaqD7ikvo8KTG9p%2BicYYqpk8hy6ngT5Cj3xChENQtvxX9gNUgtbfA5uRTKPoftEUV09UCTnHcU%24%3D%3D
  • Target Model Type: data/NetworkDeviceList
  • Format: uri
  • Choices: []
Address 1
  • Field Name: Address1
  • Type: String
Address 2
  • Field Name: Address2
  • Type: String
Address 3
  • Field Name: Address3
  • Type: String
City
  • Field Name: City
  • Type: String
State
  • Field Name: State
  • Type: String
Postal Code
  • Field Name: PostalCode
  • Type: String
Extended Name
  • Field Name: ExtendedName
  • Type: String
External ID
  • Field Name: ExternalID
  • Type: String
Internal ID Default: "Auto-generated value"
  • Field Name: InternalSiteID
  • Type: String
  • Default: "Auto-generated value"
Country
  • Field Name: Country
  • Type: String
  • Target: /api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24PN3Gid0RBffRnFtp%24WG2FFxy7HiNSP8TS6/BJiOXf6nbv1NJAymPD1aUftdFujFrkQ8aCgRGYR6RbwUhw48oMsodJofoJU1C%2BZUqUCnZxZQkLERAHwMdpCHFgOYrP0bQ6BX7oIPapSsnD%2Bec8pZqrrVVrTWBBqt/e6cVb07dEwXX/MOKB/5o6wT1EcQoQ56qaSGz39J03j1CD%2BNwgMVe9S8zaCFKGJ%2BFJkVXrBljmsckTwJmaCj6Tz2kId0TaeU0ZKnL2j1yuDT8BBovOmCCeBH0QHOQUs7hIw6jMwii1u8iGzWytipXWb%2BupBsXC%2BTy/MsfYo7A279HswGXC8%2B1HOK0rUepxL4tMFSv6XrVrgMEKZj/zUI6urBk/sCQEDxXDYyW%2BDCEumGgK/4o%3D%24%3D%3D
  • Target attr: country_name
  • Target Model Type: data/Countries
  • Format: uri
  • Choices: []
CUCDM 8.x Location ID Location ID as used in CUCDM 8.x DialPlan
  • Field Name: CUCDM8xLocID
  • Type: String
CUCDM 8.x Routing Identifier(RID) Routing Identifier(RID) value as used in CUCDM 8.x DialPlan
  • Field Name: CUCDM8xRID
  • Type: String
custom_string_1
  • Field Name: custom_string_1
  • Type: String
custom_string_2
  • Field Name: custom_string_2
  • Type: String
custom_string_3
  • Field Name: custom_string_3
  • Type: String
custom_string_4
  • Field Name: custom_string_4
  • Type: String
custom_string_5
  • Field Name: custom_string_5
  • Type: String
custom_string_6
  • Field Name: custom_string_6
  • Type: String
custom_string_7
  • Field Name: custom_string_7
  • Type: String
custom_string_8
  • Field Name: custom_string_8
  • Type: String
custom_string_9
  • Field Name: custom_string_9
  • Type: String
custom_string_10
  • Field Name: custom_string_10
  • Type: String
custom_boolean_1
  • Field Name: custom_boolean_1
  • Type: Boolean
custom_boolean_2
  • Field Name: custom_boolean_2
  • Type: Boolean
custom_boolean_3
  • Field Name: custom_boolean_3
  • Type: Boolean
custom_boolean_4
  • Field Name: custom_boolean_4
  • Type: Boolean
custom_boolean_5
  • Field Name: custom_boolean_5
  • Type: Boolean
custom_boolean_6
  • Field Name: custom_boolean_6
  • Type: Boolean
custom_boolean_7
  • Field Name: custom_boolean_7
  • Type: Boolean
custom_boolean_8
  • Field Name: custom_boolean_8
  • Type: Boolean
custom_boolean_9
  • Field Name: custom_boolean_9
  • Type: Boolean
custom_boolean_10
  • Field Name: custom_boolean_10
  • Type: Boolean
Hcs Site
  • Field Name: hcsSite
  • Type: Object
streetAddress3
  • Field Name: hcsSite.streetAddress3
  • Type: ["String", "Null"]
streetAddress2
  • Field Name: hcsSite.streetAddress2
  • Type: ["String", "Null"]
streetAddress1
  • Field Name: hcsSite.streetAddress1
  • Type: ["String", "Null"]
isDefaultLocation
  • Field Name: hcsSite.isDefaultLocation
  • Type: ["Boolean", "Null"]
description
  • Field Name: hcsSite.description
  • Type: ["String", "Null"]
extendedName
  • Field Name: hcsSite.extendedName
  • Type: ["String", "Null"]
externalID
  • Field Name: hcsSite.externalID
  • Type: ["String", "Null"]
cdmUpdateTimestamp
  • Field Name: hcsSite.cdmUpdateTimestamp
  • Type: ["String", "Null"]
shortName *
  • Field Name: hcsSite.shortName
  • Type: String
bkCustomer_shortName
  • Field Name: hcsSite.bkCustomer_shortName
  • Type: ["String", "Null"]
id
  • Field Name: hcsSite.id
  • Type: ["String", "Null"]
isDeletable
  • Field Name: hcsSite.isDeletable
  • Type: ["Boolean", "Null"]
customer *
  • Field Name: hcsSite.customer
  • Type: String
  • Target: /api/device/hcmf/Customer/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24V4h8r6VM48ikMMwY%24RcDna6GH30ObnuqI7gFHQTvndmSZe2w9B1nla30JDzP8BOqrYLj6eXuuPxZOdCgLKOmczPk98clOdiIeopuTJhjLglx7qrr5ZtSVOYN4T8fpY6tmrxgFHn4yNULeqepWKXeGivQui0dT2tgIUmn7wbeGyAA5hTNHPfLHZpw8ACYAiDhc5zyrDbstxY%2BnqtPCA96RkY/UdQiOErst5WRUBONPn4ZKBHBPBtOkaq9uF9h%2BzDU0YAXr5b%2B3LgDkkD1M/sjuKdqfBoLt6pq2MO74/Y5vbEQDwW3LLmEwyzHxTaPV/22k%2BM4QjxOUIz6zAnFxSi22c54v2WWjuBDjSBCv6nrdyVc0dR%2BLnFjUdI3cjvw1gg%3D%3D%24%3D%3D
  • Target Model Type: device/hcmf/Customer
  • Format: uri
  • Choices: []
city
  • Field Name: hcsSite.city
  • Type: ["String", "Null"]
country
  • Field Name: hcsSite.country
  • Type: ["String", "Null"]
state
  • Field Name: hcsSite.state
  • Type: ["String", "Null"]
isModifiable
  • Field Name: hcsSite.isModifiable
  • Type: ["Boolean", "Null"]
siteLocationCode
  • Field Name: hcsSite.siteLocationCode
  • Type: ["String", "Null"]
postalCode
  • Field Name: hcsSite.postalCode
  • Type: ["String", "Null"]
type * Default: CustomerLocation
  • Field Name: hcsSite.type
  • Type: String
  • Default: CustomerLocation
syncTimestamp
  • Field Name: hcsSite.syncTimestamp
  • Type: ["String", "Null"]
Site Ndlr
  • Field Name: siteNdlr
  • Type: Object
Name *
  • Field Name: siteNdlr.name
  • Type: String
  • MaxLength: 1024
Reference
  • Field Name: siteNdlr.reference
  • Type: String
  • Target: /api/data/NetworkDeviceList/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24qyJx8rV5k4qJOIvK%24o3OZE/qLSDZrq7DWxMTSxRnYN95syLQfNlVMjGkvNom8qACcWbBkcRheK%2Bsghg4I4rnWXihkEvExPU%2BU1Osov4Fc2sU/mSgfGMNNXQeoKhYmFTyHej5HSPiXRKxuWw1ja9E5b9kwgacQfP48GykxmDJ2MkgS1xlpisDxXntDChVsaL1APgcolcHtQONh1S2FOuC8nwEucEck9i5V00DqUT7CmtmZvN95N58pSYrbpgqrl/Bw//bRYxoI0%2BU0LF22ohxyK0Z37gBIdKkRQWwin2W%2B4oGCFqS385vR5LaaqD7ikvo8KTG9p%2BicYYqpk8hy6ngT5Cj3xChENQtvxX9gNUgtbfA5uRTKPoftEUV09UCTnHcU%24%3D%3D
  • Target Model Type: data/NetworkDeviceList
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Data User
  • Field Name: data_user
  • Type: Object
Name
  • Field Name: data_user.name
  • Type: String
Password
  • Field Name: data_user.password
  • Type: String
  • Is Password: True
Hcs Role
  • Field Name: hcs_role
  • Type: Object
Name
  • Field Name: hcs_role.name
  • Type: String
Role * The role selector.
  • Field Name: hcs_role.clonedRole
  • Type: String
  • Choices: [" "]
Role * The role selector.
  • Field Name: hcs_role.role
  • Type: String
  • Choices: [" "]
Data User
  • Field Name: dataUser
  • Type: Object
User Name * User's Username.
  • Field Name: dataUser.username
  • Type: String
Email Address The User email address.
  • Field Name: dataUser.email
  • Type: String
First Name The User first name.
  • Field Name: dataUser.first_name
  • Type: String
Last Name The User last name.
  • Field Name: dataUser.last_name
  • Type: String
Password The User password.
  • Field Name: dataUser.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: dataUser.role
  • Type: String
  • Target: /api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24EknDWkzJz70YJdMc%24KZ6iCpmc6aM%2BjKW%2BP2VGeDm%2BjfBAtskQnF%2B5Sha8Z5l7NzwdJToaQmiPii45tTUkuLIwu6U4ZpL/y9y9fCCMRtubOWYikbMfav4aIxJ9LjyOzcaYZz1Ou/JDIyNPyTkDtVDJko%2BrCM/YcXtLN38FmbP8BwD7EN0hTRXEo6UwptCkAj3gHX21GDSJ3mOOr2Ln5DAyGWdJfGin3K2IRa733tGe0lPQQhO2fPLYqaC9f9dVn7QBaQJvDv9C337AKfCaIZUWvXJh9jXCEbmQkITwWbwCA%2BJbtawsqByHQOt%2BzNGIP%2BG8vKDd9WEdPlpMXZQWAQ4TatkbKfg/1CpOTwDXjkP5jXLAmAitHKoERsdXk0c4Rw%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Role
  • Format: uri
  • Choices: []
Language The preferred language for this user. Default: en-us
  • Field Name: dataUser.language
  • Type: String
  • Target: /api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24WuGzybSLeFKwlxk1%2487c990DzNErMO2AUMKdATGdYCvz26afIcx%2BBO9B5jPcRZmTP%2B8o534BaFA6lUvP%2BYo8CaHhUpTvU44dBWzU3FehfRborSmSqo9AetMtidzTS8x9t7SOYJlhPgXEjSgA4EFfyHoYAp5Y2xFH3J1RLlp2iii06SDAYi80RBJYgxFzqZdLRMa93X9LHYNCmTm%2BMLvQbeDdDFS3Oo7JUOnxOnkmVxnPdNm91HnuxbDTLlUt1NWvi/kJl7nuLdVziTOGmyycN3qNBgRXRn9grbUYYs6OvmE7d/KkSicUukFAMuTZPSzXw9d0lxQdymVJ%2BtxKga%2BLlzkH%2BzTVGabEsqTGP5m3cgubzA7ySbCw9EObWhJgSJFDT4U0%3D%24%3D%3D
  • Target attr: lcid
  • Target Model Type: data/Language
  • Default: en-us
  • Format: uri
  • Choices: []
Set by Default Language Indicate if the user's language is set by language default in the hierarchy.
  • Field Name: dataUser.set_language
  • Type: Boolean
Account Information Additional account information for the given user.
  • Field Name: account_information
  • Type: Object
Change Password on Next Login Indicates if the user must be forced to change their password the next time that login.
  • Field Name: dataUser.account_information.change_password_on_login
  • Type: Boolean
Locked Indicates if the account has been locked to prevent the user from logging in.
  • Field Name: dataUser.account_information.locked
  • Type: Boolean
Disabled Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.
  • Field Name: dataUser.account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: dataUser.account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: dataUser.account_information.credential_policy
  • Type: String
  • Target: /api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24NYEWPyXHxg0pTJeL%247eKXJNPeWu3tCaHlgj8z23L7XXIwvCEJ%2BnFVaSUF1badWI3rubKXk0CamJ74oBtSKWICiHZYv5F/RRQxbzki5fegxIq5b4nVzhs7Wm6RYlllj5FIZ00jL3mHeQCsHmFjS0iOHZsS35ERHNTn1IVjxnNwMwIomvCNVd859%2Bi1G4F98A7vdyYVP0oc4I4v5jaXFZK6atlwZry4w8x3Zo39eja4Om2QpsoRVbWPOJ0OoCyQT/Pvob1DgC4fnl0%2B6WWPpJHvOd6jgP1KJORj5lfnSPIJmAwPnU2bWUFXPN5YYm4SVY9Q4SMBYDQJveNN9NBG0JWRKkileCsRJ9JnsTqeu5YkvaQqfbUkJCqdQFS0QrMUngwHEERXz83Q9VWjoA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/CredentialPolicy
  • Format: uri
  • Choices: []
Time Locked Due to Failed Login Attempts The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.
  • Field Name: dataUser.account_information.failed_login_lock_date
  • Type: String
  • Format: date-time
Time of Last Password Change The time when the password was last changed.
  • Field Name: dataUser.account_information.password_last_change_time
  • Type: String
  • Format: date-time
Time of Last Password Change By User The time when the password was last changed by the user.
  • Field Name: dataUser.account_information.password_last_change_time_by_user
  • Type: String
  • Format: date-time
Time of Last Successful Login The time the user last logged in successfully.
  • Field Name: dataUser.account_information.last_login_time
  • Type: String
  • Format: date-time
Number of Failed Login Attempts Since Last Successful Login The total number of failed login attempts since last successful login. Default: 0
  • Field Name: dataUser.account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: dataUser.account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: dataUser.account_information.security_questions.[n].answer
  • Type: String
  • MaxLength: 128
Used Passwords List of passwords that have been used by user.
  • Field Name: used_passwords.[n]
  • Type: Array
Password Used password
  • Field Name: dataUser.account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: dataUser.account_information.used_passwords.[n].time_created
  • Type: String
Entitlement Profile
  • Field Name: dataUser.entitlement_profile
  • Type: String
  • Target: /api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24FchsQOyirBW6rqCp%24bRU7JxbeW3/AAnewC%2BVW%2BT9AdZwPBklBB1hvtBBX%2B1xvagDnrX78ljNidpBBMh0opmwWZHje7CG654u53fdXV8A2Ft7UdW9SCihP7vRNRXvFJQ2ZgW0RFHSlRwSBw5A00Ka0s2ibyRaYDcB3yN5%2BiFo/wNflekJy/jQbK2nJhHmb4QR3dprImyBrf5hbpqWfDWNvqpXm6bbborc0H%2B8GLKVkxvEKTVGbkmaZTd0BhCOKCK5C8zwgCWg/oxVKocGB4I/TuTwmaT9shrCkbyEVpqe3WtOksxPzQMURuLZ7Y2bv0PKB534Fh1GcI0S/g0Eunj1oFmnK66LTXbNWjBxtqzBDYy8qXORs99bgz0JmS2ipcfJjq4GyJ0XxpA%3D%3D%24%3D%3D
  • Target Model Type: data/HcsEntitlementProfileDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Sync Source Sync source of the user. Identifies where the user was synced from. This value will determine the master of the data. The data in the User model will be derived from the fields of the master application (E.G. CUCM, CUC, MS-LDAP). Default: LOCAL
  • Field Name: dataUser.sync_source
  • Type: String
  • Target: /api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24dWTM1qufKK6wnLJM%24fmYvgHFlhpwzr26CbNMOJ91B1irfijN7jRiOlmSfq82sb3xuSWS1v6fsI2yxU9ijV09d/BWVasIVe%2BytOD5JC3xyeS6Zd3OEYdlg58buogumwouncQYh5wg2QtR7n%2BzbTChPCRH0brQ9ZKKPfG1SDSYY/Qq4mI5qEj5vwnl5HAY0YLTqVLnlffojcqJs4BRChwu9dvtIsQiZOV2D5Zc6loyUkG4333g4o97u3bzB%2BSLFT%2BCxF5mxkz/35EbGMGXYKN5S6Us/U1a1V6Dgl01OHPLDMCv1ejKPEXom3XR3nSzcCCwrE6v/4ZWMeIspq/zLAGbPv%2B065NNEtelCwj8Vq8v8wKyyBabrQeloTHfEiJMYCF4SCmfFeu8R7pg%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/UserSyncSource
  • Default: LOCAL
  • Format: uri
  • Choices: []
Sync Type Sync type of the user. Identifies the user type that was synced from device as indicated by Sync Source information, e.g. CUCM-Local, CUCM-LDAP, LOCAL. Default: LOCAL
  • Field Name: dataUser.sync_type
  • Type: String
  • Default: LOCAL
Building Name Building name or number.
  • Field Name: dataUser.building_name
  • Type: String
Country Country name.
  • Field Name: dataUser.country
  • Type: String
Department Department names and numbers.
  • Field Name: dataUser.department
  • Type: String
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: dataUser.directory_uri
  • Type: String
Display Name Display name of the user
  • Field Name: dataUser.display_name
  • Type: String
Employee Number Employee number of the user
  • Field Name: dataUser.employee_number
  • Type: String
Employee Type Employee type
  • Field Name: dataUser.employee_type
  • Type: String
Facsimile Telephone Number Contains strings that represent the user's facsimile telephone Number(s).
  • Field Name: facsimile_telephone_number.[n]
  • Type: Array
Home Phone Contains strings that represent the user's home phone number(s).
  • Field Name: home_phone.[n]
  • Type: Array
IP Phone Contains strings that represent the user's IP phone number(s).
  • Field Name: ip_phone.[n]
  • Type: Array
Jabber ID Jabber ID
  • Field Name: dataUser.jabber_id
  • Type: String
City Contains the name of a person's locality.
  • Field Name: dataUser.city
  • Type: String
Manager Manager.
  • Field Name: dataUser.manager
  • Type: String
Member Of The user can be a member of a variety of groups.
  • Field Name: member_of.[n]
  • Type: Array
Mobile Contains strings that represent the user's IP mobile number(s).
  • Field Name: mobile.[n]
  • Type: Array
Organization The name of the person's organization.
  • Field Name: dataUser.organization
  • Type: String
Object Class
  • Field Name: object_class.[n]
  • Type: Array
Other Mailbox
  • Field Name: other_mailbox.[n]
  • Type: Array
Organizational Unit The name of the person's organization unit.
  • Field Name: ou.[n]
  • Type: Array
Photo URL Photo URL.
  • Field Name: dataUser.photo_url
  • Type: String
Physical Delivery Office Name Physical Delivery Office Name.
  • Field Name: dataUser.physical_delivery_office_name
  • Type: String
Postal Code Contains code used by a Postal Service to identify postal service zones.
  • Field Name: dataUser.postal_code
  • Type: String
Preferred Language Preferred Language.
  • Field Name: dataUser.preferred_language
  • Type: String
State Contains full names of state or province.
  • Field Name: dataUser.state
  • Type: String
Street Contains site information from a postal address.
  • Field Name: dataUser.street
  • Type: String
Telephone Number Telephone Number.
  • Field Name: telephone_number.[n]
  • Type: Array
Timezone Timezone.
  • Field Name: dataUser.timezone
  • Type: String
Title Title.
  • Field Name: dataUser.title
  • Type: String
Unverified Mail Box Unverified Mail Box.
  • Field Name: dataUser.unverified_mailbox
  • Type: String
Custom String 1 Custom String
  • Field Name: dataUser.customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: dataUser.customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: dataUser.customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: dataUser.customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: dataUser.customString5
  • Type: String
Custom String 6 Custom String
  • Field Name: dataUser.customString6
  • Type: String
Custom String 7 Custom String
  • Field Name: dataUser.customString7
  • Type: String
Custom String 8 Custom String
  • Field Name: dataUser.customString8
  • Type: String
Custom String 9 Custom String
  • Field Name: dataUser.customString9
  • Type: String
Custom String 10 Custom String
  • Field Name: dataUser.customString10
  • Type: String
Custom List of Strings 1 Custom List of Strings
  • Field Name: customListOfStrings1.[n]
  • Type: Array
Custom List of Strings 2 Custom List of Strings
  • Field Name: customListOfStrings2.[n]
  • Type: Array
Custom List of Strings 3 Custom List of Strings
  • Field Name: customListOfStrings3.[n]
  • Type: Array
Custom List of Strings 4 Custom List of Strings
  • Field Name: customListOfStrings4.[n]
  • Type: Array
Custom List of Strings 5 Custom List of Strings
  • Field Name: customListOfStrings5.[n]
  • Type: Array
Custom List of Strings 6 Custom List of Strings
  • Field Name: customListOfStrings6.[n]
  • Type: Array
Custom List of Strings 7 Custom List of Strings
  • Field Name: customListOfStrings7.[n]
  • Type: Array
Custom List of Strings 8 Custom List of Strings
  • Field Name: customListOfStrings8.[n]
  • Type: Array
Custom List of Strings 9 Custom List of Strings
  • Field Name: customListOfStrings9.[n]
  • Type: Array
Custom List of Strings 10 Custom List of Strings
  • Field Name: customListOfStrings10.[n]
  • Type: Array
Custom Boolean 1 Custom Boolean
  • Field Name: dataUser.customBoolean1
  • Type: Boolean
Custom Boolean 2 Custom Boolean
  • Field Name: dataUser.customBoolean2
  • Type: Boolean
Custom Boolean 3 Custom Boolean
  • Field Name: dataUser.customBoolean3
  • Type: Boolean
Custom Boolean 4 Custom Boolean
  • Field Name: dataUser.customBoolean4
  • Type: Boolean
Custom Boolean 5 Custom Boolean
  • Field Name: dataUser.customBoolean5
  • Type: Boolean
Custom Boolean 6 Custom Boolean
  • Field Name: dataUser.customBoolean6
  • Type: Boolean
Custom Boolean 7 Custom Boolean
  • Field Name: dataUser.customBoolean7
  • Type: Boolean
Custom Boolean 8 Custom Boolean
  • Field Name: dataUser.customBoolean8
  • Type: Boolean
Custom Boolean 9 Custom Boolean
  • Field Name: dataUser.customBoolean9
  • Type: Boolean
Custom Boolean 10 Custom Boolean
  • Field Name: dataUser.customBoolean10
  • Type: Boolean
Auth Method The type of authentication that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user. Default: Local
  • Field Name: dataUser.auth_method
  • Type: String
  • Default: Local
  • Choices: ["Local", "Automatic", "LDAP", "SSO"]
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: dataUser.ldap_server
  • Type: String
  • Target: /api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24AZSTTvjrb2pbzjMh%24gbtvjk6zDIhBORB8E2sIXsn2XmZ2zyPdLzHOWPEwIk%2Bpzqpy1R6jJDbjANlwiVfzdaBk3Z7z7BP1kjb5UxRD4qGQ%2BB78uPp0WPqLF%2Bgl2kqV3GdCbpKZoWrEowc/eJelWYA0fRWKLcMPyIU0VoK9503CJqoOlFJQS/S0XvKAeO%2Bp4l7cRtoiqSFUjYnzjLXL32ptCv8jucFHbiMg72Ldm2DI2xIYaXhytsEvvncj6Sb5V007iDMFW%2B0ZxwRdmOv2CLNAb8%2B05pevTeLkzbDvUBLPU9vAarY/UTXb8XlOc5Uyp9DwTGgbjh2iJWFN72ERmtMZuy3LCJOaFAOsyX4SbZUFIF6fiN4%3D%24%3D%3D
  • Target Model Type: data/Ldap
  • Format: uri
  • Choices: []
LDAP Username The login attribute of the associated LDAP device model instance
  • Field Name: dataUser.ldap_username
  • Type: String
SSO Identity Provider The entity id of the SSO Identity Provider.
  • Field Name: dataUser.sso_idp
  • Type: String
  • Target: /api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Q9msXZFzga7t9LNI%24cmAYTHVxvjifbd4JDDEyj//8K/4OcalfJkKDq4le5XgeVrSWVnUv0NXOyhcq7U5rqzU8uwo8pzWMuV3w9Iq6qBIs7GQIVov/doxCYYUtK%2Bv9tnwbYm926bDQKw2C3ArjuNb1X3l8XwJzDY0hLGPkxWEn10KH10Vw2vt94MaCWcPnvPTGr8/2ku%2BQT%2BmDW%2BCDneRnY3us44owlty7Rqq/ToWZIB/XoCO/irrTdEfsVuxlwaw0K3enOdSzYOAM3TK42KSmBhgRJyMM0kC1VZk4Q4vPcC2umlOXCXM1XNisH1FTjGuPF/SF92PFlGTRKsS1ouwfUVQDn/hMRv3PH12siAXO7KXuzEUTOIFDXHvsCXQWGi0%2BldnwphlogyQvsUqRJA5r0aoF%24%3D%3D
  • Target attr: entity_id
  • Target Model Type: data/SsoIdentityProvider
  • Format: uri
  • Choices: []
SSO Username The name identifier that is used for an SSO authenticated user.
  • Field Name: dataUser.sso_username
  • Type: String
User Type Indicate the user's login type. Default: Admin
  • Field Name: dataUser.user_type
  • Type: String
  • Default: Admin
  • Choices: ["Admin", "End User", "End User + Admin"]
Exclude from Directory Exclude from Directory flag to control the Phone Services directory lookup. If set to true the User's phone number will not appear in the directory lookup.
  • Field Name: dataUser.exclude_from_directory
  • Type: Boolean
Hybrid Status
  • Field Name: dataUser.mvs_hybrid_status
  • Type: String
Primary Line
  • Field Name: dataUser.mvs_primary_line
  • Type: String
Primary Class of Service
  • Field Name: dataUser.mvs_primary_line_cos
  • Type: String
Extensions Extensions to select primary details from.
  • Field Name: mvs_extensions.[n]
  • Type: Array
Line
  • Field Name: dataUser.mvs_extensions.[n].line
  • Type: String
Line E164
  • Field Name: dataUser.mvs_extensions.[n].line_e164
  • Type: String
Class of Service
  • Field Name: dataUser.mvs_extensions.[n].line_cos
  • Type: String
Avaya System Manager User Name The username corresponding to the the Username in Avaya System Manager.
  • Field Name: dataUser.username_avaya_system_manager
  • Type: String
Broadworks User Name The username corresponding to the the Username in Broadworks.
  • Field Name: dataUser.username_broadworks
  • Type: String
Cisco Unity Connection User Name The username corresponding to the the Username in Cisco Unity Connection.
  • Field Name: dataUser.username_cuc
  • Type: String
Cisco Unified Communication Manager User Name The username corresponding to the the Username in Cisco Unified Communication Manager.
  • Field Name: dataUser.username_cucm
  • Type: String
HCMF User Name The username corresponding to the the Username in Cisco HCMF.
  • Field Name: dataUser.username_hcmf
  • Type: String
LDAP Directory User Name The username corresponding to the the Username in the LDAP Directory.
  • Field Name: dataUser.username_ldap
  • Type: String
Microsoft User Name The username corresponding to the the Microsoft Username.
  • Field Name: dataUser.username_microsoft
  • Type: String
Microsoft Office 365 User Name The username corresponding to the the Username in Microsoft Office 365.
  • Field Name: dataUser.username_ms_365
  • Type: String
Microsoft LDAP User Name The username corresponding to the the Username in Microsoft LDAP.
  • Field Name: dataUser.username_ms_ldap
  • Type: String
Microsoft Teams User Name The username corresponding to the the Username in Microsoft Teams.
  • Field Name: dataUser.username_ms_teams
  • Type: String
Open LDAP User Name The username corresponding to the the Username in Opoen LDAP.
  • Field Name: dataUser.username_open_ldap
  • Type: String
Cisco Unified Contact Centre Express User Name The username corresponding to the the Username in Cisco Unified Contact Centre Express.
  • Field Name: dataUser.username_uccx
  • Type: String
Webex App User Name The username corresponding to the the Username in Webex App.
  • Field Name: dataUser.username_webex_teams
  • Type: String
Zoom User Name The username corresponding to the the Username in Zoom.
  • Field Name: dataUser.username_zoom
  • Type: String
Authorized Admin Hierarchy A reference an Authorized Admin Hierarchy instance that defines this user's administrative capabilities. This enables administrative capabilities for end users.
  • Field Name: dataUser.authorized_admin_hierarchy
  • Type: String
  • Target: /api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24dZycjlglnAzfzzkk%24PVtC8hqIXPKZq9sijP8S/UyYEr/e2M%2BooKUxA4DHwqUR7BqPekolXZGKpH8Dv1hyJsiPhY67CwLZobEOgFDKY54QG/trKkB7vID45rnljwEsJl6vTVSlJgPD1l8nRlZ7R7JObjcxG2HSeNkROk6RvROgn0zMg8M/e8mGheJGULl3EWs3M5dKmMYU8UyFSbKPhMlsABJOT6oU6h4d9sqAq95jZo1w85ETYOMCsmU1QpfdhuuTUEUGg4BjTnUo%2ByhRx5LDaqwa73RYfOs49jDOGzq7wKZDD3FhSeA8MSlLStbnSlYcXCwPYmoeEJc2KEwFLI4p/OFjq4%2BBshTg8iJ%2BHDmUoN67/1IxH1C2j6LrUqUpByGxpF0M0zby8kxMkvy9ZtsronW1%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AuthorizedAdminHierarchy
  • Format: uri
  • Choices: []
Hcs Site Dat
  • Field Name: hcsSiteDAT
  • Type: Object
Name * Site's name
  • Field Name: hcsSiteDAT.name
  • Type: String
  • MaxLength: 1024
  • Pattern: ^[A-Za-z0-9_\- ]+$
Create Local Admin Indicates whether or not an Admin User should be created Default: true
  • Field Name: hcsSiteDAT.create_admin
  • Type: Boolean
  • Default: true
Push Users to CUCM Indicates whether or not all of Users at Site level are pushed to CUCM Default: false
  • Field Name: hcsSiteDAT.push_cucm
  • Type: Boolean
  • Default: false
Hierarchy Path Site's entity's hierarchy
  • Field Name: hcsSiteDAT.HierarchyPath
  • Type: String
  • MaxLength: 1024
Migrate from HCM-F to CUCDM Migrate HCM-F Models to CUCDM Models Default: false
  • Field Name: hcsSiteDAT.migrate
  • Type: Boolean
  • Default: false
Misc Data Miscellaneous data used at run-time
  • Field Name: hcsSiteDAT.misc_data
  • Type: String
  • MaxLength: 1024