Global Settings (All) MOD009ABF

Access

Customizer → Master Data → Global Settings
Customizer → Module Customizer → Modules → Global Settings

Information

In the Global Settings module, customizing objects are stored/managed
- which can, e.g., be used in different Python macros and/or value ranges (like modules, OLEs, etc.) to ensure that they can easily be interchanged system-wide.
- the settings of which (in the case of parameters) are to apply system-wide.
In the module, global settings are grouped in thematically suitable categories. Within the thematic categories the settings are displayed subdivided by class (object category).

Caution

The global settings contained in the PLANTA standard system must not be deleted.
- in the Edit Global Settings module you can delete settings you defined yourself by simply marking and deleting them.
The global settings can also be configured via the environment variables. Schema: planta__server__global_setting prefix and then the Python ID of the global setting. Read more on environment variables.
At the moment, this cannot be used to set templates. Global settings which have been set via environment variables cannot be changed in the Global Settings module. When you try to change them anyway, a respective message is displayed.

Categories and Classes

Information

The global settings are grouped in thematically suitable categories.
Within the categories, the global settings in this module are subdivided by so called so-called classes.
- Module ID
- Module variant ID
- OLE object
- Parameter
- Startup module ID
- Search results
- Template
- Dialog message ID
- Symbol ID
In the Global Settings (All) module, the settings of all categories and classes are listed and can be edited by users with customizer rights.
The parameters of the following categories are also contained in separate Global Settings modules of the respective areas of application which can also be edited without customizer rights:
- Global Settings (link)
- Global Settings (Project)

Classes: Module ID, Dialog message ID, OLE object, Parameters, Startup module ID

Information

The following procedure exemplifies how to store a module ID in the global settings. For other classes, the procedure is identical.

Store ID in Global Settings

Select Insert → Global Settings from the context menu.
The Edit Global Settings dialog module will be opened.
Allocate a name in the Name field.
Define a Python ID in the Python ID field.
Enter the module ID in the Alpha (120) field.
Select the requested class in the Class listbox, here "module ID".
Select the required project from the Category listbox.
If required, fill other fields.
Save.

Read ID from the global setting

PY

#Auslesen einer Modul-ID

from ppms.global_setting import get_global_setting_value
module_id = get_global_setting_value(python_id='', attribute='alpha120')

Details

The global_setting Python module is imported in order to be able to use the get_global_setting_value() method.

Notes

Python IDs must be usable as Python literals. They must not contain any special characters, umlauts, spaces, etc.
Python IDs must be defined uniquely in the global settings.
Individual Python IDs must start with an L and the license number.
- Example: L100_pr_datasheet
- If the customizer does not set this manually, the system will set it automatically.

Classes: Module variant ID, Restrict filter results

Information

The following procedure exemplifies how to store a module variant ID with its corresponding module ID in the Global Settings.

Store IDs in Global settings

Select Insert → Global Settings from the context menu.
The Edit Global Settings dialog module will be opened.
Allocate a name in the Name field.
Define a Python ID in the Python ID field.
Enter the module ID in the Alpha (120) field.
Enter the module variant ID in the Parameter Alpha (120) field.
Select the requested class from the Class listbox, here "Module variant ID".
Select the required project from the Category listbox.
If required, fill other fields.
Save.

Read IDs from the global setting

PY

#Auslesen einer Modulvarianten-ID

from ppms.global_setting import get_global_setting_value
mv_id = get_global_setting_value(python_id='', attribute='parameter')

Details

The global_setting Python module is imported in order to be able to use the get_global_setting_value() method.

Notes

Python IDs must be usable as Python literals. They must not contain any special characters, umlauts, spaces, etc.
Python IDs must be defined uniquely in the global settings.
Individual Python IDs must start with an L and the license number.
- Example: L100_pr_datasheet
- If the customizer does not set this manually, the system will set it automatically.

Class: Template

Store template code in Global Settings

Select Insert → Global Settings from the context menu.
The Edit Global Settings dialog module will be opened.
Allocate a name in the Name field.
Define a Python ID in the Python ID field.
Select the requested class in the Class listbox, here "Template”.
Select the required project from the Category listbox.
If required, fill other fields.
Save.
Refresh the module.
Click on in the new global setting in order to open the Edit Global Settings dialog module.
Store the template in the Template code parameter.
Save.

Read ID from the global setting

PY

#Auslesen eines Template-Codes 

from ppms.global_setting import get_global_setting_value
template = get_global_setting_value(python_id='', attribute='template_code')

Details

The global_setting Python module is imported in order to be able to use the get_global_setting() method.

Notes

Python IDs must be usable as Python literals. They must not contain any special characters, umlauts, spaces, etc.
Python IDs must be defined uniquely in the global settings.
Individual Python IDs must start with an L and the license number.
- Example: L100_pr_datasheet
- If the customizer does not set this manually, the system will set it automatically.

Global Customizing Parameters (Excerpt)

Information

Below you will find a description of all relevant parameters from the Customizing area For a description of the parameters from the Project/Portfolio and PLANTA link areas, please refer to the separate Global Settings (Project) and Global Settings (link) topics.

PLANTA customizer

Parameter name

Parameter ID

Meaning and values

Default values

Python editor

py_editor

Here you can specify the path for the editor which is, e.g., opened in the Modules module when you click on the Open Python macro editing button.

If no Python editor is stored for this parameter, the message is displayed when you click on the Call Python macro editing button (Alt + E) in the Modules module: Please define an editor!
If a wrong editor is specified, the Error executing python script: The system cannot find the specified file. message will be displayed.

C:\Program Files\Notepad++\Notepad++.exe

Miscellaneous

Parameter name	Parameter ID	Meaning and values	Default values
Standard date format	`standard_date_format`	Format which is used to interpret the date values specified in the Filter from/ Filter to fields in the customizing in case a different date format than that used in the PLANTA standard customizing is to be used, or if you generally use different date formats in the application, e.g. when using a German and an English user interface.
PLANTA Protocol Name	`planta_protocol_handler`	Protocol which is used to open the desktop client via URL. For further information, please see (en) Application Link.	planta