.. _p_create_a_customer:
Create a Customer
------------------
.. _18.1-Patch-Bundle-3|VOSSSOL-10561:
.. _21.1|EKB-7504:
This procedure adds and edits a customer.
.. 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.
* If required, you can disable number management for the customer.
**Perform the following steps**:
1. Log in as provider or reseller administrator, depending on the organization managing
the customer.
.. note::
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.
#. Go to (default menu **Customer Management > Customers** to open the **Customers** page:
* To add a new customer, click **Add**; then, fill out the fields on the page.
* To update an existing customer, select the customer; then, update the fields.
.. tabularcolumns:: |p{3cm}|p{12cm}|
+-------------------+------------------------------------------------+
| Field | Description |
+===================+================================================+
| | 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. |
| | |
| Customer Name | 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 |
+-------------------+------------------------------------------------+
| | 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 |
| Extended Name | 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. |
+-------------------+------------------------------------------------+
| | 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 |
| External Customer | this field that matches the customer ID used |
| ID | 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. |
+-------------------+------------------------------------------------+
| | 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. |
+-------------------+------------------------------------------------+
| Inactive Billing | Exclude customer from billing (for testing). |
| | Used for License Reporting. |
+-------------------+------------------------------------------------+
.. tabularcolumns:: |p{3cm}|p{12cm}|
+--------------------+-----------------------------------------------+
| Field | Description |
+====================+===============================================+
| 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. |
+--------------------+-----------------------------------------------+
.. tabularcolumns:: |p{3cm}|p{12cm}|
+---------------------------+----------------------------------------------------------------------------------------------+
| Field | Description |
+===========================+==============================================================================================+
| | The Account ID is used by external clients to |
| | correlate their own customer records with the |
| Account ID | customer records stored in HCS. This Account |
| | ID value is synced to the Customer record in |
| | the Shared Data Repository. |
+---------------------------+----------------------------------------------------------------------------------------------+
| | 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 |
| Deal IDs | 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 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 |
| Prime | syncs into VOSS-4-UC, available Prime |
| Collaboration | 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**. |
+---------------------------+----------------------------------------------------------------------------------------------+
| | Indicates whether the customer can use Shared |
| | UC Apps. If selected, the customer sites can |
| Shared UC | use Network Device Lists that contain Shared |
| Applications | 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. |
+---------------------------+----------------------------------------------------------------------------------------------+
4. If you enable Number Management for a customer after it was
disabled, run the DN Audit Tool - see :ref:`run_the_directory_number_inventory_audit_tool`.
5. Click **Save**.
.. note::
If you're deleting a customer, remove any entities associated with the
customer, such as LDAP, SSO providers, Devices, and NDLs.