[Index]

Model: relation/HcsCustomerREL

Customers

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

In VOSS-4-UC, if the customer name matches an existing customer previously configured in HCM-F, you can migrate the existing customer.

You can disable number management for the customer if required.

Procedure

  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.

  5. Complete the following fields:

Field Description
Customer Name

The name of the customer. This field is mandatory.

Note:

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.

Note: A customer that has been configured in HCM-F and synced into VOSS-4-U may exist at the sys.hcs hierarchy. If the Customer Name you enter matches this customer, the Migrate from HCM-F to VOSS-4-UC check box is displayed. Click Save to migrate this customer to 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, enter a different Customer Name.
Description Customer description
Extended Name

The Extended Name can be used to provide a more descriptive name of the customer. The Extended Name is also used by external clients to correlate their own customer records with the customer records stored in HCS. This Extended Name value is synced to the Customer record in the Shared Data Repository (SDR).

The Extended Name is not referenced by other components in HCS.
External Customer ID The External Customer ID is used by the Service Inventory service. The External Customer ID is included as a column in the customer record of the service inventory report. Specify an External Customer ID in this field that matches the customer ID used by the external inventory tool which receives the Service Inventory reports. If the Service Inventory service is not being used, this field is not required. However, it can be used to correlate customer records in external systems with customer records in HCS.
Domain Name

Customer domain. This field is used to create email addresses for:

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.
Field Description
Create Local Admin Controls whether a default local administrator is created for the customer.
Cloned Admin Role The Provider or Reseller role used to create a new role prefixed with the customer name. 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.
Default Admin Role The created customer 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 and is mandatory only if the Create Local Admin check box is selected.
Repeat Default Admin Password Confirm the default local administrator password. This field appears and is mandatory only if the Create Local Admin check box is selected.
Field Description
Account ID The Account ID is used by external clients to correlate their own customer records with the customer records stored in HCS. This Account ID value is synced to the Customer record in the Shared Data Repository.
Deal IDs Deal IDs are used by the Hosted License Manager (HLM) service which can be activated on the Hosted Collaboration Management Fulfillment (HCM-F) server. HLM supports Point of Sales (POS) report generation. The report includes all customers on the system with aggregate license consumption at customer level. The optional Deal ID field associated with the customer is included in the report. Each customer can have zero or more Deal IDs. The Deal ID field is free text format and each deal ID is separated by a comma.
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 Select to disable Number Management for this customer. If selected, you cannot add Directory Numbers and E164 Numbers to inventories for this customer.
  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
cUCDM
  • Field Name: hcsCustomer.cUCDM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUCDM
  • Format: uri
contactCountry
  • Field Name: hcsCustomer.contactCountry
  • Type: ["String", "Null"]
contactPhoneNumber
  • Field Name: hcsCustomer.contactPhoneNumber
  • Type: ["String", "Null"]
contactCity
  • Field Name: hcsCustomer.contactCity
  • Type: ["String", "Null"]
contactAddress1
  • Field Name: hcsCustomer.contactAddress1
  • Type: ["String", "Null"]
contactEmail
  • Field Name: hcsCustomer.contactEmail
  • Type: ["String", "Null"]
cdmUpdateTimestamp
  • Field Name: hcsCustomer.cdmUpdateTimestamp
  • Type: ["String", "Null"]
contactName
  • Field Name: hcsCustomer.contactName
  • Type: ["String", "Null"]
id
  • Field Name: hcsCustomer.id
  • Type: ["String", "Null"]
usesVPGWs
  • Field Name: usesVPGWs
  • Type: ["Array", "Null"]
usesTMSs
  • Field Name: usesTMSs
  • Type: ["Array", "Null"]
isModifiable
  • Field Name: hcsCustomer.isModifiable
  • Type: ["Boolean", "Null"]
contactPostZip
  • Field Name: hcsCustomer.contactPostZip
  • Type: ["String", "Null"]
usesCTX
  • Field Name: hcsCustomer.usesCTX
  • Type: ["String", "Null"]
  • Target: device/hcmf/CTX
  • Format: uri
clusters
  • Field Name: clusters
  • Type: ["Array", "Null"]
type * Default: Customer
  • Field Name: hcsCustomer.type
  • Type: String
  • Default: Customer
usesCTMSs
  • Field Name: usesCTMSs
  • Type: ["Array", "Null"]
cUCDM2
  • Field Name: hcsCustomer.cUCDM2
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUCDM2
  • Format: uri
accountID
  • Field Name: hcsCustomer.accountID
  • Type: ["String", "Null"]
contactAddress2
  • Field Name: hcsCustomer.contactAddress2
  • Type: ["String", "Null"]
directoryDomain
  • Field Name: hcsCustomer.directoryDomain
  • Type: ["String", "Null"]
  • Target: device/hcmf/DirectoryDomain
  • Format: uri
description
  • Field Name: hcsCustomer.description
  • Type: ["String", "Null"]
serviceProvider *
  • Field Name: hcsCustomer.serviceProvider
  • Type: String
  • Target: device/hcmf/ServiceProvider
  • Format: uri
northboundAdjacencies
  • Field Name: northboundAdjacencies
  • Type: ["Array", "Null"]
contactState
  • Field Name: hcsCustomer.contactState
  • Type: ["String", "Null"]
dealIDInfo
  • Field Name: hcsCustomer.dealIDInfo
  • Type: ["String", "Null"]
ownsCTX
  • Field Name: hcsCustomer.ownsCTX
  • Type: ["String", "Null"]
  • Target: device/hcmf/CTX
  • Format: uri
extendedName
  • Field Name: hcsCustomer.extendedName
  • Type: ["String", "Null"]
usesIVRs
  • Field Name: usesIVRs
  • Type: ["Array", "Null"]
externalCustomerID
  • Field Name: hcsCustomer.externalCustomerID
  • Type: ["String", "Null"]
shortName *
  • Field Name: hcsCustomer.shortName
  • Type: String
isDeletable
  • Field Name: hcsCustomer.isDeletable
  • Type: ["Boolean", "Null"]
usesMCUs
  • Field Name: usesMCUs
  • Type: ["Array", "Null"]
usesTS_Hardwares
  • Field Name: usesTS_Hardwares
  • Type: ["Array", "Null"]
monitorsPrimeCollab
  • Field Name: hcsCustomer.monitorsPrimeCollab
  • Type: ["String", "Null"]
  • Target: device/hcmf/PrimeCollab
  • Format: uri
reseller
  • Field Name: hcsCustomer.reseller
  • Type: ["String", "Null"]
  • Target: device/hcmf/Reseller
  • Format: uri
cCDM
  • Field Name: hcsCustomer.cCDM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CCDM
  • Format: uri
usesTS_Virtuals
  • Field Name: usesTS_Virtuals
  • Type: ["Array", "Null"]
eLM
  • Field Name: hcsCustomer.eLM
  • Type: ["String", "Null"]
  • Target: device/hcmf/ELM
  • Format: uri
usesTS_Supervisors
  • Field Name: usesTS_Supervisors
  • Type: ["Array", "Null"]
cUOM
  • Field Name: hcsCustomer.cUOM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUOM
  • Format: uri
syncTimestamp
  • Field Name: hcsCustomer.syncTimestamp
  • Type: ["String", "Null"]
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