How to report ACE bugs
Required information
Bugs are registered in JIRA
note
If you don't have access to ACE JIRA, please send access request to Anurag.Sanyal@sapiens.com
- Project: Sapiens Digital Suite 2022 (DIG2022)
- Component: ACE
- Sprint: Support
When reporting a bug to ACE core team please include the following information.
- Bug Title - Title should be short and simple. It should contain specific terms related to the actual issue.
- Description - In the description section, you must briefly explain what you have done before facing the bug.
- Steps to reproduce - Describe how to reproduce the bug in step by step manner. These steps should describe the bug well enough and allows developers to understand and act on the bug without discussing to the one who wrote the bug report.
- Expected behaviour - What is the expected output from the application when you make an action which causes failure
- Actual behaviour - What is the actual output from the application when you make an action which causes failure.
- Workaround - If broken feature is working with different steps
- Environment:
- ACE version - For example 4.2.0
- ACE environment URL - For example: https://dev.ace-api.sapienspaas.com/
- Additional data if available
- Input and output data to repeat error
- Flows, API's, etc.
- Error logs
- Server logs
- Browser (via Developer tools) logs
- Screenshots/Video
- Input and output data to repeat error
note
If you post any URLs, then make sure that they are accessible by ACE team - either they are public or provide credentials.
Flow error reporting
If flow has errors, then use guide below to provide additional data
Export and attach source of flow that have failed
For example:
tags: []
steps:
- stepType: jsonata
config:
maps:
- mergeArrayItems: {}
jsonata: |-
{
'firstName': 'John'
}
targetPath: personalData
name: JSONATA Map
description: ""
condition: ""
- stepType: jsonata
config:
maps:
- mergeArrayItems: {}
jsonata: |-
{
'paymentDate': '2021.10.22',
'amount': 132
}
targetPath: payments
name: JSONATA Map
description: ""
condition: ""
- stepType: multiflow
config:
flowIds:
- exampleSubFlow
name: Multi-flow (deprecated)
description: ""
condition: ""
- stepType: jsonata
config:
maps:
- mergeArrayItems: {}
jsonata: |-
{
'premium': policy.premium
}
targetPath: result
name: JSONATA Map
description: ""
condition: ""
sampleData: {}
Export and attach source of any dependent flows that are called form failing flow
For example:
tags: []
steps:
- stepType: jsonata
config:
maps:
- mergeArrayItems: {}
jsonata: |-
{
'premium: 500
}
targetPath: policy
name: JSONATA Map
description: ""
condition: ""
sampleData: {}
Run flow in debug mode and attach flow input document when flow starts
For example:
{}
Run flow in debug mode and attach flow input document before failing step
For example:
{
"personalData": {
"firstName": "John"
},
"payments": {
"paymentDate": "2021.10.22",
"amount": 132
}
}
Attach failing step output
For example:
{
"doc": {
"personalData": {
"firstName": "John"
},
"payments": {
"paymentDate": "2021.10.22",
"amount": 132
},
"result": {}
},
"errors": [
"Error in flow 'exampleSubFlow' : Jsonata Step: Error during jsonata evaluation. jsonata:{\n 'premium: 500\n}. Err: String literal must be terminated by a matching quote"
]
}
Attach expected step output
For example:
{
"doc": {
"personalData": {
"firstName": "John"
},
"payments": {
"paymentDate": "2021.10.22",
"amount": 132
},
"policy": {
"premium": 500
}
},
"errors": []
}