Operation Setup in Reachware Platform

In the Reachware Platform, Operations define the communication between systems and Reachware via API endpoints. These operations can either export (retrieve data from a system) or import (send data to a system).

This guide outlines how an agent can create a new operation, set it up, and test its functionality.

Operations represent ingoing/outgoing API calls between integrated systems and Reachware.

Agents can create new operations via the “Add Operation” button.

A list of predefined systems appears for selection, complete with:

System logo
System name
Description
Status (Active / Inactive)

A search bar allows filtering systems by name.

How to Create a New Operation

Add Operation

Click “Add Operation” on the dashboard.

Select System

A list of available systems appears.
Each entry shows:
- Logo
- Name
- Description
Use the search bar to quickly find your target system.
Click on the desired system to proceed.

Fill in Operation Details

Operation General Information

Field Description
Operation Name A user-defined name to identify the operation.
Operation Type `Export` (GET/POST) or `Import` (POST/PUT/PATCH/DELETE)
System Choose from a predefined list of systems.
Operation Group Classify the operation (e.g., Customer, Invoice).

Field	Description
Operation Name	A user-defined name to identify the operation.
Operation Type	`Export` (GET/POST) or `Import` (POST/PUT/PATCH/DELETE)
System	Choose from a predefined list of systems.
Operation Group	Classify the operation (e.g., Customer, Invoice).

Professional Hint:
You can create a new Operation Group by:

1- Navigating to the System window.
2- From System List --> Actions --> View.
3- Opening the Operation Group tab.
4- Clicking “Add New Group”.

Retrieve URI

The endpoint URL used to retrieve or send data (e.g., /api/customer/{{customer_id}}).

Query Parameters

Field	Description
Key	Parameter name (e.g., `status`)
Initial Value	Default value; can be overridden during flow execution

Professional Hint:
You can define variables by wrapping values in {{double curly braces}}.
These will be filled dynamically in the Flow Template.

Request Body

Required for Import operations or when using the POST method.
JSON-formatted structure.
Supports placeholders (e.g., {{customer_name}} or {customer_id}).

Operation Variables

Field	Description
Key	Variable name used in URI/query/body
Initial Value	Optional default value; or you can leave it empty if needed

Important Notes:
These Variable can fill it in the Flow Template.

Connection Validation

Select the relevant connection.
Click “Test Connection” to verify the endpoint’s accessibility.
After successful validation, click “Run” to simulate the API operation.

Preview Data

Inspect both the HTTP Request and HTTP Response formats.
Option to download or save as .JSON for further analysis.

Save
Click Save to apply your configuration.

Professional Hint:

Request Body is only visible and applicable for:
A - Import Operations
B - Export operations using POST method

Use placeholders in body and URI for dynamic value injection.

Operation must be validated before saving or executing.

Related Topics