Define an IQA Configuration
  • 28 Aug 2024
  • 3 Minutes to read
  • Dark
    Light

Define an IQA Configuration

  • Dark
    Light

Article summary

To define an IQA configuration

Use the IQ Anywhere Configurations tab to define one or more IQA Configurations that are used to configure an API call between Deal Manager and the Zilliant database.

Add an IQA configuration record

  1. In the Zilliant Administration application for Deal Manager, select the IQ Anywhere Configuration tab, and then select New to create a record.
  2. Enter information or make selections:
    • Configuration—Enter a name for the IQA Configuration.

    • Enable Logging—Select to log the API request and its response to the browser console. See the Troubleshooting IQA Configuration section for more information.

    • Error Field Name—If you enter a value, the IQA calls that generate an error message will enter the error code in this field. The Deal Manager Line objects have a field for this purpose: zpl__Error__c.

    • Request Timeout—Controls the timeout duration. Leave the default value unless the technical troubleshooting indicates otherwise.

    • Source Object—(Optional.) If set to the header-level Deal Manager object, it will designate this specific IQA Configuration as the default one to use when a line of that object is added.

      Tip

      We recommend leaving this field blank and instead using the Add Lines IQA option on the Product Selector Configuration to indicate which IQA Configuration to use for adding new lines to that object.

In the configuration, define two related lists:

  • IQA Formula Field Mapping—Defines which formula's value(s) need to be returned, and which line field(s) will receive those formula values.
  • IQA Input Parameter Mapping—Defines parameters that are needed by the formulas in the IQA Formula Field Mappings.

Create IQA Input Parameter Mapping record

Create records for all parameters that are needed by the formulas that you will add to the IQA Formula Field Mappings.

  1. In the IQA Input Parameter Mapping related list for the added IQA Configuration record, select New.
  2. Create a parameter record for all parameters needed for the formulas that you will add to the IQA Formula Field Mappings.
  3. For each Parameter record, enter information or make selections:
    • Input Parameter—Enter the same value that you defined in the formula or Remote Data Definition that will use this value.

    • Is Disabled—If selected, this parameter is not sent in the API call. See the Troubleshooting IQA Configuration section for more information.

    • Literal Data Type—If using a Literal Value, select the correct data type for this parameter.

    • Literal Value—If entered, this value will be sent for this parameter with the API instead of the value of a mapped line field. See the Troubleshooting IQA Configuration section for more information.

    • Parameter Field—Enter the API name for the field on the line object whose value will be assigned to the parameter when the API is called. The field must have a data type corresponding to the parameter in the formulas and Remote Data Definitions in the Zilliant backend.

    • Required for Call—If selected, the API will not be called if the field mapped to this parameter is null.

      Tip

      This feature supports a use case where this IQA call only makes sense if the user has entered a specific set of fields. For example, the user has entered five fields. So, if all five fields do not have values, then do not call IQA.

Add IQA Formula Field Mappings

Add a formula field mapping to define which formula's value(s) need to be returned, and which line field(s) will receive those formula values.

  1. In the IQA Input Parameter Mapping related list for the added IQA Configuration record, create a parameter record for all parameters needed for the formulas that you will add to the IQA Formula Field Mappings.
  2. For each Formula Field Mapping record, enter information or make selections:
    • Formula—Enter the Formula ID of the Zilliant formula that needs to be returned.
    • Field Name—Enter the API name for the field on the line object that will be given the returned value for the formula. The returned value and mapped field must have the same data type.
    • Is Disabled—If selected, this formula is not calculated nor returned by the API call. See the Troubleshooting IQA Configuration section for more information.
Note

When a Salesforce organization has multiple currencies feature activated, it adds the Currency field to each Sobject record even if it does not apply to that field.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.