Model: data/ClientShapeDestination

ClientShape Destinations

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

In order to automate the retrieval of the VOSS license audit files from the system to deliver them to VOSS as required, the files can automatically be uploaded to the ClientShape portal.

The integration and automation is carried out by:

Capturing and activating customer organization details on ClientShape from VOSS-4-UC:
- Set Up the Clientshape Destination
- Set up a Web Proxy for Licensing Delivery
Automatic inclusion upload of license audit files to ClientShape when the system runs an internal schedule to generate monthly license reports.
- Licensing Destinations and Formats

This model stores parameters for transferring a file to ClientShape.

Model Details: data/ClientShapeDestination

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title															Description																				Details
Organization ID *															This can be obtained from the Customer Portal on the Company Information page.																				Field Name: organization_id Type: String
Customer account information *															Installation description used to identify a specific instance.																				Field Name: description Type: String
Installation Type *															Indication of the type of installation.																				Field Name: environment_type Type: String Choices: ["Lab", "Production"]
File format *															Format of the file to be sent to this destination. Anonymous files do not contain the provider/reseller/customer names, whereas detailed files do. ZIP files include a hash which can be used to identify tampering.																				Field Name: format Type: String Choices: ["Anonymous ZIP", "Detailed CSV"]
File Upload Active															Make ClientShape upload active.																				Field Name: active Type: Boolean
Web proxy															Proxy for external HTTP(S) access																				Field Name: proxy Type: String Target: data/WebProxy Format: uri
Authentication token															Authentication token used for connecting to ClientShape.																				Field Name: token Type: String Store Encrypted: True