Customize Hyperlinks

Information

• PLANTA project supports three different types of hyperlinks
  • HL: Linked files (real hyperlinks)
  • HL: Local files
  • HL: Files in the DB
• They differ in their filing procedure and filing directory as well as in their file editing procedure.

Details

• All path specifications can also be made in UNC notation.

Note

• Due to the different modes of application of the 3 hyperlink types, we recommend that you use one hyperlink type throughout the system.

See also: Information on the use of the hyperlink

Customize

Note

• Hyperlinks can also be edited with the methods of the Hyperlink class of the Python API.

Hyperlink: Linked Files

Procedure

• Open Customizer System Customizer Data Dictionary.
• Select the required data table.
• Create a data item with Column type = HL: Linked file.

Hyperlink: Local Files / Hyperlink File in the database

Create Hyperlink DI

• Create a data item with Column type = HL: Local file or HL: File in DB in the Data Dictionary module.

Create function DIs for the hyperlink-DI.

• Create a data item for each function to be defined in the Data Dictionary module according to the required hyperlink behavior.
  • Description of the possible functions: see Function Table
• Define the value range for the function DI in the Data Items module if necessary.

Setting parameter

DI with function	Value range
ST	-
CR	Path to the template file
PA	Path to the temporary directory for the local files
FN	for Option 1 or 2: Structure of the file name/title
DE	Path to the paper bin. If no path is deposited, the Windows paper bin is used by default.

Assign function DIs to the Hyperlink DI as sub-DIs

• Customizer System Customizer Data Items
• Insert hyperlink DI.
• Right-click on the data item record.
• Select Insert Sub-DI from the context menu.
• Assign the function DIs to the hyperlink DI as sub-DIs.
• Define the Function and Option parameters according to the function table.

Functions

Function	Mandatory	Local	DB	Description	Option	Default value	Column type	DB length	DF length
ST	X	X	X	Defines whether the file is saved in the database (HL: File in DB) or locally (HL: Local file)	0: Local file 1: File in the database	0	Number without decimal place (4 digits)	2	2
CR		X		Implies whether in the creation of local files (HL: Local file) it is copied from the standard template automatically, and how (with query)	0: arbitrary creation of file or or link 1: Create if blank, from template and without prompts 2: Create from template, with prompts (Message: [DI name]: Copy file from template This message is also displayed if DIs were customized in window 9. 4: Create from template, always compulsorily without prompts	Do not create automatically	Alpha	80	80
PA	X	X		Implies, where the local files (HL: Local file) are to be stored and what happens if the path does not exist	0: Error message, if the path does not exist 1: Create path after consultation 2: Create path without consultation	Error message if the path does not exist	Alpha	80	80
FN		X	X	Defines the file name/title of the saved file	0: File name from source 1: File name according to value range 2: File name according to value range + File name from source	Same file name as external file	Alpha	80	80
DE		X	X	Defines the paper bin path	-		Alpha	80	80

Note

• The directory in which the files from the database (HL: File in DB) are stored temporarily is specified in the Hyperlink path data field in the Skins module for each skin.
  • If no path is stored here, the standard temp directory is used.

Embedding

Procedure

Note

• If the Output parameter is activated on the data area that contains the hyperlink or if the make_output() Python function is used, the hyperlink behaves like with DF behavior ho.