Using the Coupa Retrieve activity

Use the Coupa Retrieve activity to retrieve objects in the Coupa instance.

Use this task to retrieve all objects based on ID in the Coupa instance. 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.

  1. In an active orchestration, open the Activities tab and expand the Coupa folder contents.
  2. Drag the Retrieve activity icon onto the orchestration. The Coupa Retrieve Object Checklist is displayed.
  3. In the Checklist, click Summary.
  4. Review the contents of the Activity Name field, and make the required changes.
  5. In the Checklist, click Pick Endpoint.
  6. Click Browse and use the Project Explorer dialog box to select the relevant Coupa endpoint.
  7. Optional: You can create the endpoint by clicking New and specifying the required connection details. Click OK to save and use the endpoint for this configuration.
  8. 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.
  9. In the Checklist, click Configure.
  10. Click Browse to select the object type. The Browse Coupa window is displayed.
  11. In Browse Coupa, 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.
  12. In Object Field Preferences, select the fields that you would like to map by selecting the corresponding field name check boxes.
  13. In the Checklist, click Retry. Review the default settings and make the required changes.
  14. Select the Map Inputs in the Checklist. The XML Schemas generated from the selected object of the Retrieve Objects activity are displayed as nodes under the request input parameter in the To Activity panel.
  15. Create a map between the orchestration variables and the input parameter of the activity.
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.
  1. Select the 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.
  2. Create a map between the output parameters and orchestration variables.

Table: Map Inputs parameters

Field Name Description
retrieveAll If the user wants to fetch all the records of a particular object type, then he should set this parameter to true. Default value is false. The parameter is ignored if value for id is specified.
limit Applicable only if retrieveAll is true. The parameter is used to paginate the results. It will limit the number of records retrieved to the specified value. The maximum number of results returned are 50 at a time even if the limit value is given more than 50.
offset Applicable only if retrieveAll is true. The parameter is used to paginate the results. The records are retrieved starting from the specified offset.
id The object id for which data has to be retrieved. This parameter is given preference over retrieveAll, the value of retrieveAll is ignored if id is specified.
supplier-id The associated supplier id. Applicable only for RemitToAddress object.

You have configured the Coupa Retrieve Objects activity.

Note: You can add more than one object as input to this activity. To add more than one object as input, right click the ID field in the object in the To Activity pane of Map Inputs, and select Expand Occurrences.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/Coupa_using_the_coupa_retrieve_activ.html