Coupa connection
Introduction
A Coupa connection, created using the Coupa connector, establishes access to Coupa. Once a connection is configured, you can create instances of Coupa activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Note
This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Host Name or Client ID in this connection requires users to re-enter the API Key or Client Secret (depending on the selected Authentication Type) the for the connection.
Create or edit a Coupa connection
A new Coupa connection is created using the Coupa connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Coupa connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a Coupa connection
Each user interface element of the Coupa connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Coupa connection and must not contain forward slashes
/or colons:. This name is also used to identify the Coupa endpoint, which refers to both a specific connection and its activities. -
Host Name: Enter the Coupa host URL, in the format of
https://<instance_name>.<host_name>.com. -
Authentication Type: Select the authentication type, either X-COUPA-API-KEY or OAuth 2.0.
-
API Key: When X-COUPA-API-KEY is selected as the Authentication Type, enter the API key for the Coupa instance. For information on API keys, see API Key Deprecation FAQ in Coupa's documentation.
-
Client ID: When OAuth 2.0 is selected as the Authentication Type, enter the client ID for the Coupa instance.
-
Client Secret: When OAuth 2.0 is selected as the Authentication Type, enter the client secret for the Coupa instance.
-
Grant Type: When OAuth 2.0 is selected as the Authentication Type, the Client Credentials option is automatically populated as the grant type.
-
Scope: When OAuth 2.0 is selected as the Authentication Type, enter a space-separated list of scopes that the app requires (optional).
-
Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
-
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps
After a Coupa connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available: