Rules

Change the product's behavior in your approval or production environment, without the need to deploy the system again. The customized service can be implemented in any programming language, as long as it complies with the endpoint contracts provided by a service and uses one of the available protocols: SOAP 1.1 or REST/JSON, both HTTP.

Endpoint contracts are available in the graphical interface itself, where it is possible to configure extensions that point to customized services. Customizations are made through extensions, with three types of extensions being allowed on the platform: functionality, rule point and webhook.

There are three possible operating methods for customizations:

• Before: the customized service will receive the request before reaching the destination service and must change the request input data, as desired, and return the changed data;
• After: the customized service will receive the response from the original target service and must change the result, as desired, and return the changed data;
• Intercept: the request will be forwarded to the custom service that is responsible for processing the input data and providing the appropriate output data. It is important that this method is used with care, as its use may violate existing business rules or even cause the flow of other services to stop working properly.

Types of Headers

• Tenant: tenant information in the call;
• User: user who is using the service. This information can be useful for restrictions and auditing, for example;
• Timeout: responsible for informing the service's efficient response time. Can be used to configure error messages if the response takes a long time to occur;
• Token: current user authorization token. Allows other API calls to be made with this user in custom code;
• Custom: allows the customizer to pass headers with fixed values to the rule.

Statistics

Track the execution details of customizations made to APIs or rule points. A panel will open that contains the data transmitted, the period, the total number of customized requests, the execution duration, as well as the number of successful requests, with an internal error, for example 500, and with a call error, such as 400. Go to Technology > Customization > Rules > Rule points or Features (API), select the desired primitive and clickActions >Details.

What do you need to do:

Register an extension

1. Access Technology > Customization > Rules > New customization;
2. In search primitives, search for the primitive you want to customize;
3. click inSelect on the action button of the desired primitive;
4. Choose the protocol (REST or SOAP 11) used;
5. Select the method type;
6. Enter the type of history you want to keep;
7. Enter the URL to connect the servicecustomization. If you don't have a URL to provide, clickGenerate URL;
8. Add tags to make customization easier to search and identify. Limit customization to one user if desired;
9. Add a description to identify the customization;
10. InHTTP Headers, enable or disable available headers and add new ones in Custom header, if necessary;
11. click inTest connection to ensure communication of customization;
12. Then clickTo save;
13. To discard the changes, clickCancel.

Important

On the administration screen, manually activate each extension created so that it starts running.

Perform the connection test by making an Options call to the URL entered in the customization. It is essential that the customized service is prepared to receive this call. The option to Download Swagger or Download WSDL will be displayed just below the protocol. It can be downloaded and used as a contract to be followed during customization.

Edit an extension

1. Access Technology > Customization > Rules > Rule points or Features (API);
2. Click on the check box to disable the desired customization;
3. click inActions >To edit;
4. Change all fields as necessary;
5. click inTo save;
6. To discard the changes, clickCancel.

Important

An extension can be changed or deleted only if it is not active.

Delete extension

1. Access Technology > Customization > Rules > Rule points or Features;
2. Click on the check box to disable the desired customization;
3. click inActions >To edit;
4. click inDelete;
5. To discard the changes, clickCancel.

Important

An extension can be changed or deleted only if it is not active.