How to Customize Deeplinks for ISV Integration
- Ondřej Tesař
The purpose of deep links is to enable dynamic link usage through the Groovy API and simplify adjustments to link structures. In other words, this allows links to be easily added, or edited in PlatformManager and then used within the Pricefx application via Groovy API.
This feature allows you to add and edit the URLs of links to Enable, which are then sent to the partition’s Advanced Configuration Options and stored in the isvConnection_pages file in JSON format.
Example of the isvConnection_pages file:
{
"enable": {
"baseUrl": {
"tradingPrograms": "https://uk-dev.trading-programs.enable.com",
"collaborator": "https://collaborator-dev.enable.com"
},
"channelId": "pfx-int-dev-2",
"pages": {
"isvEnableProgramLinesPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Schemes/Deals/{{id}}",
"isvEnableSettingsPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Schemes/Edit/{{id}}",
"isvEnableTermsPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Schemes/Terms/{{id}}",
"isvEnableApprovalsPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Schemes/Approval/{{id}}",
"isvEnableAnalysisPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Schemes/Analysis/{{id}}",
"isvEnableProgramLinePage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Deals/Edit/{{id}}",
"isvEnableForecastingPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Modules/Forecasting/{{id}}",
"isvEnableEarningsPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/Deals/DealEarnings/{{id}}",
"isvEnableCustomersPage": "{{baseUrl.tradingPrograms}}/Client/{{channelId}}/Deals/TradingPartners",
"isvEnableProgressTracker": "{{baseUrl.collaborator}}/en-GB/uk/{{channelId}}/progress-tracker?indirectTransactions=false"
}
}
}The JSON configuration is sent from PlatformManager to the Pricefx partition either when a new ISV connection is created or when the Resend to Partition (Account > ISV Connection > Vendor tab) or Send to Partitions (Administration > Constants > Enable Deeplinks) button is clicked.
How to Edit Enable Deeplinks
Navigate to Administration > Constants > Enable Deeplinks to display the table of parameter names and their corresponding URL structures.
Update a desired link. Use placeholders like
{{baseUrl}}and{{channelId}}to maintain dynamic references.If needed, add a new link:
Click the + Add a new link button at the bottom of the table.
Enter the following details:
Parameter Name: Provide a unique name for the new parameter.
URL Structure: Define the URL using placeholders as required.
Save changes to partition’s Advanced Configuration Options by clicking the Send to Partitions button at the top-right corner of the screen.
Links are now ready to use. For more details about using links in Groovy, refer to the How to Use Links to Enable in Groovy article.
ISV Enable: Important Notes
If Enable changes its URL structure, the generated links will no longer function, and the logic will need to be adjusted accordingly.
If the
baseUrlorchannelIdis changed, previously generated links will retain their original form and will no longer work. The logic must be recalculated to ensure the links function correctly.If Enable modifies its link-generating logic structure, the current logic for generating links will cease to work and will require updates.
Related content
PlatformManager version 1.80.0