Navigation
Lead / Send Request Scenario
General
Design
APIs
Sidebar
basics:urlparameter
Table of Contents
Available URL Parameter
Construction of URL
After setting up your personalized pCon.ui, a base URL will be provided. By adding different URL parameters, you can control the layout of pCon.ui as well as the entry point. The final URL will then be used as iframe source on the website. The links for articles are constructed as follows:
Basic Parameters for showing an article
In the following, you get a list of all the available URL parameters you can use. But you don't have to build the iframe source manually - you can use our Admin Panel to create the iframe source URL automatically during navigation through the catalog / articles.
| Parameter | Presence | Description | Value |
|---|---|---|---|
GATEKEEPER_ID | mandatory | personalized ID | provided by EasternGraphics |
moc | optional | manufacturer or catalog can be changed, if you have access to more than one catalog or manufacturer | e.g. EG |
ban | optional | base article number must be a valid article number for the chosen catalog (manufacturer) | e.g. 4520 |
sid | optional | series id must be available if a base article number is used in several series | e.g. OFFICE2 |
ovc | optional | OFML variant code requires the corre- sponding base article number (ban) | e.g. 4520 |
cep | optional | catalog entry point | e.g. egroffice%3A0 |
crp | optional | catalog root path, defines reachable level of the catalog, needs to be part of cep, deactivates the search field | e.g. egroffice%3A0 |
obx | optional | Load obx file from URL | URL to obx file (url encoded) |
Deep links to folders (used in cep / crp) are unstable and can break with OFML data updates. Hence, you should use the parameters cep and crp with care or only for first level (manufacturer id).
Parameters for changing behavior of 3D view
| Parameter | Presence | Description | Value |
|---|---|---|---|
fso | optional | show preview in full screen mode, hides property editor at right side | Boolean: true or false |
pim | optional | show pim pictures in bottom of 3d view | Boolean: true or false |
alpha | optional | sets the alpha rotation (x-axis) for custom camera view (needs to be set with beta) | number |
beta | optional | sets the beta rotation (y-axis) for custom camera view (needs to be set with alpha) | number |
ltt | optional | lock article at center of 3D view toggles the default | Boolean: true or false |
rrz | optional | Restrict rotation to z-axis, automatically activates ltt | Boolean: true or false |
sb | optional | sets scene background toggles the default | white, radiantgrey, black, transparent |
sibd | optional | Show OAP interactors by default | Boolean: true or false |
lengthUnit | optional | define length unit used for measurements | shorts from this table |
are | optional | enable autorotate starting after 5000 milliseconds / defined autorotate delay (see ard) toggles the default | Boolean: true or false |
ars | optional | define autorotation speed unit is frame per second | number |
ard | optional | define autorotation delay unit is milliseconds | number |
cmib | optional | minimal beta angle for restricting movement | number should be between '-90' and '90' |
cmab | optional | maximal beta angle for restricting movement | number should be between '-90' and '90' |
Parameters for changing Article Property view
| Parameter | Presence | Description | Value |
|---|---|---|---|
emp | optional | Enable Metatypes toggles the default; should be true Attention: breaks some OFML-data and deactivates OAP interactors | Boolean: true or false |
lang | optional | controls the language depends on the OFML data, the GUI itself supports one of Supported Languages | language code |
ofmlLang | optional | Controls language of OFML data by default the GUI language is used | laguage code |
sh | optional | show breadcrumb navigation header toggles the default | Boolean: true or false |
msi | optional | Show manufacturer in subinfo toggles the default | Boolean: true or false |
sph | optional | Show names of property groups as headlines in property list | Boolean: true or false |
sup | optional | Show uneditable properties toggles the default | Boolean: true or false |
ssi | optional | Show series in subinfo toggles the default | Boolean: true or false |
san | optional | Show article name toggles the default | Boolean: true or false |
asi | optional | Show article number in subinfo toggles the default | Boolean: true or false |
hde | optional | hide description below property list, toggles the default | Boolean: true or false |
sp | optional | show price, toggles the default | Boolean: true or false |
tax | optional | country code for VAT, toggles the default Only applicable if gross prices are used | Country code according to ISO 3166-1 alpha-2 (e.g. DE or FR@ECO for French ECO contribution) |
other parameters
| Parameter | Presence | Description | Value |
|---|---|---|---|
cad | optional | activates cad download function (only if CAD Formats have been ordered) | Boolean: true or false |
adv | optional | switches the article drawer variant | single or modular |
pev | optional | Switches property editor layout | full or compact |
HOOK_URL | mandatory if you want to show the “add to cart” button |  Shop only - defines the URL the OCI data is transferred to has to be HTML encoded if parameters within the URL are used | URL / encoded string e.g. https%3A%2F%2Fexample.de%3Fveryownparameter%3Dtrue third party encode tool |
upd | optional | Shop only - Changes the ADD TO CART button text to UPDATE CART useful for Reconfiguration | Boolean: true or false |
customFields | optional | transfer custom information to service APIs more information: CustomFields | encoded string e.g. user%3Dtrue |
basics/urlparameter.txt · Last modified: by Karolin Merten