[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
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 on the Admins form (default menu User Management > Admins) by clicking the reseller.
If logged in as provider, and the customer is to be added under a reseller, set the hierarchy path to the reseller.
On the Customers form (default menu Customer Management > Customers) click Add, or to modify select a customer.
Complete or modify 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. |
Description | Customer description |
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. |
Inactive Billing | Exclude customer from billing (for testing). Used for License Reporting. |
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. |
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 Automate. After the HCM-F data syncs into VOSS Automate, 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 you enable Number Management for a customer after it was disabled, run the DN Audit Tool - see Run the Directory Number Inventory Audit Tool.
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.
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name * | Customer's name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Directory Domain | Customer's directory domain name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Shared UC Applications | Indicates whether the Customer shares UC Application instances Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Create Local Admin | Indiates whether or not an Admin User should be created Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Hierarchy Path | Customer entity's hierarchy |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Migrate from HCM-F to CUCDM | Migrate HCM-F Models to CUCDM Models Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Disable Number Management | Disables number management Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Public Sector | Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Inactive Billing | Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Misc Data | Miscellaneous data used at run-time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Hcs Customer |
|
||||||||||||||||||||||||||||||||||||||||||||||||
id |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Short Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Extended Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
External Customer ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Deal ID Info |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Account ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Address1 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Address2 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact City |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact State |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Post Zip |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Country |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Phone Number |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Contact Email |
|
||||||||||||||||||||||||||||||||||||||||||||||||
CUOM |
|
||||||||||||||||||||||||||||||||||||||||||||||||
ELM |
|
||||||||||||||||||||||||||||||||||||||||||||||||
CUCDM |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Service Provider * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
CCDM |
|
||||||||||||||||||||||||||||||||||||||||||||||||
CUCDM2 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Directory Domain |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Owns CTX |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Monitors Prime Collab |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Reseller |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses CTX |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Northbound Adjacencies |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Clusters |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses TM Ss |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses TS Virtuals |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses TS Hardwares |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses MC Us |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses CTM Ss |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses IV Rs |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses TS Supervisors |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Uses VPG Ws |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Hcs Role |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Role * | The role selector. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Role * | The role selector. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Data User |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Password |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Data User |
|
||||||||||||||||||||||||||||||||||||||||||||||||
User Name * | User's Username. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Email Address | The User email address. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
First Name | The User first name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Last Name | The User last name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Password | The User password. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Role * | The role to which the user belongs. See: Role. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Language | The preferred language for this user. Default: en-us |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Set by Default Language | Indicate if the user's language is set by language default in the hierarchy. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Account Information | Additional account information for the given user. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Change Password on Next Login | Indicates if the user must be forced to change their password the next time that login. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Locked | Indicates if the account has been locked to prevent the user from logging in. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Disabled | Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Reason for Disabled | A description of why the account is disabled. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Credential Policy | Specifies the policy with the rules used to govern this user's credentials. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Time of Last Password Change | The time when the password was last changed. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Time of Last Password Change By User | The time when the password was last changed by the user. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Time of Last Successful Login | The time the user last logged in successfully. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Number of Failed Login Attempts Since Last Successful Login | The total number of failed login attempts since last successful login. Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Security Questions |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Question * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Answer * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Used Passwords | List of passwords that have been used by user. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Password | Used password |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Time Created | Time when password was created. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Entitlement Profile |
|
||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Building Name | Building name or number. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Country | Country name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Department | Department names and numbers. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Directory URI | Alphanumeric Directory URI (e.g. SIP URI) |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Display Name | Display name of the user |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Employee Number | Employee number of the user |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Employee Type | Employee type |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Facsimile Telephone Number | Contains strings that represent the user's facsimile telephone Number(s). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Home Phone | Contains strings that represent the user's home phone number(s). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
IP Phone | Contains strings that represent the user's IP phone number(s). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Jabber ID | Jabber ID |
|
|||||||||||||||||||||||||||||||||||||||||||||||
City | Contains the name of a person's locality. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Manager | Manager. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Member Of | The user can be a member of a variety of groups. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mobile | Contains strings that represent the user's IP mobile number(s). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Organization | The name of the person's organization. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Object Class |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Other Mailbox |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Organizational Unit | The name of the person's organization unit. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Photo URL | Photo URL. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Physical Delivery Office Name | Physical Delivery Office Name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Postal Code | Contains code used by a Postal Service to identify postal service zones. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Preferred Language | Preferred Language. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
State | Contains full names of state or province. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Street | Contains site information from a postal address. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Telephone Number | Telephone Number. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Timezone | Timezone. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title | Title. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Unverified Mail Box | Unverified Mail Box. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 1 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 2 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 3 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 4 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 5 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 6 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 7 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 8 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 9 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 10 | Custom String |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 1 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 2 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 3 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 4 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 5 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 6 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 7 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 8 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 9 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 10 | Custom List of Strings |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 1 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 2 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 3 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 4 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 5 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 6 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 7 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 8 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 9 | Custom Boolean |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Boolean 10 | Custom 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 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
LDAP Server | A reference to the LDAP server which this user must authenticate against. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
LDAP Username | The login attribute of the associated LDAP device model instance |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SSO Identity Provider | The entity id of the SSO Identity Provider. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SSO Username | The name identifier that is used for an SSO authenticated user. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
User Type | Indicate the user's login type. Default: 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Hybrid Status |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Primary Line |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Primary Class of Service |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Extensions | Extensions to select primary details from. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Line |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Line E164 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Class of Service |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Avaya System Manager User Name | The username corresponding to the the Username in Avaya System Manager. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Broadworks User Name | The username corresponding to the the Username in Broadworks. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Cisco Unity Connection User Name | The username corresponding to the the Username in Cisco Unity Connection. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Cisco Unified Communication Manager User Name | The username corresponding to the the Username in Cisco Unified Communication Manager. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
HCMF User Name | The username corresponding to the the Username in Cisco HCMF. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
LDAP Directory User Name | The username corresponding to the the Username in the LDAP Directory. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Microsoft User Name | The username corresponding to the the Microsoft Username. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Microsoft Office 365 User Name | The username corresponding to the the Username in Microsoft Office 365. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Microsoft LDAP User Name | The username corresponding to the the Username in Microsoft LDAP. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Microsoft Teams User Name | The username corresponding to the the Username in Microsoft Teams. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Open LDAP User Name | The username corresponding to the the Username in Opoen LDAP. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Cisco Unified Contact Centre Express User Name | The username corresponding to the the Username in Cisco Unified Contact Centre Express. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Webex Teams User Name | The username corresponding to the the Username in Webex Teams. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Zoom User Name | The username corresponding to the the Username in Zoom. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Base Customer Dom |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Customer Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Internal ID | Default: "Auto Generated" |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Address Line 1 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Address Line 2 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Address Line 3 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Customer ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Base Customer Dat |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Customer Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Internal ID | Default: "Auto Generated" |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Customer ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Address Line 1 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Address Line 2 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Address Line 3 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Hierarchy |
|