Home >

AX2360

GetDocumentHyperlink function

Creates a hyperlink to a file in the Axiom Budgeting and Forecasting for Higher Education file system, which can be used to:

• Launch the Axiom Budgeting and Forecasting for Higher Education system
• Automatically open a specified file

The intent of this function is to create a hyperlink that is then emailed or otherwise given to a user so that they can open the file directly, without needing to manually open Axiom Budgeting and Forecasting for Higher Education and find the file. If you simply want to link to an Axiom file from within another Axiom file, use the GetDocument function instead.

GetDocumentHyperlink can also be used to create a URL for use in Axiom forms (for example, in content tags for Formatted Grid components).

TIP: Alternatively, you can right-click a document in Axiom Explorer to copy a URL for that file to your clipboard.

Syntax

GetDocumentHyperlink("DocumentPathorID", "ClientType", "SheetFilter", "Language", "CellAddress")

Parameter	Description
DocumentPathorID	Optional. The file for which you want to create a hyperlink. If omitted, the current file is assumed. You can specify a file other than the current file by entering either of the following: The document ID of the file, such as 93. The full path to the file, such as \Axiom\Reports Library\Monthly Reports\Income Statement.xlsx.
ClientType	Optional. The client context in which to open the file. For more information, see the following section on client type options.
SheetFilter	(missing or bad snippet) Keep in mind that the target file must be refreshed in order for the temporary filter to be applied to the data. One or both of the following settings should be enabled in the file: Refresh all Axiom functions on open (if the file uses functions to return data instead of an Axiom query) Refresh data on file open (for the applicable Axiom queries)
Language	Optional. Specifies the language to use in the Axiom Budgeting and Forecasting for Higher Education session when the file is opened (assuming the client is not already open on the user's machine). By default, the client will open in the regional format specified by the user's operating system, if supported. This parameter can be used to override that behavior and open in the specified language—for example, to always open the file within an English language session. To specify a language, use the IETF standard language tags. The languages supported by Axiom Budgeting and Forecasting for Higher Education use the following tags: English: en-US Dutch: nl-NL French: fr-FR Swedish: sv-SE
CellAddress	Optional. Specifies the cell to make active when the file is opened, using normal cell reference syntax. For example: Sheet1!C3 If the specified location would not be in view normally then the file will be scrolled to that location; otherwise the file will open in its default view with the cursor placed at that location.

(missing or bad snippet) However, the Boolean values TRUE and FALSE do not need to be in quotation marks.

Client type options

If the target file for the function is a standard spreadsheet Axiom file, then you can optionally use the ClientType parameter to explicitly open the file in the Excel Client or the Windows Client using the following codes:

• Windows: Opens the file in the Windows Client.

• Excel (or XL): Opens the file in the Excel Client.

NOTE: If the Windows Client or Excel Client is specified in the function, but the user clicking the hyperlink does not have the security permission to access that client, then the user will not be able to open the file using the hyperlink.

If it does not matter which client is used to open the file, then you can omit the parameter. In this case, the file will open in whichever client the user launched last.

If the client is specified, and the user already has that client open, then the file is simply opened within that client instance. If the user has a client open, but it does not match the specified client type, then a second Axiom Budgeting and Forecasting for Higher Education instance is launched, using the specified client.

Other codes can be used in the ClientType parameter to support opening form-enabled Axiom files, and other special file types. When using one of these options, the Desktop Client is not launched:

• Forms (or Form or Web): Opens the file in the Web Client. The file must be form-enabled.

• Resource: Downloads the file as a resource. The file must be a plan file attachment, or other non-Axiom file (such as a Word file saved to the Reports Library). In this case the user is prompted to open the file in its native application, or save it locally.

• Data Diagram: Opens a Data Diagram file in the Web Client.

If you are opening one of these special file types, then it is recommended to use the appropriate ClientType code so that the Desktop Client does not launch unnecessarily.

(missing or bad snippet)

Remarks

• If a new client instance is launched as a result of the hyperlink, normal startup routines apply. After the system opens, the specified document is automatically opened, in addition to the normal startup file(s) for the user.

• The user's security settings are honored to determine if the user has the right to open the specified file. Note that if the user does not have access to the file, then the Axiom Budgeting and Forecasting for Higher Education client still launches but the file does not open. In this case, no error message is displayed to the user to let them know why the file did not open.

• (missing or bad snippet)

• The format of the generated hyperlink is different if your system uses SAML or OpenID authentication. By default, the hyperlink uses the C1 (ClickOnce) URL in order to launch the client. If you are using SAML or OpenID authentication, then the hyperlink uses the Axiom Home URL to allow for web-based authentication. This difference is not important to users except in the following cases:

  • If the authentication method of your system changes, then any hyperlinks generated using the prior authentication method may not work with the new authentication method.
  • If you are using SAML or OpenID authentication, Axiom Prompt users cannot use the hyperlinks generated in your system.

• A GetDocumentHyperlink wizard is available on the right-click context menu, and on the Axiom Designer tab.

• GetDocumentHyperlink is a non-volatile function.

Examples

=GetDocumentHyperlink(311)

This example creates a hyperlink to launch the file that has document ID 311, using whichever desktop client was last launched on the user's machine. The following examples show how the resulting hyperlink may look:

=GetDocumentHyperlink("\Axiom\Reports Library\Monthly Reports\Income Statement.xlsx","Excel")

This example creates a hyperlink to launch the specified file using the Excel Client. In this example, the file path is used instead of the document ID.

=GetDocumentHyperlink(651,"Forms")

This example creates a hyperlink to launch the specified file as an Axiom form in the Web Client. This is the only way to open a form-enabled file as an Axiom form using the GetDocumentHyperlink function. If the ClientType parameter were left blank, or if Excel or Windows were specified instead, then the source file would open as a spreadsheet in the Desktop Client instead of as an Axiom form.

=GetDocumentHyperlink()

This example creates a hyperlink to launch the current document. If you want to specify a client version in this case, you must delimit the omitted first parameter with an "empty" comma, like so: =GetDocumentHyperlink(,"Excel")

=GetDocumentHyperlink(930,,"GL;Dept.VP='Jones'",,"Report!D22")

This example creates a hyperlink to launch the file that has document ID 930. When the file is launched, a sheet filter is applied that restricts the data to VP Jones. The filter applies to all tables in the GL table type. Additionally, the cursor will be placed at cell D22 on the Report sheet.

=GetDocumentHyperlink(930,"Windows",,"en-US")

This example creates a hyperlink to launch the file that has document ID 930, using the Windows Client. The file will be opened in an English Axiom session, regardless of the regional format used by the current operating system.