Creating deep link lists (unencrypted URLs)
If you want to create unencrypted URLs, you can manually create a deep link list.
Deep link lists can be used by external parties to get access to records of a specific business object on a selection step in Planon ProCenter . The URL of a Deep link list contains a 'filter' part, which gives access to the records that match the filter criteria.
Precondition: before you can create deep link lists, you must enable the deep link functionality for the relevant business object(s). See: Configuring deep links.
Procedure
To manually configure a Deep link list you must follow a predefined format. Within that format, you can enter the relevant business object, field (currently, only Code and Order number are supported) and a field value. It is also possible to include a reference to the Planon Web Client in the URL (reference to a different Planon environment).
Procedure
1. To create an unencrypted URL, apply the following format:
<PlanonEnvironmentURL>/?dlList_BO=<BOSystemName>&dlList_NavCode=<DeepLinkNavigationCode> &dlList_FixedFilterCode=<DeepLinkFixedFilterCode> &dlList_Filter=<ParameterFieldSystemName1>:(<ParameterFieldValue1>, <ParameterFieldValue2>),<ParameterFieldSystemName2>:(<ParameterFieldValue3>)
 | Some parts of the URL formatting are mandatory and some optional. See the following step to find out which parts are required and which are optional. |
2. Specify the following information in the URL:
◦ Exactly 1 system business object, for example BaseOrder.
◦ Optional: Exactly 1 navigation definition code (the value from the Code field on the Deep link navigation step in the Deep link navigation TSI).
◦ Optional: Exactly 1 fixed filter code (the value from the Code field on the Fixed filters for deep links step in the Deep link navigation TSI).
◦ Maximum of 3 filters (system field names), comma separated.
| | • A maximum of 3 system field names can be specified as filters to create a valid URL. These must be comma separated. • The corresponding filter values must be contained within brackets. • To create a valid URL, only the following field types are supported as filters: String fields, Reference fields and Picklist fields (Descriptive and Code-descriptive). • If no Fixed filter code or Navigation definition code is specified as parameter, a system field name is mandatory as Filter. • The following characters are not supported as part of a parameter: & + % # [ ] /(), |
◦ Maximum of 20 filter values (field values) and a minimum of 1, for each filter (system field name).
| | The values must be comma separated. Each value you enter in the URL should be the look-up value for that field (in most cases this will be the code). See Look-up values in deep link filtering. |
3. Test the URL by pasting it in a browser.
Depending on the uniqueness of the parameters used, you will see one or more records displayed.
4. If the URL is valid, you can distribute it to the relevant users, for example via email.
Basic example including a Web Client reference:
https://customer-prod.cloud.com/home/BP/WebClient?dlList_BO=BaseOrder&dlList_Filter=OrderNumber:151.00
Basic example excluding the Web Client reference:
https://customer-prod.cloud.com/?dlList_BO=BaseOrder&dlList_Filter=OrderNumber:151.00
Basic example including navigation code & fixed filter code, including Web Client reference:
https://customer-prod.cloud.com/home/BP/WebClient/?dlList_BO=BaseOrder&dlList_NavCode=NavCode001 &dlList_FixedFilterCode=FF001&dlList_Filter=OrderNumber:(151.00,152.00),PropertyRef:(14)