How to create
...
an interceptor through Unity
Before all, please make sure you have Administration > Develop Interceptors role activated. It’s also important to mention that dynamic interceptors are not compatible with Ember Unity parts.
...
As you expand one of the method fields, you will see Add PRE Code, and/or Add POST Code (according to each method’s compatibility):
...
When clicking on any of them, a modal will show up:
...
With a dropdown containing available templates, and you can paste your javascript code in there.
More technical explanations about how this code is structured and what PRE and POST means are available by the end of this article.
Finally, you can test its functionality, in this case simply creating a new quote:
...
How to create an interceptor through IntelliJ
For a better user experience while development, we strongly recommend to use IntelliJ with PriceFX Studio plugin. After making sure you have the permissions as mentioned above:
Check your version of Pricefx Studio in Plugins and update the version if necessary. If the plugin is missing, install Pricefx Studio first.
Edit the Config.js file to be able to fetch and deploy your solution to the correct environment.
After creating a new Dynamic Interceptor on the Configuration > Interceptors page, you can fetch it. Select the Environment and Partition that you want to work with and locate your interceptor in the Advanced configuration. Then click the Fetch button.
The procedure is similar to deploying your solution after some changes.
After the code is deployed, use the Reload interceptor functionality.
How interceptors work
Basically, this piece of javascript code will be structured like:
...
PRE and POST methods have the same name, and for PRE ones they must have a Pre suffix, as in quotesDetailNew (POST) and quotesDetailNewPre (PRE).
TO BE DELETED FROM HERE
| Info |
|---|
This article is not exhaustive. More content will be added later. |
The interceptor is just a record in advanced configuration options. The record name has to start with a prefix pfxInterceptor_ and then it has to continue with the actual interceptor name. Correct name is for example pfxInterceptor_myFirstExperiment.
The record cannot be empty, in such a case Unity will show you an error: “The interceptor with name pfxInterceptor_myFirstExperiment was not found”.
Basic
Step 1
Interceptors are written in plain JavaScript.
The main part of the interceptor are exported constants which contain a function.
The simplest possible example is this:
| Code Block | ||
|---|---|---|
| ||
export const quotesDetailNew = () => {
console.log('Test 1');
}; |
The code above will display message Test 1 at Console tab in web browser developer tools:
...
The name of the constant quotesDetailNew, determines where and when the code will be triggered. You can find the list of possible names in Unity under System Configuration / Interceptors. When you are exporting non existing name from your interceptor, for example because of a typo, Unity will display an error with unknown method names.
Each named constant can exists in two variants, one is for the PRE action with a suffix Pre and the second one for the POST action where the suffix is omitted.
...
| language | js |
|---|
...
(
...
You don't need to implement both variants. In some cases only the PRE action makes sense, for others it is only the POST action. TBD - Explain where to use PRE & POST
Function Parameters
When Unity triggers a function which is in your exported constant, it will pass an object parameter to it. This object contains API functions and data related to the triggered action.
...
| language | js |
|---|
...
)
...
The content of the passed parameter can vary. There is a common set which you get all the time. It is under key name api and it contains generic functions which you can use in all Pricefx modules. If you know, that you will need api, you can use JavaScript shortcuts to obtain it.
| Code Block | ||
|---|---|---|
| ||
export const quotesDetailNew = ({api}) => {
api.notify.success('New quote created interceptor');
}; |
This example will show a green notification when a user creates a new quote.
Or in case that you know exactly what you need you can squeeze it a little bit more.
| Code Block | ||
|---|---|---|
| ||
export const quotesDetailNew = ({ api: { notify } }) => {
notify.success("New quote created interceptor 2");
}; |
If you have no clue what you get, you can always observe that parameter thru web browser developer tools by using the key word debugger.
...