Epicor Kinetic Put BAQ (UBAQ) activity

Introduction

An Epicor Kinetic Put BAQ (UBAQ) activity, using its Epicor Kinetic connection, updates data for a Business Activity Query in Epicor Kinetic and is intended to be used as a target to consume data in an operation.

To use this activity, the Epicor Kinetic instance must support BAQs.

Create an Epicor Kinetic Put BAQ (UBAQ) activity

An instance of an Epicor Kinetic Put BAQ (UBAQ) activity is created from an Epicor Kinetic connection using its Put BAQ (UBAQ) activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity instance in Component reuse.

An existing Epicor Kinetic Put BAQ (UBAQ) activity can be edited from these locations:

The design canvas (see Component actions menu in Design canvas).
The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure an Epicor Kinetic Put BAQ (UBAQ) activity

Follow these steps to configure an Epicor Kinetic Put BAQ (UBAQ) activity:

Step 1: Enter a name and select a company
Provide a name for the activity and select a company.
Step 2: Select a ubaq service
Select a UBAQ service.
Step 3: Review the data schemas
Any request or response schemas are displayed.

Step 1: Enter a name and select a company

In this step, provide a name for the activity and select a company. Each user interface element of this step is described below.

Epicor Kinetic Put BAQ (UBAQ) activity configuration step 1

Name: Enter a name to identify the activity. The name must be unique for each Epicor Kinetic Put BAQ activity and must not contain forward slashes / or colons :.
Select Company Name: This section displays companies available in the Epicor Kinetic endpoint.
- Selected Epicor Kinetic Service: After a company is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of companies. The search is not case-sensitive. If companies are already displayed within the table, the table results are filtered in real time with each keystroke. To reload services from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload services from the Epicor Kinetic endpoint. This may be useful if services have been added to Epicor Kinetic. This action refreshes all metadata used to build the table of services displayed in the configuration.
- Selecting a company: Within the table, click anywhere on a row to select a company. Only one company can be selected. The information available for each company is fetched from the Epicor Kinetic endpoint:
  - Name: The name of the service.
  - Type: The type of the service.
  - Object Description: The description of the service.
Tip

If the table does not populate with available services, the Epicor Kinetic connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Optional settings: Click to expand an additional optional setting:
- Continue on error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.
- Send blank values to Epicor: When selected, any null/empty values in the data schema's fields are included in request payloads. When unselected (default), any null/empty values in the data schema's fields are excluded from request payloads.
- Request Timeout: Specify the timeout for the request (the default is 15 seconds):
  - Request Time: Enter the numerical value to be used for the timeout (in milliseconds or seconds, depending on the unit of Time selected).
  - Time: The unit of time for the request timeout, either Milliseconds or Seconds.
  Note
  
  This setting will override the Request Timeout configured in the Epicor Kinetic connection.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a ubaq service

In this step, select a UBAQ service. Each user interface element of this step is described below.

Epicor Kinetic Put BAQ (UBAQ) activity configuration step 2

Select a UBAQ Service: This section displays UBAQ services available in the Epicor Kinetic endpoint.
- Selected Epicor Kinetic UBAQ Service: After a UBAQ service is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of UBAQ services. The search is not case-sensitive. If UBAQ services are already displayed within the table, the table results are filtered in real time with each keystroke. To reload UBAQ services from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload UBAQ services from the Epicor Kinetic endpoint. This may be useful if UBAQ services have been added to Epicor Kinetic. This action refreshes all metadata used to build the table of UBAQ services displayed in the configuration.
- Selecting a UBAQ service: Within the table, click anywhere on a row to select a UBAQ service. Only one UBAQ service can be selected. The information available for each UBAQ service is fetched from the Epicor Kinetic endpoint:
  - Name: The name of the UBAQ service.
  - Type: The type of the UBAQ service.
  - Object Description: The description of the UBAQ service.
Tip

If the table does not populate with available UBAQ services, the Epicor Kinetic connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Epicor Kinetic Put BAQ (UBAQ) activity configuration step 3

Data schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

The Epicor Kinetic connector uses the Epicor REST API, available in a Swagger UI from https://<epicor-host-name>/Server/api/help/. Epicor REST Services version 1 is supported. Epicor REST Services version 2 is not supported. Refer to the API documentation for information on the schema fields. (A login to Epicor is required; substitute your Epicor host name in the above URL.)

The Put BAQ (UBAQ) activity supports XML in its request and response schemas.
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Epicor Kinetic endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Edit: Click the edit icon above each data schema to enter the editor for that data schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to [0, 1] cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint. After making schema edits, a last-edited date is displayed along the top of the applicable schema to indicate the schema has had manual edits. Refreshing the schemas will reset the schemas to their default structures.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an Epicor Kinetic Put BAQ (UBAQ) activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Epicor Kinetic Put BAQ (UBAQ) activities can be used as a target with these operation patterns:

Transformation pattern
Two-transformation pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.