Customising the window display

Important: Ensure that you have the required licences when adding parameters to the URL. For example, you must be licensed for the Microsoft SharePoint web app to use modifiers. This is not limited to embedding an iFrame in another page, rather, any use of the URL modifiers.

There are a number of URL parameters to enable you to configure what is actually displayed on the Objective ECM IQ page (or in the case of an embedded web application - an iframe).

The general pattern for a URL is

https://server:port/#/<route>/?<components>&<modifiers>

where:

Parameter	Description
server:port	The Objective ECM Server name and port.
route	The location in Objective ECM. For example, on the dashboard, the route will be /dashboard and when viewing the contents of a container, it will be /documents/<container's object ID>.
components	The component(s) to display or hide.
modifiers	Additional parameters that can modify the contents of the display.
&	Separate multiple components and modifiers using "&".

For example, to hide the menu bar enter https://objective.com:8443/#/dashboard/?menu=false. For mobile phones, the menu links in will be hidden.

You can have a number of parameters in a single entry, e.g., https://server:port/#/[route]?[queryParam_1]=<true|false>&[queryParam_2]=<true|false>&...

Once hidden, you can show the components again, by either:

Changing false to true.

For example, https://objective.com:8443/#/dashboard/?menu=true

Deleting the component name from the URL.

For example, https://objective.com:8443/#/dashboard

Route

A route is a location within Objective ECM, displaying specific information. If a route is not specified, it defaults to /dashboard.

Route	Description
/dashboard	Displays the user’s dashboard.
/mydocuments	Displays the contents of the user’s My home folder.
/handy	Displays the contents of the user’s Handy folder.
/documents	Displays the user’s My home folder.
/documents/<container Id>	Displays the contents of a container.
/documents/<object Id>/details	Displays the details of an object, including: general metadata information any applicable catalogue information audit trail history version history (for documents only).
/tasks	Displays all tasks assigned to the logged-in user.
/documents/search?query=<query text>	The results of a specific search.
/form/start/<workflow Id>	Displays a workflow start form for the specified workflow, allowing users to initiate a workflow.

Components

By defining parameters in the URL, different components of Objective ECM IQ can be shown or hidden. The major components are:

Multiple components may be enabled and disabled by specifying each one separately in the URL. For example, to hide the menu bar and the Navigation pane, a URL would include https://server:port/#/<route>/?menu=false&nav=false.

Note: Objective ECM is a responsive interface. This means that the display changes according to the available screen size. Some components are only applicable to a 'mobile' layout (i.e., a narrow screen).
By default, all applicable components are displayed.
Once a component is "hidden", it will remain hidden until it is either explicitly shown or the URL parameter is removed.

Parameter	Query parameter	Applicable routes	Screen size	Description
Logo	logo	All	All	Display or hide the Objective ECM logo.
User drop-down menu	profile	All	All	Shows / hides the username and options - Profile, Help, Admin (for Objective administrators only), Logout. On a mobile, the user’s profile links are hidden from .
Options	options	Details Tasks	Mobile	On a mobile, is shown / hidden in the top left-hand corner. This overrides any profile and menu parameters.
Header	header	All	All	Display or hide the app bar which includes the components: Logo User drop-down menu Search.
Menu items	menu	All	All	Display or hide the menu bar including the options: Dashboard Global My home Handy Tasks Query. On a mobile, all menu bar options from can be hidden.
Navigation browser	nav	Documents My Documents Global Handy	Tablet Computer	Display or hide the Navigation pane.

Modifiers

Additional URL parameters allow for further modification of the Objective ECM IQ display.

expanddropdownSorting the order of container contents

The order in which the contents of a container are displayed (the /documents/<container object id> route) may be modified by using the sortBy parameter.

By default, the contents are displayed in alphabetical order by name. This can be changed by appending one of the following modifiers:

Query parameter	Description
sortBy=nameDescending	Displays the contents of a folder in reverse alphabetical order.
sortBy=dateCreated	Displays the most recently created objects first.
sortBy=dateUpdated	Displays the most recently modified objects first.
?nocache=true	Forces the query to always run rather than fetch results from cache.

For example, to display the contents of a user's Handy folder in reverse alphabetical order https://server:port/#/handy/?sortBy=nameDescending.