.. _create-a-customer:
Customers
------------
.. _18.1-Patch-Bundle-3|VOSSSOL-10561:
.. _21.1|EKB-7504:
.. _21.4-PB1|EKB-15315:
Overview
............
Customers exist as a node in VOSS Automate's hierarchical structure. Typically, the structure has the following
order (from highest level to lowest level).
* Provider
* Reseller
* Customer
* Site
Optional intermediary nodes can also be created.
.. note::
VOSS Automate employs hierarchies (organization levels), user roles, and access profiles to control and
secure access to resources in the system. You
can find out more about hierarchies at *Introduction to Hierarchies* in the Core Feature Guide.
In the hierarchical structure, sites (locations) can only be created under a customer. However,
you will need to set up the customer-level configuration before adding sites. The complete on-boarding of a
customer is done at the Provider hierarchy. You can find the customer on-boarding details in the
*Customer On-boarding Quick Start Guide* in the Core Feature Guide.
.. rubric:: Related Topics
*
.. raw:: latex
Introduction to Hierarchies in the Core Feature Guide
.. raw:: html
Introduction to Hierarchies
*
.. raw:: latex
Customer On-boarding Quick Start Guide in the Core Feature Guide
.. raw:: html
Customer On-boarding Quick Start Guide
*
.. raw:: latex
Network Device Lists in the Core Feature Guide
.. raw:: html
Network Device Lists
Add and Update Customers
..........................
This procedure adds a new customer, and updates an existing customer.
.. note::
If required, you can disable number management for the customer.
1. Log in as Provider or Reseller administrator (depending on which organization
manages the customer).
.. note::
Log in using the Provider or Reseller admin's email address
(case-sensitive). You can find this email address via (default menus) **User Management >
Admins**. Click on the admin's name to view the email address.
2. Choose the hierarchy.
.. note::
If logged in as Provider and the Customer is to be added under a
Reseller, set the hierarchy path to the Reseller.
3. Go to (default menus) **Customer Management > Customers**.
.. image:: /src/images/customers-list-view.png
4. On the **Customers** page:
* To add a new customer, click the Plus icon (+) to open the configuration screen.
* To update an existing customer, click on the customer name to open the configuration screen.
.. image:: /src/images/customers-configuration.png
.. note::
To switch the page layout from panels to tabs or from tabs to panels, you can
click the **Switch to Tab/Panel Layout** toolbar icon.
5. Fill out or update the fields on the page (Customer Details and Contact Information tabs/panels):
* Customer Details (see field descriptions below)
* Contact Information - fill out the customer address and contact details (email address and telephone number)
.. important::
Additional custom string and boolean fields may be exposed via field display policies
for the **Customers** configuration form. For details, see :ref:`add-custom-fields`
.. tabularcolumns:: |p{2.5cm}|p{11.5cm}|
+---------------------------+--------------------------------------------------------------------+
| Customer Details | Description |
+===========================+====================================================================+
| | Mandatory. The name of the customer. |
| | |
| Customer Name | Note that when **Create Local Admin** is selected, any spaces in |
| | the customer name are converted to underscores in the Customer |
| | local administrator name and email. |
+---------------------------+--------------------------------------------------------------------+
| Description | Customer description |
+---------------------------+--------------------------------------------------------------------+
| | Descriptive name for the customer, used by external clients to |
| Extended Name (Provider) | correlate their own customer records with customer records stored |
| | in HCS. |
+---------------------------+--------------------------------------------------------------------+
| | External customer ID used by the Service Inventory service, and |
| | included as a column in the customer record of the service |
| | inventory report. Specify an External Customer ID in this field |
| External Customer | that matches the customer ID used by the external inventory tool |
| ID (Provider) | that 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. |
+---------------------------+--------------------------------------------------------------------+
| | 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 |
| Deal IDs | Manager (HLM) service. 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. |
+---------------------------+--------------------------------------------------------------------+
.. tabularcolumns:: |p{2.5cm}|p{11.5cm}|
+---------------------------+--------------------------------------------------------------------+
| Customer Details | Description |
+===========================+====================================================================+
| 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. |
+---------------------------+--------------------------------------------------------------------+
| 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}|
+---------------------------+--------------------------------------------------------------------+
| Customer Details | Description |
+===========================+====================================================================+
| Create Local Admin | Defines 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** checkbox 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** checkbox 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** |
| | checkbox is selected. |
+---------------------------+--------------------------------------------------------------------+
| Repeat Default | Confirm the default local administrator |
| Admin Password | password. This field appears and is mandatory |
| | only if the **Create Local Admin** checkbox |
| | is selected. |
+---------------------------+--------------------------------------------------------------------+
6. If you enable Number Management for a customer after it was disabled,
run the DN Audit Tool. See :ref:`run-dni-audit-tool`.
7. Click **Save**.
.. note::
When deleting a customer, remove any entities associated with the
customer, such as LDAP, SSO providers, Devices, and NDLs.
.. _add-custom-fields:
Add Custom Fields to Customer 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 Customer data model (`relation/HcsCustomerREL`). This provides flexibility to add additional
details for a customer, if required.
The summary attributes in the **Customers** 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 customer (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/HcsCustomerREL:
* macro.HcsVossCustomerDAT_custom_string_1
* macro.HcsVossCustomerDAT_custom_string_2
* macro.HcsVossCustomerDAT_custom_string_3
* macro.HcsVossCustomerDAT_custom_string_4
* macro.HcsVossCustomerDAT_custom_string_5
* macro.HcsVossCustomerDAT_custom_string_6
* macro.HcsVossCustomerDAT_custom_string_7
* macro.HcsVossCustomerDAT_custom_string_8
* macro.HcsVossCustomerDAT_custom_string_9
* macro.HcsVossCustomerDAT_custom_string_10
Macros for custom boolean fields for relation/HcsCustomerREL:
* macro.HcsVossCustomerDAT_custom_boolean_1
* macro.HcsVossCustomerDAT_custom_boolean_2
* macro.HcsVossCustomerDAT_custom_boolean_3
* macro.HcsVossCustomerDAT_custom_boolean_4
* macro.HcsVossCustomerDAT_custom_boolean_5
* macro.HcsVossCustomerDAT_custom_boolean_6
* macro.HcsVossCustomerDAT_custom_boolean_7
* macro.HcsVossCustomerDAT_custom_boolean_8
* macro.HcsVossCustomerDAT_custom_boolean_9
* macro.HcsVossCustomerDAT_custom_boolean_10
The macros can be applied in workflows and configuration templates to reference the custom field values. For example,
executing `macro.HcsVossCustomerDAT_custom_string_1` will return the value in the field where the macro is used.
.. rubric:: To expose custom fields for `relation/HcsCustomerREL`
1. Log in to VOSS Automate as Provider admin or higher.
2. Create or update the Customers data model field display policy:
* Go to (default menus) **Customization > Field Display Policies**, and locate the entry for target model type
`relation/HcsCustomerREL`.
* Click on the default field display policy (FDP) for the model (the FDP named `default`).
* Clone (copy) the default FDP for the model, and give the clone a new name.
.. note::
You cannot modify default FDPs that ship with the system. This allows you to refer to or revert to a
system default at any time, if required.
* Modify the new FDP (the clone).
.. note::
You can add a new group of fields containing only the new custom fields, or add fields to
existing field groups.
You can also create field overrides, which allow you to define that a custom field value will be referenced
in place of an existing field.
.. image:: /src/images/customers-custom-fields-fdp.png
* Save your changes.
3. Update the menu layout to apply the field display policy:
* Go to (default menus) **Role Management > Menu Layouts**, and locate the Provider admin menu layout
(HcsProviderMenu).
* Click on **HcsProviderMenu**, and create a clone with a new name.
.. note::
You cannot modify default menu layouts that ship with the system. This allows you to refer to or revert to a
system default menu layout at any time, if required.
* Modify the clone (copy) of **HcsProviderMenu**:
* Expand the **Customer Management** menu.
* At **Customers**, click in the **Field Display Policy** cell, and choose the FDP you
configured to add the custom fields.
* Save your changes.
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.