This article discusses how URL parameters work and how they can further enhance your User experience and extend usage of the web client.
Originally published in Q3 2017 D365UG/AXUG Magazine
The awesomeness of the HTML5 client is apparent, but it might be even clearer if you know a bit on how the URL parameters work as well. These can be used to further enhance your User experience and extend the usage of the web client.
URL parameters are additional commands you can include in the URL, and they can be used to affect the way the web application works. They are placed at the end of the URL string after the ? (question mark) character, and each parameter is separated by an & (ampersand) character. The parameter can be given an attribute or value, and that is separated by the = (equal) character. The structure is like so: https://site.domain.com/page.format?parameter1=attribute¶meter2=value...
Let’s dive in!
cmp=[legal entity]
You can set a default company that the User defaults to at User Options > Preferences > Startup > Company. Use this URL parameter to override this and directly access a legal entity. If you use many companies, it will be easy to create shortcuts for each company for quick access.
NOTE: This parameter is visualized by default in the URL.
lng=[language]
You can set a default User language under User Options > Preferences > Language and Country/Region preferences > Language. However, if you like to open the solution in another language, use this URL parameter. This is great if you’re doing User training and support, work with different companies in their native languages, or if you are doing a demo.
mi=[menuItem]
Use this to go directly to any of the forms in the solution. Based on your User settings, you either go to DefaultDashboard, System- AdministrationWorkspace, EssentialsDashboard, or HcmEmployee- SelfServiceWorkspace.
NOTE: This parameter is visualized by default in the URL, and it is easy to copy it for future use.
hideSplash=true
Want to skip the splash screen? Use that. It looks like it shaves of a millisecond or two, so it isn’t that much faster. It does, however, look slightly cleaner from my standpoint.
theme=[ThemeID]
The theme ID is the number of the color palette given in the User setup. This is awesome when combined with the “cmp” URL parameter. It gives you a sense of what company you’ve launched, but be aware that you can change companies at any time.
limitednav=true
If you’re afraid you might accidentally navigate to a form you shouldn’t be in, you can use the “limitednav” URL parameter to minimize this risk. This parameter takes all navigation possibilities away.
density={21,30}
Working on both tablet and on a computer? There are two different types of grid density in the solution, high(21) and low(30). Select your pixel density by using this URL parameter. This is the same as selecting a different grid density in the User options. Example: &density=21 is best suited for desktop and &density=30 is best suited for tablet/touch.
prt=[partitionID]
If you have a solution that is partitioned, you can use this to quickly go to the right one. The feature is deprecated, but it still works. For instance, the Contoso database public sector partition can be accessed by writing: prt=ps. You can get an overview of the partition by entering f=PartitionAdministration (replacing the mi parameter). Note that partitions have their own User access, so you would initially access it with the system master User. Thanks to Ievgen Miroshnikov for pointing this out.
f=[formName]
Some forms don’t have menu items. Like “SysTableBrowser” *, “jmgClock”, “WHSWorkExecute”, and “jmgWorkPlanner”. These are some forms that are in the system, but they aren’t accessible through the menus. This replaces the “mi” parameter.
* This requires you to also use the parameter tableName=[TableID]
q=[queryString]
If you activate the “URL manipulation” parameter under your User settings > Preferences, you’ll find that when doing a filter or record lookup, you’ll get a query string directly in your URL. I assume that this is the query string that is created by the deep links generator. This is described in the Operations Wiki.
Mode={trial,mobile}
The mode selector does access features that you might otherwise not have access to. The “trial” attribute starts a trial experience, and the “mobile” attribute gives the User access to the mobile application builder feature.
debug=develop
This gives you the opportunity to debug the application directly in the web client. It gives you a little indicator right next to the legal entity (company) selector on the top menu bar, and clicking it gives you details on the client performance.