SAP Ariba Procurement

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

OAuth 2.0 - client credentials connection type

Actions

This section shows how to perform some of the actions in this connector.

CreateChildElementSchema action

This action creates a schema file for an array of documents in the view template.

Input parameters of the CreateChildElementSchema action

For an example about how to configure the CreateChildElementSchema action, see Examples.

CreateSchema action

Creates a schema file for the specified table or view.

Input parameters of the CreateSchema action

For an example about how to configure the CreateSchema action, see Examples.

Action examples

This section shows how to perform some of the action examples in this connector.

Example - Create a child element schema

1. In the Configure connector task dialog, click Actions.
2. Select the CreateChildElementSchema action, and then click Done.
3. In the Task Input section of the connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "ViewTemplateName": "InvoiceReconciliation_SAP_createdRange",
     "ChildElement": "Payments",
     "TableName": "View_LineItems_SplitAccountings"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[
  {
    "FileData": "",
    "Result": "success"
  }
]

Example - Create a schema

1. In the Configure connector task dialog, click Actions.
2. Select the CreateSchema action, and then click Done.
3. In the Task Input section of the connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "TableName": "Views"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[
  {
    "FileData": "",
    "Result": "success"
  }
]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all the orders

1. In the Configure connector task dialog, click Entities.
2. Select Orders from the Entity list.
3. Select the List operation, and then click Done.
4. Task Input section of the connectors task, you can set the filterClause as per the customer requirement.

You must use single quotes (') to enclose the value for a filterClause. You can use the filterClause to filter records based on the columns.

Example - List all the line items

1. In the Configure connector task dialog, click Entities.
2. Select LineItems from the Entity list.
3. Select the List operation, and then click Done.
4. In the Task Input section of the connectors task, you can set the filterClause as per the customer requirement.

Example - Get an order details

1. In the Configure connector task dialog, click Entities.
2. Select Orders from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the entityId to "DO240" which is the key to be passed. To set the entityId, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "DO240" in the Input Value field and choose the entityId as local variable.

You should pass the value for entityId directly, such as "DO240". Here, "DO240" is the unique primary key value.

If passing a single entityId throws an error due to the presence of two composite keys, you can use the filterClause to pass the value, such as DocumentNumber='DO240'.

Example - Get a line item details

1. In the Configure connector task dialog, click Entities.
2. Select LineItems from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the filterClause to LineNumber='1' AND DocumentNumber='DO240' which are the composite keys to be passed. To set the filterClause, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "LineNumber='1' AND DocumentNumber='DO240'" in the Input Value field and choose the filterClause as local variable.

Example - Create a view

1. In the Configure connector task dialog, click Entities.
2. Select Views from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   {
     "ViewTemplateName": "TestView1754629881645",
     "Status": "published",
     "FilterExpressions": "[{\"name\":\"ExampleFilter\",\"field\":\"UniqueName\",\"op\":\"IN\",\"defaultValue\":[\"P011\"]}]",
     "DocumentType": "DirectOrder",
     "SelectAttributes": "[\"SubmitDate\"]"
   }
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Success": true
   }
   

Example - Update a view

1. In the Configure connector task dialog, click Entities.
2. Select Views from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field.

   {
     "Status": "published"
   }
   

5. Set the entityId in Data Mapper to the ID of the Views. To set the entityId, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   Instead of specifying the entityId, you can also set the filterClause to TestView = '1754629881645'.

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
   }
   

   An empty JSON object {}in the response indicates that the update operation was successful.