Call from an external application

You can trigger the opening of a CARL Source page directly from an external application: by adding a link to an email, a browsing portal, or other such item.

The content of the page to be opened is passed as a setting in the address.

Page address

The page address is built as follows:

CARL Source address: http://<server:port>/<context>/ for example: http://myserver:8080/xnet/.
Called-up page (see examples below) followed by ? if there are settings,
List of <setting>=<value> pairs separated by &.

To find out the address of the displayed page, use the keyboard shortcut "Ctrl+Shift+U."
The URL will appear in a pop-up.

Settings in uppercase specify:

The tab: SELECTED_TAB. The identifier of the tab can be consulted in customization mode.
The element to be opened: BEAN_ID. Its identifier needs to be known.
The displayed custom form: CUSTOM_FORM.
If the form identifier is known, it must be prefixed with "F", see example below.
But it is also possible to use the CUSTOM_FORM=x syntax to omit the custom form identifier.

They can be followed by settings forcing the values on the screen to be opened.
These settings are attributes of the object in the Dictionary.
They are given a prefix according to the object in question:

fa: The animator,

mb: The business object,

sb: The search object,

ta: The list in the search object.

Special characters must be encoded.
For instance, %20 must be written for a space and %2B for the plus sign +.

Search form examples

Form to be displayed	URL address
Asset search form.	http://monserveur:8080/xnet/equipment/material-SEL.faces
Structure point search form with custom form.	http://monserveur:8080/xnet/equipment/box-SEL.faces?CUSTOM_FORM=F124c68e7a8a-29dd
List of purchase requests, [Results] tab	http://monserveur:8080/xnet/purchase/PR-SEL.faces?SELECTED_TAB=pa_Result
[Favorites] tab of the budget list	http://monserveur:8080/xnet/budget/budgAcc-SEL.faces?SELECTED_TAB=pa_Bookmark
Work order search form with "Status" criteria initialized to "In preparation," "Pending validation," and type of work order to "CORR MAINT"	http://monserveur:8080/xnet/works/WO-SEL.faces?sb:status=[REQUEST,AWAITINGVALID]&sb:actionType=MAINT-CORR
[Macroplanning] tab filtered and positioned on the first day of the following week	http://monserveur:8080/xnet/works/WOSchedule-SEL.faces?SELECTED_TAB=pa_Result&sb:WOBeginMin={startOfNextWeek}&fa:startDate={startOfNextWeek}

Detail form examples

Form to be displayed	URL address
Detail form of Asset with identifier '1'	http://monserveur:8080/xnet/equipment/material-DET.faces?BEAN_ID=1
WR creation form with end date = the day after the current date; see Dynamic default value	http://monserveur:8080/xnet/works/MR-DET.faces?mb:expEnd={sysDate}%2B1{day}&mb:workPriority=URGENT
Inventory withdrawal form, agent and warehouse pre-filled in	http://monserveur:8080/xnet/stocks/issue-DET.faces?fa:actor=DUPONT&fa:warehouse=MAGASIN1

Special case of tree structure

The STRUCTURE_ID setting designates the tree structure to be displayed (MATERIAL, LOCATION, MAIN, etc.).
The STRUCTURE_ELEMENT_ID setting designates the identifier of the element.

Example:

Tree structure of equipment on the [Main] tab positioned on the asset with identifier '20': http://monserveur:8080/xnet/equipment/link-SEL.faces?STRUCTURE_ID=MAIN&STRUCTURE_ELEMENT_ID=20.