To access these settings, go to the System Management > Products section, click the “Settings” button in the “Actions” column for the selected product, and select the “Extra Fields” tab.

To add a new field, click the “Add Extra Field” button and fill in the following fields in the pop-up window:

  • Internal Name: Enter the name of the field.

  • Name In Reports: Enter the name of the field that will be reflected in the reports and in the filter names.

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

  • Preparation: Select the preferable way of data processing for this field from the drop-down list.

    • Trim: The option removes the blank spaces for the received data.

    • To digits: The option accepts only the numerical data.

    • String to upper: The option converts data to the upper-case letters.

    • YMD: The option converts a date to YMD format (year, month, date).

    • Email: The option for the email input.

    • Postcode: The option for the ZIP code input.

  • Validator: Select the type of the field based on which data will be validated according to the set rules:

    • Array: The values will be validated based on the list of the accepted values. Fill in the “Comma-separated list of valid arguments (ex.: test, test, test)” field to list all the values separated by commas.

    • String: The field type for the string data input. Fill in the “Min line length” and “Max line length” to determine the accepted string length.

    • Range: The field type for the numerical data. Fill in the “Min value” and “Max value” to set the range of the accepted values.

    • Date: The field type for the date input.

    • Email: The field type for the email input.

    • IP: The field type for the IP address input.

    • Zip: The field type for the ZIP code input.

    • DOB: The date of birth input field.

FILTERS: Fill in the following fields to add a new filter option for the field:

  • Title: Fill in the name of the filter.

  • Type: Select the preferable filter type:

    • No filter: Select this option if the filter is not needed.

    • Integer value: The option allows you to assign the value properties.

    • Select from list: The option allows you to add a filter with the drop-down selection.

    • Radio-buttons: The option allows you to add a filter with the radio button selection.

    • Checkbox group: The option allows you to add a filter with the checkbox selection.

    • Comma-separated numbers: The option allows you to list the numerical data using commas.

    • Comma-separated text: The option allows you to list the data using commas.

    • Integer value (min): Fill in the minimum value length allowed for the filter.

    • Integer value (max): Fill in the maximum value length allowed for the filter.

  • Description: Fill in the filter description.

  • Is required: Define the field requirement settings.

    • Select the “Force Required” option to make the field required.

    • Select the “Not Required” option to make the field non-required.

  • Encryption: Define the field encryption settings.

    • Select the “Encrypted” option to encrypt the data in the field.

    • Select the “Not encrypted” option to leave the data unencrypted.

  • Value type: Select the field data type (Text / Integer / Float number / Boolean).

  • Format for API: Add the format example for the field that will be displayed in the API documentation. Examples: Numeric only, 10-11 digits long; One of the following: [YES, NO].

  • Example for API: Add the usage example for the field that will be displayed in the API documentation.

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

Click the “Create” button to confirm.

To edit the field properties, click the “Edit” button.

To remove the field, click the “Delete” button.

Please note that you cannot create duplicates of existing parameters.

Did this answer your question?