Using the Eloqua Bulk API Get Export Definition activity
Use the Get Export Definition activity to retrieve all export definitions from Eloqua.
Use this task to retrieve all export definitions from Eloqua. The call to this activity is a synchronous call where the input data is sent to the activity for processing and the response is sent back to the orchestration.
To configure the Eloqua Bulk API Get Export Definition activity:
- In an active orchestration, open the Activities tab and expand the Eloqua Bulk API folder contents.
- Drag the Get Export Definition activity icon onto the orchestration. The Eloqua Bulk API Get Export Definition checklist is displayed.
- In the checklist, click Summary.
- Review the contents of the Activity Name field, and make the required changes.
- In the checklist, click Pick Endpoint.
- Click Browse and use the Project Explorer dialog box to select the relevant Eloqua Bulk API endpoint.
- To make required changes to the selected endpoint configuration, click Edit to access the options in a separate window. Any changes you make globally affects all uses of the endpoint in active orchestrations.
- In the checklist, click Configure.
- Click Browse to select the object type. The Browse Eloqua Bulk API window is displayed.
- In Browse Eloqua Bulk API, you can either filter the object type by specifying the object type in the Search for an object type field, or select the object type from the object type list. Click OK. The object field preferences are displayed.
- In Object Field Preferences, select the fields that you would like to map by selecting the corresponding field name check boxes.
- In the checklist, click Retry. Review the default settings and make the required changes.
- Select the Map Inputs in the checklist. The XML schemas generated from the selected object of the Get Export Definition activity are displayed as nodes under the request input parameter in the To Activity panel.
- Create a map between the orchestration variables and the input parameter of the activity.
Mandatory Fields: The activity has the following mandatory field:
- selectionType: It is used to retrieve Export Definitions. Available terms: SPECIFIC_ID, ALL_IDs.
Optional Fields: The activity has following optional fields:
- id: The ID of the Export Definition to retrieve.
Note: ID becomes mandatory when you select SPECIFIC_ID in selectionType.
- limit: Specifies maximum number of records to return.
- offset: Specifies an offset that allows to retrieves the next batch of records.
- order: Term to be ordered in Ascending or Descending order.
- orderBy: Term to be ordered based on: uri, id, name, dataRetentionDuration, maxRecords, autoDeleteDuration, kbUsed, createdBy, createdAt, updatedBy, and updatedAt.
- Filters: Specifies query criteria used to filter . Filter uses the comparison, logic, and existence operators to filter import data based on Eloqua field values. It has following fields:
- Filter: It allows creating filter statements by using the following options:
- elename: It is used to select the data that you want to retrieve.
- operator: It is used to specify a condition.
- value: Value for filter.
- AdditionalFilters: This is used to add more than one filter.
- Operator: The Eloqua Bulk API also supports complex filters that filter based on multiple criteria using the AND, OR, and NOT operators.
- Filter: Use same parameters as defined in the Filter section.
- Filter: It allows creating filter statements by using the following options:
Note: Values must be provided at run time for any mandatory elements of the input structure. A value can be provided by specifying a default value for element or by linking the element with an input node. During run time if no value is provided for a mandatory element, the activity throws an exception, which is reported by the Web Management Console. If a value is not provided at run time for an optional input parameter, no exception is thrown during run time.
- Select Map Outputs in the checklist. The XML schema generated to hold the response of the activity is displayed as nodes under the response output parameter in the From Activity panel.
- Create a map between the output parameters and orchestration variables.
You have configured the Eloqua Bulk API Get Export Definition activity.