Hyperlink General Tab

Properties on the Hyperlink dialog box: General Tab

Property

Description

Values

Caption

The text that will be displayed for the hyperlink.

Any string value.

Auto Caption

Specifies whether a caption is automatically assigned. For a URL, this will display the URL. For a display, this will display the name of the display and its location in the Displays tab.

N/A

Target Type

Specifies the type of target that will be configured.

Link to a URL – a web address without query parameters.

Link to a Display – a Proficy Portal display.

Link to a WebSource – a complex web address; that is, a web address with query parameters.

Target URL

NOTE: Available when Link to a URL is selected.

Specifies the web address (URL) to be used for the hyperlink.

Example format of URL:

http://www.gefanucautomation.com

Select Report

NOTE: Available when Link to a URL is selected.

Allows you to select a pre-generated PDF report from the web server to be loaded when the user clicks the hyperlink.

N/A

Display Name

NOTE: Available when Link to a Display is selected.

Specifies the display you want to link to. Click the Browse button to select a display.

Any valid display name.

Symbol File Name

NOTE: Available when Link to a Display is selected.

Specifies the symbol file to associate with the display. To browse for a symbol file, click on the Browse button.

Any valid symbol file.

Symbol Name

NOTE: Available when Link to a Display is selected.

Displays the name of the symbol in the target display. All property/parameter-type symbols that are enabled in the target display will appear here.

All property/parameter-type symbols that are enabled in the target display.

Description

NOTE: Available when Link to a Display is selected.

Displays a description of the symbol

Any text.

Default Value

NOTE: Available when Link to a Display is selected.

Allows you to specify a default value that is passed to the symbol when the target display is accessed by the hyperlink. Any alternative methods of passing the variable to the hyperlink (e.g. system variables or linked objects) will override this default value.

Any valid value.

Pass to Display

NOTE: Available when Link to a Display is selected.

Specifies whether a value will be passed to the target display.

True – the symbol in the target display will be resolved either by the default value specified on this dialog box, or by a value that is passed to the hyperlink.

False – the symbol in the target display will not be resolved by the default value specified or by a value passed to the hyperlink. This 'False' setting must be used if the symbol value is being loaded into the target display with a symbol file, or if the value is used by the target display's default symbol file.

Base URL

NOTE: Available when Link to a WebSource is selected.

Displays the web address (URL) without its associated parameters. Click the Configure WebSource button to add or change the WebSource. When the WebSource is added, the base URL is shown, and associated parameters appear in the table below.

N/A

Name

NOTE: Available when Link to a WebSource is selected.

Displays the name of the parameter. This name is configurable only on the WebSource Editor dialog box.

N/A

Description

NOTE: Available when Link to a WebSource is selected.

Displays a description of the parameter. This description can be changed only on the WebSource Editor dialog box.

N/A

Linkable

NOTE: Available when Link to a WebSource is selected.

Indicates whether the parameter is available as a target or source for linking.

true – the parameter is available for linking.

false – the parameter is not available for linking.

Value

NOTE: Available when Link to a WebSource is selected.

The default value for this parameter that is sent to the web service, providing a value is not sent via a linked source or a system variable.

Any value that is valid for this parameter.

Variable

NOTE: Available when Link to a WebSource is selected.

The system variable that will be used to populate the value for the parameter. Click the ellipsis button to launch the Select a Variable dialog box.

See Variable Connections for a list of available system variables

See Also

Hyperlinks

Links Properties

Generating PDF Reports

WebSources

Passing Parameters Between Displays