| Pricing Plan | Growth |
| Available in | All countries |
This article explains how to use the Business Process Monitor for RaiseNow integrations. It provides an overview of business processes, process statuses, error handling, and how to reprocess failed integrations.
Overview
RaiseNow uses an integration layer called RICE (RaiseNow Intermediary for Customer Engagement) to transfer and transform data between RaiseNow products and connected target systems such as CRMs.
When data is received from a source system, it is referred to as a notification. The processing and transfer of that notification to the target system is called a business process.
Most integration issues are handled automatically. However, manual intervention may occasionally be required, especially when invalid or incomplete data is submitted.
The Business Process Monitor provides visibility into:
- Process status
- Processing history
- Error messages
- Failed integrations
- Manual reprocessing options
Access the Business Process Monitor
- Open the Business Process Monitor:
https://merchantadmin-app.rnw.io/ - Log in using your RaiseNow Hub credentials.
|
Note: If you do not have access, contact the Customer Success team. |
Process overview
The process list provides an overview of all business processes.
You can filter processes by:
- Search term
- Date and time
- Data category
- Status
- Process type
You can also view metrics for individual data categories.
Search for business processes
Search by identifier
You can search for specific identifiers using quotation marks.
Examples:
Transaction identifiers
"c1e2c16880q2698"
"bc240568-fe50-4f2e-a6c5-faf579f9528b"
Business Process identifiers
"1188b8e6-97e4-446d-ba92-0ff1db636a08"
Search by error message
You can search for specific error messages to identify similar failures.
Example:
"stored_campaign_id"
To exclude a specific error:
!"stored_campaign_id"
Understanding process statuses
| Name | Description | intermediate status | action |
|---|---|---|---|
| Execution Succeeded | Final status for successful BP | no | Can't be edited or re-executed |
| Failed Permanently | Final status for failed BP | no | Try to fix it by re-execution or by editing the BP notification data |
|
Failed Transiently |
Failed BP with automatic-retry | yes | wait |
| Failure Ignored | Explicitly ignored failed BP | no | Can be edited and re-executed if needed |
| Manipulation Failed | BP Specification differs from a previous version, thus the manipulation (edit, re-execution) failed | no | Let RaiseNow Support know, if transfer to target system is needed |
| Non Executable | BP in testmode in production or other way around | no | nothing |
| Execution Pending | BP is just in processing | yes | wait |
| Update Requested | BP update was requested (after editing notification data) | yes | wait |
| Resumption Requested | BP re-execution was requested (without editing notification data) | yes | wait |
Data categories
Usually you will get two RICE Instances for your integration with the target system. The "Production" data category will be preselected by entering the Business Process Monitor.
The data category only decides which notification should be processed and which not.
By setting up the instances you decided to which target system data should be transferred:
- Production
- UAT
- Sandbox
- Dev
- Test
| Name | Description |
| Non Production | Shows all BPs processed in your Non Production instance. BPs in this instance only accept notifications which state a test mode otherwise BPs will end in status Non Executable. We explicitly avoid (and don't recommend) sending test mode data to your production target system. |
| Production | Shows all BPs processed in your Production instance. BPs in this instance only accept notifications which state a production mode otherwise BPs will end in status Non Executable. It is possible to send production data to your test target system. |
|
Important: RaiseNow does not recommend sending test data to production systems. |
Process types
Process types vary depending on the connected target system. A process type defines how a specific notification is processed and transferred to the target system. You can use process types as a filter in the Business Process Monitor.
Process details
Opening a business process displays:
Original notification
The left panel shows the original notification received by RICE.
Processing steps
The right panel displays all processing steps executed by RICE.
If an error occurred, the last step typically contains the error message that caused the failure.
Additional options include:
- Edit notification
- Re-execute process
- Ignore failure
- View process history
Edit a notification
In some cases, you can correct the original notification and reprocess it.
Important formatting rules
Notifications may use different formats depending on the source system.
For example, standard E-Payment Platform notifications use query strings:
parameter1=value1¶meter2=value2
When editing notifications:
- Keep the original format intact
- Ensure parameters remain separated by
& - Only change the required values
|
Warning: Incorrect formatting can prevent successful reprocessing. |
Re-execute a failed process
After editing a notification:
- Open the process details.
- Select Update and Request Execution.
- Wait for the process to be re-executed.
Re-execution typically starts within a few seconds.
During processing, the status changes to:
- Update Requested
- Resumption Requested
Refresh the process until a final status is displayed.
Possible final statuses include:
- Execution Succeeded
- Failed Permanently
- Manipulation Failed
- Non Executable
Ignore a failed process
If a failed process has already been handled manually, you can mark it as ignored.
Examples:
- The data was manually imported into the target system
- Reprocessing would create duplicate records
Ignore a process
- Open the failed process.
- Select Ignore Failure.
- Enter a reason.
- Save the change.
|
Important: Always document why a process was ignored. This helps prevent accidental reprocessing and duplicate records in the target system. |
Comments
0 comments
Article is closed for comments.