AX2375

GetSystemInfo function

Returns information about the current Axiom Software system.

Syntax

GetSystemInfo("SystemInfoCode")

The following codes can be used for the parameter SystemInfoCode:

Code	Description
AppserverURI	Returns the application server URI for the current Axiom Software installation.
ClientType	Returns the current client context for the Axiom file, such as Excel, Windows, Web, iOS, Scheduler, and Server. NOTES: If you view an Axiom form in the Excel Client or Windows Client, the result of this function is "Web" because the file is being viewed as a web page. In this circumstance, the Web Client is effectively operating within the Excel or Windows Client. If you view an Axiom form on an iPad, the result of this function is "iOS" if the form was opened using the Axiom iPad app. If the form was opened using the Safari browser on the iPad, then the result of this function is "Web". "Server" is returned when a workbook is being processed in order to service a system request made to the application server. Currently this only applies to process management when reading assignments from assignment workbooks.
CurrentLanguage	Returns the two-letter code for the language of the current client session.
DefaultRemoteDataConnection	Returns the name of the default remote data connection for the system. If the system does not have any defined remote data connections, it returns blank. For more information, see Managing remote data connections.
DBMS	Returns the type of database being used with the system (for example: SQLServer).
HelpURL	Opens an Axiom Software Help topic, given a context-sensitive help ID. For more information, see Using GetSystemInfo to display help topics.
EngineType	Returns the spreadsheet engine being used for processing the Axiom file: Excel or Web.
ProductVersion	Returns the Axiom Software version number.
SystemName	Returns the name of the system that the user is currently logged into.

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell.

Remarks

GetSystemInfo is a non-volatile function.

Examples

=GetSystemInfo("SystemName")

This example returns the name of the current Axiom Software system. For example: "Portland Bike Strategic Planning".

=GetSystemInfo("ProductVersion")

This example returns the Axiom Software version number. For example: "2019.1.10.21".

=GetSystemInfo("ClientType")

This example returns the current Axiom Software Client type. For example: "Web".

=GetSystemInfo("AppserverURI")

This example returns the URI to the application server for the current Axiom Software installation. For example: "http://ServerName/Axiom".

=GetSystemInfo("CurrentLanguage")

This example returns the code for the language of the current client session. For example: "en" if it is English.

Using GetSystemInfo to display help topics

You can use GetSystemInfo within a Hyperlink function to link to specific topics in the Axiom Software help files. You may want to link to a topic from within a file to provide the file's users with easy access to more information about a particular subject. You can link to the general Axiom Software help files, or to product-specific help files.

To do this, use the following syntax for GetSystemInfo:

GetSystemInfo("HelpURL","TopicID","HelpType","Product")

Parameter	Description
HelpURL	Use the keyword `HelpURL` to generate a URL to the help files.
TopicID	Optional. The ID of a specific help topic. If a topic ID is specified, the URL opens that help topic. For the general (platform) Axiom Software help file, the topic ID is the file name of the topic, minus the file extension. For example, if the file name for the topic is "Batch.htm", then you would enter "Batch" as the topic ID. The file name for each topic can be found in the lower right-hand corner of the topic, in the topic footer. Product help files may use different IDs. If the topic ID is omitted, or if the specified ID cannot be found in the target help system, the URL opens the default home page for the target help system.
HelpType	Optional. The type of help system to open. You can specify the following: `Desktop`: Opens the Desktop Client help file for the Axiom Software platform. This is the default option if the parameter is omitted. `Web`: Opens the Web Client help file for the Axiom Software platform. `Product`: Opens a product help file, as specified in the Product parameter.
Product	The name of an Axiom Software product, such as Capital Planning or Budget Planning. This is required if `Product` is specified in the HelpType parameter, and ignored otherwise. The product name must exactly match the installed feature name.

The GetSystemInfo function generates a URL, which can then be placed within Excel's Hyperlink function to generate a clickable hyperlink in a file. For example:

=HYPERLINK(GetSystemInfo("helpurl","Batch"),"Get help on batch processing")

The generated URL automatically points to the help file for the current platform version or product version.

NOTES:

Although Axiom will make every effort to maintain existing help IDs, there is no guarantee that help IDs will remain constant from release to release. The introduction of new features and enhancements in a release may necessitate reorganizing existing information, which may include changing help IDs or moving information to different topics.
This function is intended to be used within an Axiom file, to dynamically generate a live URL that a user can consume within the file. It is not intended to generate a persistent URL that can be copied and pasted to an external location and used at any time.