.. _voss-customer-portal-destination:

Set Up the VOSS Cloud Licensing Service
----------------------------------------

.. _21.1|VOSS-677:

VOSS Automate provides options to set up your VOSS Cloud Licensing service. The system registers your VOSS Cloud Licensing Service when saving the form.


.. rubric:: Before you start

1. Open these ports to communicate with the VOSS Customer Portal:  

   * Default HTTP: port 80
   * Default HTTPS: port 443

    .. raw:: latex
   
       See Network Communications External to the Cluster in the Installation Guide.

    .. raw:: html
   
       See <a href="platform/reference-network-comms-outside-cluster.html">Network Communications External to the Cluster</a>.

2. Add the host name to an allowlist for trusted servers: platform.voss-solutions.com

3. Obtain license details for your organization from the **VOSS Customer Portal**, 
   at voss.portalshape.com/organisations: 
  
  * On the **Information** tab, locate and copy your **Account ID**. 

    .. image:: /src/images/account-id-voss-customer-portal.png
  
  * On the **Software** tab, identify the installation type (Lab or Platform), and copy the platform name. 

    .. image::  /src/images/software-voss-customer-portal.png
  





.. rubric:: To add and activate the license

1. Log in to the Admin Portal as a high-level administrator (system admin or above). 
#. Go to **Administration Menu > Licensing > VOSS Cloud Licensing Service**.
#. In the **Organization ID** field, enter the account ID you obtained from the VOSS Customer Portal.  
#. In the **Customer account information** field, enter the platform name you obtained 
   from the VOSS Customer Portal (or enter a new server name) to identify 
   your VOSS Automate installation. 

#. Choose your **Installation Type**, either ``Lab`` or ``Production``, as obtained from the 
   VOSS Customer Portal.

#. At the **File format** drop-down, choose your file format. The default, 
   ``Anonymous ZIP``, includes a checksum hash.

   .. raw:: latex
   
      See also the Data Export Types section in the Licensing and Subscriber Data Export Guide.

   .. raw:: html
   
      See also <a href="index-license-feature.html#data-export-types">Data Export Types</a>.

#. Choose whether to enable **File Upload Active**. 

#. If a web proxy is required, ensure that it is set up on the  **Web proxy**
   menu and choose it from the drop down.

   For web proxy setup, see :ref:`licensing-web-proxy`.

#. Click **Save**.

.. note::

   * Save will fail if no internet connection can be established to the
     VOSS Cloud Licensing Service.
   * Once the configuration is saved, the connection to the
     VOSS Cloud Licensing Service can be tested through the **Test Connection** actions on the form
     when investigating failures to upload license data files.
   * In the unlikely event that it is required to change the **Organization ID** associated with the
     platform, it is possible to modify the instance, which will attempt to re-register the platform
     with the VOSS Cloud Licensing Service.  A failure will rollback the configuration to the
     previous state.