Customize Hyperlinks
Information
PLANTA project supports three different types of hyperlinks
HL: Linked files (simple 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 Hyperlinks |
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: Create 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 the 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.
Setting parameter
DI with function | Value range |
|---|---|
ST | - |
CR | Path to the template file |
PA | Path to the temporary directory for local files |
FN | for Option 1 or 2: structure of the file name/title |
DE | Path to the paper bin.
|
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 → Subordinate data item 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 values | Column type | DB length | DF length |
|---|---|---|---|---|---|---|---|---|---|
ST | X | X | X | Defines whether the file is saved in the database (HL: File in the DB) or locally (HL: Local file) |
| 0 | Number without decimal places (4 digits) | 2 | 2 |
CR | X | Implies in the creation of local files (HL: Local file) whether and how values are copied from the standard template (with query) |
| No automatic creation | 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 |
| Error message if the path does not exist | Alpha | 80 | 80 | |
FN | X | X | Defines the file name/title of the saved file |
| Same file name as external file | Alpha | 80 | 80 | |
DE | X | X | Defines the trash bin path | - | Alpha | 80 | 80 |
Note
The directory in which the files from the database (HL: file in the DB) are temporarily stored is specified in the Hyperlink path data field in the Skins module per skin.
If no path is stored here, the standard temp directory is used.
Embed
Procedure
Open Customizer → Module Customizer → Data Areas
Insert the required data area.
Insert the required hyperlink DI.
The value in the DF behavior field is automatically set to h.
If necessary, change the value to ho manually.
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 as if it had ho DF behavior.