Previous Topic: Set Up the Hyperlink Customization FileNext Topic: Add a Hyperlink Using a CA-Provided CSV

Using the Quick Links Module › How to Add a Discipline Hyperlink › Review Required Information

Review Required Information

The following information is required:

Quick Link Schema:
URL

Unique resource address that launches a browser-based interface when a user clicks the hyperlink. This hyperlink can point to any accessible URL. For example, an external web site, an internal web application within your organization running elsewhere, a web application running under the same JBoss instance as CA Chorus.

Note: If you want to pass data, for example: passticket and username, as part of the URL, use a URL that supports POST requests.

When a hyperlink requires dynamic information, use variables (for example, server and port) and a velocity script so you do not have to enter hard-coded values. Note the following velocity script rules:

  • Embed the entire URL expression in double quotes.
  • Escape each double quote included inside the velocity expression with another double quote. For example, see the $USERID expression.
  • Place any SQL provided inside $db.oneResult() in double quotes. Escape these quotes with another set of double quotes.

The following list details current variables and how to use them in a velocity script:

Note: For the following $db.oneResult references, this function can take any valid SQL expression and can return exactly one value, which is the first column of the result set. The SQL expression can be anything that Teiid can execute.

$SERVER

#set ($server = $db.oneResult(""CALL chorus_platform_config.config_map_get('server')""))

This chorus_platform_config stored procedure takes a key to the global map in CA Chorus, which returns the corresponding value.

$PORT

#set ($port = $db.oneResult(""CALL chorus_platform_config.config_map_get('port')""))

This chorus_platform_config stored procedure takes a key to the global map in CA Chorus, which returns the corresponding value.

$USERID

#set ($userid = $db.oneResult(""CALL chorus_platform_config.get_chorus_user()""))

This chorus_platform_config stored procedure identifies the user ID.

$PASSTICKET

#set ($passticket = $db.oneResult(""CALL chorus_platform_config.generate_passticket('$userid','applid')""))

This chorus_platform_config stored procedure takes user ID and applid and returns the passticket.

Label

Clickable text to launch the URL.

Description

Text that appears below the hyperlink label in the Quick Links module.

Icon URL

Absolute URL of the icon that appears next to the hyperlink label and description in the module. This link can point to any accessible URL, which may or may not be on the same JBoss server as CA Chorus.

If you do not have an absolute URL, use the CA icon at chorus_install_directory/resources/resources/images/icons/Support-Icon_32_A.png

Section Name

Text that is used to group related hyperlinks and display them under a tab. This text is the tab header label.

Values: DB2 Administration, Infrastructure Management, Security Administration, Storage Administration,

Note: You can also enter your own section name, such as General.

Role

Column that determines to which discipline this hyperlink belongs.

Values: CHORUS.ROLE.DB2DBA, CHORUS.ROLE.INFRASTRUCTURE, CHORUS.ROLE.SECURITY, CHORUS.ROLE.STORAGE, CHORUS.ROLE.NONE

Note: By specifying CHORUS.ROLE.NONE, you indicate that the link is to appear in the module regardless of the disciplines to which the user has access.