Product Customization
      Back to home
      1. Knowledge Base
      2. General information
      3. Product Customization

      Product Setup: Product Configuration

      The “Product Configuration” tab allows you to personalize your product field settings. This tab contains a freeze header for ease of viewing the products.

      To manage the settings, go to the System Management > Products section, choose the relevant product, and click the “Settings” button in the “Action” column.

      Read more about the Product List section in the following Knowledge Base article.

      The “Product Configuration” tab contains the following information:

      • Order: This field allows you to change the order of the data field. Click the “Move” button, and move vertically up or down the necessary data field to change its order in the table. Click the “Save” button to confirm the changes (The “Save” button is at the end of the list).

      Note: The API documentation fields will be displayed according to the following order (regardless of whether the setting is on or off):

      • Required fields (order not configurable).

      • Fields from the Product Configuration tab in saved order.

      • Optional fields (order not configurable).

      If the order of the fields in the Product Configuration tab is not saved, the fields are displayed as a default.

      • Internal Name: The name of the data field in the system (uneditable).

      • Field Name For API: Enter the name of the field that will be used as an API parameter and reflected in the API documentation.

      • Name In Reports: Enter the name of the field that will be reflected in the reports and in the filters name (the changes will apply to the Lead Details (Publisher Report), Lead Details (Buyer Report), Lead Body, Search Lead (LMS Sync), Search Call (Call Logic), and Price Reject Analysis (Details tab) reports).

      • Field Protection: Select the preferable field protection option from the drop-down list to secure sensitive data sent in the field.

      • Required: Select the “Force Required” option to change the Non-required field to required and vice versa.

      • Ping Required: Select the “Force Required” option to change the Non-required field to required and vice versa on the ping. (available for the Ping-Post Products only). 

      • Post Required: Select the “Force Required” option to change the Non-required field to required and vice versa on the post. (available for the Ping-Post Products only).

      • Field Encryption: Select the “Yes” option to encrypt the sensitive data across the system interface, including lead details or lead body reports.
      • Validator: Select the field validator type. The data input in the fields is validated according to the set validation rules. (available for custom Products only). Click the “Configure” button and select the type of validation in the “Configure validation” pop-up window (Default, String, Array, Range, Date, Date in future, Email, IP, ZIP Code, DOB, Phone Number).

      • Required: Select to change the non-required field to required. 

      • Description: Add the description of the field that will be displayed in the API documentation.

      • Format: The data input format of the field.

      • Example: The input example.

      • Visible in API (optional): Select the preferred visibility option of the field in the API documentation. To access this configuration, you have to enable it beforehand. To do so, go to the System Management > Projects Settings section and select the “LMS & Call Logic” tab. Then select the “Additional Components” sub-tab. Switch on the “Enable Configuring Product Fields Visibility in API” feature in the “Advanced Tools” block of settings. Click the “Save” button to confirm.

      • Filter: Select to enable or disable the filter. (available for custom Products only)

      Сlick the “Publisher Product API” button, and the system will redirect you to the section with the API documentation for the Product. Read more about the Publisher Products API in this Knowledge Base article.

      To export the JSON definition of the product schema displayed in the ongoing tab, along with the request and response structures in the JSON file, click the “Generate Schema” button. The system will generate a JSON file and give you an option to download it. 

      To import the downloaded product schema for further usage during the integration building process, go to the Client Management > Setup > Integration Builder section, and click the “Add New Record” button. 

      Select the “Import” option in the “Type” field, select and upload the corresponding JSON file in the “Schema file” field of the “Add New” pop-up window. Once the file is uploaded and appears in the pop-up window, select the product for the integration building in the “Product” field. 

      Click the “Add” button to complete the action. 

      Once the import process is completed, a new integration with the name that matches the imported file name will be created. The corresponding definition of the schema, the request/response structures, and all the fields and their mappings will be added to the created integration automatically.  

      Read more about the Product Setup: Disposition Statuses in this Knowledge Base article.

      Read more about the Product Setup: Extra Fields in this Knowledge Base article.

      Read more about the Product Setup: Report Custom Fields in this Knowledge Base article.

      Read more about the Product Setup: Advanced Settings in this Knowledge Base article.

      Read more about the Campaign Configuration: Global settings (Call Logic)in this Knowledge Base article.