Mapping an API response to a custom field

You can map API responses to custom fields for a partner.

This task assumes that you have an API that gives responses you want to map to custom fields. The task requires that you have an API dialog in a Partner task or Sponsor task in an activity, and that the custom fields exist on the system. Only the response of an API call can be mapped to a custom field. For information on adding custom fields, see Creating a custom field.
This task assumes that you are adding custom fields to an existing activity. To check the custom field mapping at any time after the mapping is done, you can right-click on the custom fields task and click View.
Attention: Do not map a custom field to a dialog that is completed processing after the custom field task, because the sample values (instead of the actual values) could be loaded into the custom fields. If the API dialog processing is skipped due to the entry or exit condition, then the sample response values are used as input to the custom fields task.
Note: This task is a system task and is not visible to partners when they run an activity.
  1. Sign in to the PEM Portal as a Sponsor Administrator.
  2. Select Activities > Definitions.
    The list of activity definitions is displayed.
  3. In the Actions column for the activity, click the arrow and select Edit.
    The Task Flow page is displayed.
  4. Drag the Custom Fields Task icon to the task flow workspace.
    The Custom Fields Task window opens.
  5. Enter a name for the task and click OK.
  6. Add connectors to the Custom Fields Task to add it to the task flow.
  7. Right-click on the Custom Fields Task icon and select Define.
    A custom fields assignment window opens.
  8. Click Add to add a custom field.
  9. Select the custom field where it shows Select in the Custom Field Name column.
    Note: You can remove a custom field name and value pair by selecting the check box for the custom field name and clicking Remove.
  10. Click ... to select the custom field value to map from the API response.
  11. Repeat the steps as necessary to map custom fields.
    Note: To see the mapping of custom fields, right-click the custom fields task and click View.
  12. Click OK to close the custom fields definition window.