Chart URL Parameters (version 24)

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

• Chart
• TimeDuration
• TimeEnd
• TimeMode
• SourceTag
• SourceTag[]
• InactiveTimeout
• Mode=ChartOnly
• ProviderName
• apiToken

Chart

The chart parameter can be used to load a specific chart or a new one. If loading a specific chart, the entire filepath must be included.

https://AxiomServer#chart=Public\Subfolder\ChartName
https://AxiomServer#chart=New

TimeDuration

The timeduration parameter is used to set the duration for the chart. The expected value format is a relative duration or an actual duration. Relative durations are numbers followed by the unit of time. For example,

• 1d = 1 day
• 12h = 12 hours
• 30m = 30 minutes
• 60s = 60 seconds

Standard durations are formated as d.hh:mm:ss where 1.12:00:00 would be 1 day and 12 hours.

https://AxiomServer#chart=ReadOnly\ChartName&timeduration=4h
https://AxiomServer#chart=Private\Canary\ChartName&timeduration=15.00:00:00

TimeEnd

The timeend parameter is used to set the ending datetime of the chart. The expected value format is: MM/DD/YYYY h:mm:ss AM/PM.

https://AxiomServer#chart=Public\ChartName&timeend=08/05/2021 4:30:00 PM

TimeMode

The timemode parameter is used to determine if the chart should be in Live mode or not. The expected value is Pause or Live.

https://AxiomServer#chart=Private\Subfolder\Chartname&timemode=Live
https://AxiomServer#chart=ReadOnly\Subfolder\Chartname&timemode=Pause

SourceTag

The sourcetag parameter is used to add a single tag to a chart. The expected value format is: ServerName.DataSetName.TagName or ViewName.BranchName.TagName.

https://AxiomServer#chart=New&sourcetag=AxiomServer.DataSet.TagName
https://AxiomServer#chart=New&sourcetag=VirtualViewName.Branch1.Branch2.TagName

SourceTag[]

The sourcetag[] parameter is used to add multiple tags to a chart. The expected value format is: ServerName.DataSetName.TagName or ViewName.BranchName.TagName.

https://AxiomServer#chart=New&sourcetag[]=AxiomServer.DataSet.Tag1&sourcetag[]=AxiomServer.DataSet.Tag2
https://AxiomServer#chart=New&sourcetag[]=VirtualViewName.Branch1.Tag1&sourcetag[]=VirtualViewName.Branch1.Branch2.Tag2

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#chart=Public\ChartName&inactivetimeout=900000

Mode=ChartOnly

The Mode=ChartOnly parameter is used to hide the Chart menu button in the top-left corner so a user cannot save or open other charts/applications. The user is still able to change the chart, but cannot save it.

https://AxiomServer#chart=Public\ChartName&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#chart=Public\ChartName&providername=kerberos

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#chart=Public\ChartName&apitoken=11111111-2222-3333-4444-555555555555