[Index]

Model: relation/HcsCustomerREL

Customers

  1. Log in as provider or reseller administrator, depending on which organization manages the customer.

    Log in with the provider or reseller administrator's email address, which is case-sensitive. The provider administrator can find the reseller administrator's email address by choosing User Management > Local Admins and then clicking the reseller.

  2. If logged in as provider, and the customer is to be added under a reseller, set the hierarchy path to the reseller.

  3. Choose Customer Management > Customers.

  4. Click Add or to modify, select a customer.

  5. Complete or modify the following fields:

System Message: ERROR/3 (<string>, line 21)

Malformed table.

+---------------------------+----------------------------------------------------------------------------------------------+
| Field                     | Description                                                                                  |
+===========================+==============================================================================================+
|                           | The name of the customer. This field is                                                      |
|                           | mandatory.                                                                                   |
|                           |                                                                                              |
|                           | Note:                                                                                        |
|                           |                                                                                              |
| Customer Name             | Any spaces in the customer name are converted                                                |
|                           | to underscores in the customer local                                                         |
|                           | administrator name and email, if the **Create                                                |
|                           | Local Admin** check box is selected.                                                         |
+---------------------------+----------------------------------------------------------------------------------------------+
| Description               | Customer description                                                                         |
+---------------------------+----------------------------------------------------------------------------------------------+
|                           | Customer domain. This field is used to create                                                |
|                           | email addresses for:                                                                         |
|                           |                                                                                              |
|                           | * The customer default local administrator,                                                  |
|                           |   for example: Customer1Admin@customer1.com                                                  |
|                           |                                                                                              |
|                           | * Site default local administrators under                                                    |
| Domain Name               |   the customer, for example:                                                                 |
|                           |   Site1Admin@customer1.com                                                                   |
|                           |                                                                                              |
|                           | If the customer domain is omitted, the                                                       |
|                           | provider domain (or reseller domain, if the                                                  |
|                           | customer is under a reseller in the hierarchy                                                |
|                           | and the reseller domain was provided) is used                                                |
|                           | instead.                                                                                     |
+---------------------------+----------------------------------------------------------------------------------------------+
| Public Sector             | Set the Customer as a Public Sector customer.                                                |
|                           | Used for License Reporting.                                                                  |
+---------------------------+----------------------------------------------------------------------------------------------+
| Create Local Admin        | Controls whether a default local                                                             |
|                           | administrator is created for the customer.                                                   |
+---------------------------+----------------------------------------------------------------------------------------------+
|                           | The Provider or Reseller role used to create                                                 |
|                           | a new role prefixed with the customer name.                                                  |
| Cloned Admin Role         | The created customer 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.                                                               |
+---------------------------+----------------------------------------------------------------------------------------------+
|                           | The created customer role that is assigned to                                                |
| Default Admin Role        | the default local administrator. This field                                                  |
|                           | is read-only, and appears only if the **Create                                               |
|                           | Local Admin** check box is selected.                                                         |
+---------------------------+----------------------------------------------------------------------------------------------+
|                           | The password to assign to the default local                                                  |
| Default Admin             | administrator. This field appears and is                                                     |
| Password                  | mandatory only if the **Create Local Admin**                                                 |
|                           | check box is selected.                                                                       |
+---------------------------+----------------------------------------------------------------------------------------------+
| Repeat Default            | Confirm the default local administrator                                                      |
| Admin Password            | password. This field appears and is mandatory                                                |
|                           | only if the **Create Local Admin** check box                                                 |
|                           | is selected.                                                                                 |
+---------------------------+----------------------------------------------------------------------------------------------+
| Prime Collaboration       | Prime Collaboration is the application which monitors                                        |
|                           | equipment used by this customer. Available Prime                                             |
|                           | Collaboration applications must first be configured                                          |
|                           | using the HCM-F User Interface. Then HCM-F synchronization                                   |
|                           | must be executed on VOSS-4-UC. After the HCM-F data syncs                                    |
|                           | into VOSS-4-UC, available Prime Collaboration applications                                   |
|                           | will appear in this drop-down. Select an available Prime                                     |
|                           | Collaboration application to monitor Unified Communications                                  |
|                           | applications and customer equipment configured for this customer.                            |
|                           |                                                                                              |
|                           | To unassociate Prime Collaboration for this customer, choose None.                           |
+---------------------------+----------------------------------------------------------------------------------------------+
| Shared UC Applications    | Indicates whether the customer can use Shared UC Apps.                                       |
|                           | If selected, the customer sites can use Network Device Lists                                 |
|                           | that contain Shared UC Apps. Shared UC Apps are UC Apps that                                 |
|                           | are defined above the Customer hierarchy level.                                              |
+---------------------------+----------------------------------------------------------------------------------------------+
| Disable Number Management | Enable or disable Number Management for this customer.                                       |
|                           |                                                                                              |
|                           | * If selected, you cannot add Directory Numbers and E164                                     |
|                           |   Numbers to inventories for this customer.                                                  |
|                           |                                                                                              |
|                           | * If *not* selected, you can add Directory Numbers and E164                                  |
|                           |   Numbers to inventories for this customer.                                                  |
|                           |                                                                                              |
|                           |   If you enable Number Management for a customer after it was                                |
|                           |   disabled, run the DN Audit Tool - see Run the Directory Number Inventory Audit Tool |
+---------------------------+----------------------------------------------------------------------------------------------+
  1. Click Save.

Note

When deleting a customer, remove any entities associated with the customer like LDAP, SSO providers, Devices, and NDLs.

This relation joins the HcsVossCustomerDAT with other VOSS and SDR customer models.

Model Details

Title Description Details
Name * Customer's name
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[A-Za-z0-9_\- ]+$
Directory Domain Customer's directory domain name
  • Field Name: directoryDomain
  • Type: String
  • MaxLength: 1024
Shared UC Applications Indicates whether the Customer shares UC Application instances Default: false
  • Field Name: shared_uc_apps
  • Type: Boolean
  • Default: false
Create Local Admin Indiates whether or not an Admin User should be created Default: true
  • Field Name: create_admin
  • Type: Boolean
  • Default: true
Hierarchy Path Customer entity's hierarchy
  • Field Name: HierarchyPath
  • Type: String
  • MaxLength: 1024
Migrate from HCM-F to CUCDM Migrate HCM-F Models to CUCDM Models Default: false
  • Field Name: migrate
  • Type: Boolean
  • Default: false
Disable Number Management Disables number management Default: false
  • Field Name: disableNumMgmt
  • Type: Boolean
  • Default: false
Public Sector Default: false
  • Field Name: publicSector
  • Type: Boolean
  • Default: false
Misc Data Miscellaneous data used at run-time
  • Field Name: misc_data
  • Type: String
  • MaxLength: 1024
Hcs Customer
  • Field Name: hcsCustomer
  • Type: Object
id
  • Field Name: hcsCustomer.id
  • Type: String
  • MaxLength: 1024
Short Name *
  • Field Name: hcsCustomer.shortName
  • Type: String
  • MaxLength: 64
Extended Name
  • Field Name: hcsCustomer.extendedName
  • Type: String
  • MaxLength: 128
External Customer ID
  • Field Name: hcsCustomer.externalCustomerID
  • Type: String
  • MaxLength: 128
Deal ID Info
  • Field Name: hcsCustomer.dealIDInfo
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: hcsCustomer.description
  • Type: String
  • MaxLength: 128
Account ID
  • Field Name: hcsCustomer.accountID
  • Type: String
  • MaxLength: 64
Contact Name
  • Field Name: hcsCustomer.contactName
  • Type: String
  • MaxLength: 128
Contact Address1
  • Field Name: hcsCustomer.contactAddress1
  • Type: String
  • MaxLength: 128
Contact Address2
  • Field Name: hcsCustomer.contactAddress2
  • Type: String
  • MaxLength: 128
Contact City
  • Field Name: hcsCustomer.contactCity
  • Type: String
  • MaxLength: 64
Contact State
  • Field Name: hcsCustomer.contactState
  • Type: String
  • MaxLength: 64
Contact Post Zip
  • Field Name: hcsCustomer.contactPostZip
  • Type: String
  • MaxLength: 32
Contact Country
  • Field Name: hcsCustomer.contactCountry
  • Type: String
  • MaxLength: 32
Contact Phone Number
  • Field Name: hcsCustomer.contactPhoneNumber
  • Type: String
  • MaxLength: 64
Contact Email
  • Field Name: hcsCustomer.contactEmail
  • Type: String
  • MaxLength: 128
CUOM
  • Field Name: hcsCustomer.cUOM
  • Type: String
  • Target: data/HCSHcmfCUOMDAT
  • MaxLength: 1024
  • Format: uri
ELM
  • Field Name: hcsCustomer.eLM
  • Type: String
  • Target: data/HCSHcmfELMDAT
  • MaxLength: 1024
  • Format: uri
CUCDM
  • Field Name: hcsCustomer.cUCDM
  • Type: String
  • Target: data/HCSHcmfCUCDMDAT
  • MaxLength: 1024
  • Format: uri
Service Provider *
  • Field Name: hcsCustomer.serviceProvider
  • Type: String
  • Target: data/HCSHcmfServiceProviderDAT
  • MaxLength: 1024
  • Format: uri
CCDM
  • Field Name: hcsCustomer.cCDM
  • Type: String
  • Target: data/HCSHcmfCCDMDAT
  • MaxLength: 1024
  • Format: uri
CUCDM2
  • Field Name: hcsCustomer.cUCDM2
  • Type: String
  • Target: data/HCSHcmfCUCDM2DAT
  • MaxLength: 1024
  • Format: uri
Directory Domain
  • Field Name: hcsCustomer.directoryDomain
  • Type: String
  • Target: data/HCSHcmfDirectoryDomainDAT
  • MaxLength: 1024
  • Format: uri
Owns CTX
  • Field Name: hcsCustomer.ownsCTX
  • Type: String
  • Target: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
Monitors Prime Collab
  • Field Name: hcsCustomer.monitorsPrimeCollab
  • Type: String
  • Target: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
Reseller
  • Field Name: hcsCustomer.reseller
  • Type: String
  • Target: data/HCSHcmfResellerDAT
  • MaxLength: 1024
  • Format: uri
Uses CTX
  • Field Name: hcsCustomer.usesCTX
  • Type: String
  • Target: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
Northbound Adjacencies
  • Field Name: northboundAdjacencies.[n]
  • Type: Array
Clusters
  • Field Name: clusters.[n]
  • Type: Array
Uses TM Ss
  • Field Name: usesTMSs.[n]
  • Type: Array
Uses TS Virtuals
  • Field Name: usesTS_Virtuals.[n]
  • Type: Array
Uses TS Hardwares
  • Field Name: usesTS_Hardwares.[n]
  • Type: Array
Uses MC Us
  • Field Name: usesMCUs.[n]
  • Type: Array
Uses CTM Ss
  • Field Name: usesCTMSs.[n]
  • Type: Array
Uses IV Rs
  • Field Name: usesIVRs.[n]
  • Type: Array
Uses TS Supervisors
  • Field Name: usesTS_Supervisors.[n]
  • Type: Array
Uses VPG Ws
  • Field Name: usesVPGWs.[n]
  • Type: Array
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: data_user
  • Type: Object
Name
  • Field Name: data_user.name
  • Type: String
Password
  • Field Name: data_user.password
  • Type: String
  • Is Password: True
Data User
  • Field Name: dataUser
  • Type: Object
User Name * The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.username
  • Type: String
Email Address The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.email
  • Type: String
First Name The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.first_name
  • Type: String
Last Name The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.last_name
  • Type: String
Password The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.
  • 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: data/Role
  • Target attr: name
  • Format: uri
Language The preferred language for this user. Default: en-us
  • Field Name: dataUser.language
  • Type: String
  • Target: data/Language
  • Target attr: lcid
  • Default: en-us
  • Format: uri
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: data/CredentialPolicy
  • Target attr: name
  • Format: uri
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
Base Customer Dom
  • Field Name: baseCustomerDOM
  • Type: Object
Customer Name *
  • Field Name: baseCustomerDOM.name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[\w\ -]+$
Internal ID Default: "Auto Generated"
  • Field Name: baseCustomerDOM.InternalCustomerID
  • Type: String
  • Default: "Auto Generated"
Description
  • Field Name: baseCustomerDOM.Description
  • Type: String
Address Line 1
  • Field Name: baseCustomerDOM.Address1
  • Type: String
Address Line 2
  • Field Name: baseCustomerDOM.Address2
  • Type: String
Address Line 3
  • Field Name: baseCustomerDOM.Address3
  • Type: String
Customer ID
  • Field Name: baseCustomerDOM.CustomerID
  • Type: String
Base Customer Dat
  • Field Name: baseCustomerDAT
  • Type: Object
Customer Name *
  • Field Name: baseCustomerDAT.CustomerName
  • Type: String
  • MaxLength: 64
  • Pattern: ^[\w\ -]+$
Internal ID Default: "Auto Generated"
  • Field Name: baseCustomerDAT.InternalCustomerID
  • Type: String
  • Default: "Auto Generated"
Customer ID
  • Field Name: baseCustomerDAT.CustomerID
  • Type: String
Address Line 1
  • Field Name: baseCustomerDAT.Address1
  • Type: String
Address Line 2
  • Field Name: baseCustomerDAT.Address2
  • Type: String
Address Line 3
  • Field Name: baseCustomerDAT.Address3
  • Type: String
Description
  • Field Name: baseCustomerDAT.Description
  • Type: String
Hierarchy
  • Field Name: baseCustomerDAT.Hierarchy
  • Type: String
API reference for relation/HcsCustomerREL