Coupa Read

On this page

Overview

Use this Snap to read Coupa resource records such as suppliers, by using the relevant resource APIs. You can choose the detail-level of the output and additionally use query parameters to filter the result. Moreover, you can also query a specific record by using the record's ID.


Prerequisites

  • Valid Coupa account with appropriate permissions.

Limitations

None.

Snap Views

TypeFormatNumber of ViewsCompatible Upstream and Downstream SnapsDescription
Input Document
  • Min: 0
  • Max: 1
  • Mapper Snap
  • Copy Snap
Optional. Use upstream Snaps when querying a specific resource record using the record's ID.
OutputDocument
  • Min: 1
  • Max: 1
  • Document to Binary + File Writer

JSON document containing the record details. Level of detail varies according to the configuration of the Response Type field.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (): Indicates whether the value is an expression (if enabled) or static (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (): Indicates that you can add fields in the fieldset.

  • Remove icon (): Indicates that you can remove fields from the fieldset.


Field NameField TypeDescription

Label*


Default ValueCoupa Read
Example
Coupa Read

StringThe name for the Snap. We recommend you update the Snap name, if there is more than one of the same Snap in your Pipeline.

Response Type


Default Valueall
Example
limited

String

Specifies the level of detail required in the Snap's output. You can configure this keeping in mind the available memory and likely processing time that it would take to execute this Snap. Available options are:

  • all: Output contains all details of the selected resource.
  • limited: Output contains only the records' ID.
  • shallow: Output contains ID as well as the direct child attributes of each record.

Learn more: API Return Formats.

API Path*


Default Value: N/A
Example: 
suppliers

String

The API name associated with the target resource. Select the target resource from the suggestions in the field. Suggestions vary based on the SnapLogic Coupa account.

When fetching resource elements such as id, (for example, suppliers/:id), you must provide the query value as an upstream parameter.

Query Parameters

Use this fieldset to define query parameters and values to filter the results of the query. See Querying Options for details.


Query Parameter


Default ValueN/A
Example: 

  • limit
  • email
  • email[not_eq]
StringThe parameter to be used to filter the results of the query. You can also include operators along with the arguments based upon your requirements. See API Operators for details.

Query Parameter Value


Default Value: N/A
Example: 

String/IntegerThe value corresponding to the specified parameter.

Snap Execution


Default ValueValidate & Execute
Example
: Execute only

Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Example

Reading and Updating Inactive Records

This example demonstrates how to read one inactive Coupa supplier record and update one of its custom fields.

Download the example Pipeline.

The Coupa Read Snaps is configured as shown below:

Use Query Parameters field-set to filter the records. The Snap fetches all the supplier records, if this filter is not applied.

Based on this configuration, the Snap fetches the topmost inactive record for the supplier named Dell (USA). 

In this example, we want to update one of the custom fields in the fetched record. To update a resource record, pass the record ID to the Coupa Update Snap. To do so, use the Mapper Snap connected to both Coupa Read and Coupa Update Snap. Additionally, provide the values to be updated. For example, custom-field-5 and John Doe in this case.

This Mapper Snap is configured as shown below:

Output from the Mapper Snap:

This data is passed into the Coupa Update Snap which is configured as shown below: 

The response type is limited; therefore, only the updated data is shown in the output: 

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the pipeline into the SnapLogic application.
  2. Configure Snap accounts as applicable.
  3. Provide pipeline parameters as applicable.

  File Modified

File CoupaUpdate_UpdatingSupplier_UsesCustomFields.slp

Nov 01, 2019 by Mohammed Iqbal

Snap Pack History

 Click here to expand...
ReleaseSnap Pack VersionDateTypeUpdates
August 2024main27765 StableUpdated and certified against the current SnapLogic Platform release.
May 2024main26341 StableUpdated and certified against the current SnapLogic Platform release.
February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.

August 2023

main22460

 

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023main21015 StableUpgraded with the latest SnapLogic Platform release.
February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
December 2022431patches19431 Latest

Fixed an issue with the Coupa OAuth2 account where the account intermittently failed when refreshing the access token.

November 2022main18944 Stable

Upgraded with the latest SnapLogic Platform release.

4.30 Patch430patches17137 Latest

The Coupa Read Snap now reads all the records (using the Next Request) even when the page has fewer records, until the zero record count.

August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.
4.29main15993 Stable
  • Added a new account type Coupa OAuth2 that enables OAuth2 authentication for all Coupa Snaps.

  • Enhanced the Coupa Create and Coupa Update Snaps with the minimum number of output views to zero.

The Coupa Account will be deprecated after 4.29 GA, as Coupa will discontinue the support of the API-based authentication in their upcoming September 2022 Release (R34). We recommend that you migrate your existing Pipelines configured with Coupa Account to Coupa OAuth2 Account immediately. Learn more: Coupa API Keys Deprecation.

4.28main14627 StableUpgraded with the latest SnapLogic Platform release.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10994 Latest

Enhanced the Snap Pack to support HTTP Proxy Authentication.

4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
Stable

Enhanced the Snap Pack to support Cross-Account IAM role that allows accessing the queues residing in another AWS account.

4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22