Application URL Parameters (version 24)

The following URL parameters can be passed in to create links for applications:

• Application
• AssetInstance
• ScreenName
• InactiveTimeout
• Mode
• ProviderName
• apiToken

Application

The application parameter is used to load a specific application in Axiom. The entire filepath must be included.

https://AxiomServer#application=Public\Subfolder\ApplicationName

AssetInstance

The assetinstance parameter is used to set the screen level asset instance and is only valid for applications that utilize screen level asset instances.

https://AxiomServer#application=ReadOnly\Line Production&assetinstance=Line 4

ScreenName

The screenname parameter is used to set the active screen of an application. This parameter is only applicable if the application has multiple screens. The expected value format is the Name property of the screen. See Screen Control for more information on screen properties.

https://AxiomServer#application=Private\ApplicationName&screenname=Screen3

InactiveTimeout

The inactivetimeout parameter is used to expire the Axiom session after the user has not performed any activity for the specified period of time. The inactivity time period is specified in milliseconds.

https://AxiomServer#application=Public\ApplicationName&inactivetimeout=900000

Mode

The Mode parameter is used to put an application in a read-only state. The user can set the value equal to ReadOnly or ChartOnly.

If Mode=ReadOnly, the application menu and edit buttons are hidden. Similarly, if any charts are embedded in the application, its chart menu and edit trends buttons are also hidden.

https://AxiomServer#application=Public\ApplicationName&Mode=ReadOnly

If Mode=ChartOnly, the application menu and edit buttons are hidden, but the user will still be able to add or edit trends if the application contains a chart.

https://AxiomServer#application=Public\ApplicationName&Mode=ChartOnly

ProviderName

The providername parameter forces the user to log in using a particular identity provider even if multiple providers are enabled in the Identity service. Options include anonymous, kerberos, active directory, and saml. If using the active directory or saml option, the user will be automatically redirected to the corresponding login page.

https://AxiomServer#application=Public\ApplicationName&providername=active directory

apiToken

The apitoken parameter is used to log in using the Canary user the API token is linked to within the Identity service. See How to Create an API Token. In doing so, the login screen is skipped entirely. It is recommended to only use this option within a local network, NOT going across the internet.

https://AxiomServer#application=Public\ApplicationName&apitoken=11111111-2222-3333-4444-555555555555