myPLM 1.3.12 Reference -...
Transcript of myPLM 1.3.12 Reference -...
TechniaTranscat Support Hotline
Phone: +49 721 97043 74
E-Mail: [email protected]
Website
http://www.techniatranscat.com
Postal address
TechniaTranscat GmbH
Am Sandfeld 11c
76149 Karlsruhe
Germany
Copyright 2018 TechniaTranscat
Contents
TechniaTranscat myPLM 1.3.12 Reference
2
Contents
1 System requirements 4
2 Application overview 5
3 User interface description 7
4 Favorites 12
4.1 About favorites ........................................................................................................................................ 12
4.2 Add a favorite .......................................................................................................................................... 12
4.3 Edit favorites ........................................................................................................................................... 12
4.4 Export and import favorites ..................................................................................................................... 13
5 Starting myPLM 14
6 Assembled environment file 18
6.1 Contents ................................................................................................................................................... 18
6.2 Environment assembly ............................................................................................................................ 19
7 XML file structure 22
7.1 <Environments> Environment tree nodes ............................................................................................... 22
7.2 <Environment> Definition of environments, access, startable script, and parameters ............................ 29
7.3 <Setvar> Set internal variable at runtime ................................................................................................ 34
7.4 <Setenvvar> Set internal environment variable at runtime ..................................................................... 34
7.5 <Link> Reference to a link node ............................................................................................................. 34
7.6 <Include> Reference to an external part of the XML file ....................................................................... 36
7.7 <Links> Branches for re-use in environments......................................................................................... 37
7.8 <Link> Definition of a branch for re-use in environments ...................................................................... 37
7.9 <GlobalRadios> Buttons for license configuration settings .................................................................... 37
7.10 <GlobalRadio> Button for license configuration settings ....................................................................... 38
7.11 <Groups> Access condition definition .................................................................................................... 40
7.12 <Group> Access condition definition ..................................................................................................... 40
7.13 <User> Access condition definition ........................................................................................................ 41
7.14 <Host> Access condition definition ........................................................................................................ 41
7.15 <Language> GUI text localization .......................................................................................................... 41
7.16 <Translations> GUI text localization ...................................................................................................... 42
7.17 <Translation> GUI text localization ........................................................................................................ 42
7.18 <Variables> Variable definitions ............................................................................................................ 43
7.19 <Variable> Variable definition ................................................................................................................ 43
7.20 <Tools> Tools listed in the menu and toolbar ......................................................................................... 43
7.21 <Tool> entry ............................................................................................................................................ 44
7.22 <ToolSubMenu> entry ............................................................................................................................ 47
Contents
TechniaTranscat myPLM 1.3.12 Reference
3
7.23 <Options> entry ....................................................................................................................................... 48
7.24 <Option> entry ........................................................................................................................................ 49
7.25 <GUITexts> Definition of user interface text ......................................................................................... 51
8 CSIDL utility for Windows 55
9 News ticker file structure 56
10 Language support 58
11 Internal variables 59
12 License traffic plug-in 60
12.1 Introduction ............................................................................................................................................. 60
12.2 Built-in functions ..................................................................................................................................... 60
12.3 Custom functions ..................................................................................................................................... 61
13 Information modifying plug-ins 64
System requirements
TechniaTranscat myPLM 1.3.12 Reference
4
1 System requirements
Supported operating systems
myPLM runs on all operating systems where Java Swing applications are supported, including
Microsoft Windows and IBM AIX.
Java Runtime
Java Runtime Environment 1.6 or later is required.
Application overview
TechniaTranscat myPLM 1.3.12 Reference
5
2 Application overview
You can use myPLM to run applications in various configurations. Such configurations may include
application settings, a choice of product licenses, plug-ins and add-ons, files, and other aspects.
For users
Users can easily choose their required configuration in the myPLM user interface from a tree or list
and additional option panels.
Application overview
TechniaTranscat myPLM 1.3.12 Reference
6
For administrators
Administrators can define configurations in a modular fashion. myPLM provides ways to resolve
dependencies between modules, to define the priority of competing settings, and to implement user
and group permissions. myPLM allows for both central and distributed administration.
At the technical level, myPLM supports various ways of customization:
• Generate configuration files, such as CATIA environment files
• Define system variables, as used by Siemens NX and many other applications
• Set command line switches when starting an application
• Move files into place (resources, templates, configuration files, properties files for
Java applications, ...)
• Special operations using customer-specific myPLM plug-ins
• …
myPLM is the evolution of myV5. It has been designed to meet the special requirements of PLM and
CAD software like CATIA V5, CATIA V6, and Siemens NX. At the same time, myPLM is flexible
enough to work with configurations of almost any software application on Windows and major UNIX
systems.
User interface description
TechniaTranscat myPLM 1.3.12 Reference
7
3 User interface description
Menu ————
Toolbar ———–
Newsticker ——–
Applications ——
———— Company logo
–———— Add-ons
–———— Options
Message Start button Web link
User interface description
TechniaTranscat myPLM 1.3.12 Reference
8
Items marked with an asterisk * depend on the myPLM configuration and may be unused disabled by
the administrator.
File menu
Reread XML Manually reread the myPLM XML file.
Exit Exit myPLM
* Add favorite Create a shortcut to the currently selected application, add-ons, and options.
* Edit favorites Edit favorites
* (List of favorites) Select an application, add-ons, and options.
A favorite is a shortcut to a certain selection. Choosing a favorite does not
automatically start the selected application.
Options menu
* (Custom entries) Select the respective options.
Metal, Nimbus,
CDE/Motif,
Windows, Windows
Classic
User interface style of the myPLM window. The available choices depend on
the Java installation.
Tools menu
There can be several tools menus with customized names.
* (Custom entries) Start the respective tools.
Help menu
Reference Display the reference manual (for administrators)
User manual Display the user manual
* Check myPLM
update
Manually check for an update of the myPLM application.
* Check OEM
environment update
Manually check for updates of OEM environments
About myPLM Display myPLM version information
User interface description
TechniaTranscat myPLM 1.3.12 Reference
9
Expand selected
Click this button to expand the selected tree node.
Collapse selected
Click this button to collapse the selected tree node.
Expand all
Click this button to expand all tree nodes.
Expand all
Click this button to expand all tree nodes.
Help Reference
Click this button to open the reference manual.
Tools and favorites
Click these additional buttons to start a tool or select a favorite.
Tools are also available on the Tools menu or other customized menus.
Favorites and tools are only shown on the toolbar if an icon has been set. All favorites are available on
the File menu.
News ticker
The news ticker is available depending on an administrator setting. Click the news ticker to display the
next message, or to start and stop scrolling.
Company logo
In this space, a logo can be displayed. The file is myPLM_Logo.png and located in the myPLM admin
directory.
Applications
This frame shows the available applications, as defined by the administrator. Entries are shown as a
simple list or in a tree structure.
Some entries may have a context menu. In particular, the context menu for CATIA applications may
contain options to backup, restore, or delete user settings.
User interface description
TechniaTranscat myPLM 1.3.12 Reference
10
If automatic update checks are enabled, a symbol next to the environment icon indicates whether the
various OEM environments are up to date:
Check mark = The OEM environment is up to date.
Cross = The OEM environment is outdated. An update is available.
Exclamation mark = The update check has failed.
Example:
Add-ons
This frame shows add-ons available for the selected applications. Select the add-ons to start with the
application. For example, you can choose CAVA and Q-Checker as add-ons for a CATIA session.
The context menu provides an alternative way to select add-ons, and to deselect all add-ons.
Double-click the title bar of the add-ons frame to show the available add-ons in a separate dialog with
advanced options for selecting add-ons.
License configuration
Choose a license configuration.
Message
The status bar shows status messages when you start an application.
Web link
Click this area in the status bar to display a webpage. By default, this links to the TechniaTranscat
website. You can specify a different link using the the –Dbrowser command line parameter.
User interface description
TechniaTranscat myPLM 1.3.12 Reference
11
User interface style
The user interface style (“Look and Feel”) depends on the Java installation. Customized user interface
styles can be added. Search the Java online documentation at https://docs.oracle.com for “Look and
Feel”, or search the internet for plug-ins like “JTattoo”.
Example of the myPLM interface with customized user interface style
Favorites
TechniaTranscat myPLM 1.3.12 Reference
12
4 Favorites
4.1 About favorites
A favorite is a shortcut for selecting an application, add-ons, and options in the myPLM window.
All favorites appear on the File menu. Favorites with an icon are also available on the toolbar. If the
path of a favorite is unavailable, the respective menu entry and button are greyed out and cannot be
selected.
The favorites function may be disabled by the myPLM administrator.
4.2 Add a favorite
To store the currently selected application, add-ons, and license configuration as a favorite, choose
File > Add favorite.
In the favorite dialog, enter a name for the new favorite.
Optionally, you can set an icon. Favorites with an icon appear on the File menu and also on the
toolbar. Favorites without an icon only appear on the File menu.
4.3 Edit favorites
To edit favorites, choose File > Edit favorites.
Favorites
TechniaTranscat myPLM 1.3.12 Reference
13
To change the order of favorites, select an entry and click the Move up or Move down button.
To edit the selected favorite, click Edit entry. You can rename the favorite, change its icon, and
manually change its definition.
To delete the selected favorite, click Delete entry.
4.4 Export and import favorites
You can export favorites to a file, and import them again. You can use these functions to create a
backup of your favorites, or to exchange them between myPLM installations.
Export favorites
(1) Choose File > Edit favorites.
(2) Click Export.
(3) Choose a file name and location, and click Save.
Import favorites
(1) Choose File > Edit favorites.
(2) Click Import.
(3) Choose the file to be imported, and click Open.
On import, existing favorites of the same name are replaced. New entries are added at the bottom of
the list.
Starting myPLM
TechniaTranscat myPLM 1.3.12 Reference
14
5 Starting myPLM
We recommend using a command line script to start myPLM. You can create a desktop shortcut for
the command line script. An icon (myPLM_Icon.ico) is available.
This is the command line syntax to start myPLM:
<java>
[ -Dhostname=<host>]
[ -Dusername=<name>]
[ -Denv=<envname>]
[ -Ddirenv=<envdir>]
[ -Dshowref=<refcall>]
[ -Dshowtut=<tutcall>]
[ -Dbrowser=<browsercall>]
[-Dcompany=<name>]
[ -Dvar1=<val1>] ... [ -Dvarn=<valn>]
-classpath <myPLM.jar> myPLM.user.MyPLM
[ -d[n]][ -s][ -b][ -e][ -c][ -v <listfile>][-l <licfile>]
<xmlfile>[ arg1][ arg2]....[ argn]
Parameter Description
<java> Call for Java interpreter
-Dhostname=<host> Optional host name for node access.
Add the prefix ~ to convert resolved variables to lowercase.
Examples:
-Dhostname=srvmyplm
-Dhostname=%COMPUTERNAME%
-Dhostname=~%MYPLMSERVER%
-Dusername=<name> Optional user name for the node access.
Add the prefix ~ to convert resolved variables to lowercase.
Examples:
-Dhostname=srvmyplm
-Dhostname=%USERNAME%
-Dhostname=~%USERNAME%
-Denv=<envname> Name of the resulting environment without extension. This parameter
may be overridden by the <Environments> envname attribute in the
admin XML file.
Default value: “default”
Example:
-Denv=/tmp/myEnv
Starting myPLM
TechniaTranscat myPLM 1.3.12 Reference
15
Parameter Description
-Ddirenv=<envdir> Path to the resulting environment. This parameter may be overridden by
the <Environments> direnv attribute in the admin XML file.
-Dshowref=
<showref>
Command to open the reference manual.
Default value:
cmd /c start xmlpath\myPLM_1.3_reference.pdf
Example:
-Dshowref="%ProgramFiles(x86)%\Adobe\Reader\
11.0\AcroRd32.exe" myPLM_1.3_reference.pdf
-Dshowtut=
<showtut>
Command to open the tutorial.
Default value:
cmd /c start xmlpath\myPLM_1.1_tutorial.pdf
Example:
-Dshowref="%ProgramFiles(x86)%\Adobe\Reader\
11.0\AcroRd32.exe" myPLM_1.1_tutorial.pdf
-Dbrowser=
<browser>
Command to display a webpage.
Examples:
-Dbrowser="%ProgramFiles%\Internet
Explorer\iexplore.exe www.techniatranscat.com"
-Dcompany=
<company>
Text displayed in the root node of the application tree view.
Default value: “TechniaTranscat”
-D<var1>=<var1> Variables to be replaced when found in the resulting environment file, or
in the script string.
Example:
Define a variable “basedir”:
-Dbasedir=C:\V5R24
To refer to this variable in an environment, insert the variable name
surrounded by square brackets [ ]:
CATDLLPath=[basedir]\win_b64\code\bin
The variable will be resolved in the resulting environment:
CATDLLPath=C:\V5R24\win_b64\code\bin
Starting myPLM
TechniaTranscat myPLM 1.3.12 Reference
16
Parameter Description
<myPLM.jar> Path to the myPLM JAR file.
-d[n] Debug mode. This writes additional output to the console.
-d all debug information
-d1 error messages
-d2 messages
-d3 application start messages
-d4 resulting tree for user interface
-d5 variables
-d6 image loading
-d7 timing information without node access
-d8 timing information for node access
Example:
Write error messages (-d1), application start messages (-d3) and timing
information (-d7) to the console:
-d1 -d3 -d7
-s Do not show the splash screen.
-b Run in batch mode. This requires an environment file.
In batch mode, the splash screen and user interface are not displayed.
The start command is submitted immediately.
-e Do not execute the selected application when clicking the Start button.
Instead, write only the resulting environment file.
-c Treat CSIDL variables as myPLM internal variables.
You can refer to internal variables by setting their name into square
brackets. Example:
... [CSIDL_LOCAL_APPDATA] ...
Starting myPLM
TechniaTranscat myPLM 1.3.12 Reference
17
Parameter Description
-v <listfile> Read variables from the given file or URL. Variables will be resolved
when found in the resulting environment file, or in the script string.
Example:
-v c:\temp\varlist.txt
The variable list must be formed like this:
<varname>=<value>
Example:
basedir=C:\V5R24\
-l <licfile> Path to the myPLM license file
Example:
-l c:\myPLM\myPLM.lic
-x <prevsel> Select an application, add-ons, and options in the myPLM window.
In batch mode (-b), the application, add-ons, and options are started
automatically.
Example:
-x "CATIA/CATIA V5R24+Q-Checker+CAVA*HD2"
If this parameter is not set, the application, add-ons and options are read
from the most recent environment file.
<xmlfile> Path the admin XML file, or to a directory containing admin XML files.
In case of a directory, the various admin XML files are merged into one.
Each file must be a full admin XML file. Subnodes of the <Transcat>
root node are merged.
Default value: “default.xml”
Examples:
c:\myPLM\myPLM.xml
c:\myPLM\AdminFiles\
<arg1> ... <argn> All arguments are forwarded to the application started with myPLM.
These arguments are also stored in the internal variable params.
Assembled environment file
TechniaTranscat myPLM 1.3.12 Reference
18
6 Assembled environment file
6.1 Contents
File header
Example:
!----------------------------------------------------------
! DASSAULT SYSTEMES - V5 ENVIRONMENT FILE
! written by Transcat myPLM application
!----------------------------------------------------------
! MODE : Global
! TYPE : Interactif
!----------------------------------------------------------
! TreePath(4,7,544,645,278,172) User='fluff' Host='pcprog9'
! - Transcat
! - Test Environment
! - Test3344
!...+ Addon
! * CCDD
!----------------------------------------------------------
The header of the first environment file is copied to the resulting environment file. In some cases,
CATIA V5 needs this information.
! MODE: Global
! TYPE: Interactif
...
If no environment header is available, the following default header is used:
!----------------------------------------------------------
! DASSAULT SYSTEMES - V5 ENVIRONMENT FILE
! written by Transcat PLM myPLM application
!----------------------------------------------------------
! MODE : Global
! TYPE : CATIA
! TMSTMP : 1241701148
! ARGS : -cs CATIA -a global -icon no -menu yes -tools
!----------------------------------------------------------
Tree path
! TreePath(4,7,544,645,278,172) User='fluff' Host='pcprog9'
Parameters of the tree path by position:
(1) X position of the myPLM window; -1 when aligned to center
(2) Y position of the myPLM window; -1 when aligned to center
Assembled environment file
TechniaTranscat myPLM 1.3.12 Reference
19
(3) Width of the myPLM window; ignored if the value exceeds the actual screen width
(4) Height of the myPLM window; ignored if the value exceeds the actual screen height
(5) Location of the vertical divider
User: User who generated this file
Host: Host where this file has been generated
Last selection
The last selection of application, add-ons, and options is also stored in the header. myPLM needs this
information when running in batch mode:
! - Transcat
! - Test Environment
! - Test3344
! + Addon
! * CCDD
Every line must start with an exclamation mark, followed by three blank spaces.
The qualifier “-” marks selected nodes in the application tree.
The qualifier “+” marks selected add-ons.
The qualifier “*” marks selected options.
6.2 Environment assembly
After pressing the Start button, the following operations are executed:
• Collecting data from nodes and then checking add-ons information (from top to bot) in lists.
o environment file(s)
o command string
o envpar string
o cmdpar string
o close string
o additional settings directories
The default collecting order is from root node to selected node, and add-ons from top to bottom.
The collecting order may be reversed, as defined by the lastenvorder attribute of the
<Environments> node.
• Look for Setvar to be set at current environment node
• Look for Setenvvar to be set at current environment node
• Look for Setvar to be set at current add-on node
• Look for Setenvvar to be set at current add-on node
Assembled environment file
TechniaTranscat myPLM 1.3.12 Reference
20
• Adding selected radio-button settings-path to additional settings directories
• Look for Setvar to be set at current radio-node
• Read and parse the related environment files (env="…")
• Read and parse the related last environment files (lastenv="…"). The values from these files are
added as the last values of the respective environment variables.
• Testing myPLM license
• Writing environment file and execute for each variable the following operations:
o Remove multiple variable definitions
▪ sort="top" – keep first variable definition (default)
▪ sort="bot" – keep last variable definition
o Assemble values:
▪ for paths: from bot to top or vice versa;
▪ for values: use last or first value.
o Replace internal variables tagged with brackets [ ] by Java system variables (-D), <Setvar>
variables, environment variables or system environment variables.
o Replacing file separators / or \ and path separators : (UNIX) or ; (Windows) according to the
target operation system. To suppress replacement in a substring, enclose characters in grave
accents (`). For example, this is required to suppress replacing c:\ by c;\.
o Write to file. Empty variables, whose value is an empty string, are not written to the file.
• Assembling script:
o Get last script command from list: If a command line has a leading @ character, the command
line will be added to the preceding command line.
o Add optional -direnv and -env parameters.
o Add optional additional command line arguments.
o Delete User Settings in CATUserSettingPath paths
o Add options (menu) to cmdline
o Replace internal variables tagged with brackets [ ] by Java system variables (-D).
o Replacing the file separators / \ and path separators : ; according to the target operation
system; for DOS target system ;\ will be re-replaced to :\ .
o Start script.
• Closing myPLM (if for the selected node the close attribute is not ‘false’.)
Example: CATReferenceSettingPath in CATIA
The order of collecting the data from CATReferenceSettingPath is:
• Default from Variable node in XML file
• Value from selected radio button
• from root node to selected node
Assembled environment file
TechniaTranscat myPLM 1.3.12 Reference
21
• from environments files CATReferenceSettingPath variable
• from set-attribute
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
22
7 XML file structure
Overview
7.1 <Environments> Environment tree nodes ............................................................................................... 22
7.2 <Environment> Definition of environments, access, startable script, and parameters ............................ 29
7.3 <Setvar> Set internal variable at runtime ................................................................................................ 34
7.4 <Setenvvar> Set internal environment variable at runtime ..................................................................... 34
7.5 <Link> Reference to a link node ............................................................................................................. 34
7.6 <Include> Reference to an external part of the XML file ....................................................................... 36
7.7 <Links> Branches for re-use in environments......................................................................................... 37
7.8 <Link> Definition of a branch for re-use in environments ...................................................................... 37
7.9 <GlobalRadios> Buttons for license configuration settings .................................................................... 37
7.10 <GlobalRadio> Button for license configuration settings ....................................................................... 38
7.11 <Groups> Access condition definition .................................................................................................... 40
7.12 <Group> Access condition definition ..................................................................................................... 40
7.13 <User> Access condition definition ........................................................................................................ 41
7.14 <Host> Access condition definition ........................................................................................................ 41
7.15 <Language> GUI text localization .......................................................................................................... 41
7.16 <Translations> GUI text localization ...................................................................................................... 42
7.17 <Translation> GUI text localization ........................................................................................................ 42
7.18 <Variables> Variable definitions ............................................................................................................ 43
7.19 <Variable> Variable definition ................................................................................................................ 43
7.20 <Tools> Tools listed in the menu and toolbar ......................................................................................... 43
7.21 <Tool> entry ............................................................................................................................................ 44
7.22 <ToolSubMenu> entry ............................................................................................................................ 47
7.23 <Options> entry ....................................................................................................................................... 48
7.24 <Option> entry ........................................................................................................................................ 49
7.25 <GUITexts> Definition of user interface text ......................................................................................... 51
7.1 <Environments> Environment tree nodes
Parent elements: <Transcat>
Content model: <Environment> or <Include> (any number)
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
23
<Environments> attributes Description
envname Name of the resulting environment without extension
direnv Directory of the resulting environment
storeaddon Remember selected add-ons in the next session
(true/false)
Default: false
storeradio Remember selected state of radio buttons
(GlobalRadio)
true: Remember the last selected state (default)
false: Do not remember the last selected state. In this
case, the first option is selected on myPLM startup.
lookandfeel GUI style. Available options depend on the Java
runtime environment.
tickertext URL or filename of content to display in the news
ticker.
tickerback URL, file name or text for alternate ticket text. The
alternate ticker text is used if the file or URL in
tickertext is not available.
tickersleep Pause (milliseconds) between paragraphs in the news
ticker.
Default: 2000
• Negative value: News ticker paused at startup. Click
to start scrolling.
• 0: News ticker paused at startup. Click to show the
next paragraph.
• Positive value: News ticker scrolling at startup.
tickerspeed Interval (milliseconds) after which the ticker display is
refreshed with one pixel offset.
Example: A tickerspeed value of 40 means the ticker
scrolls upwards by one pixel every 40 milliseconds.
tickericon Location of news ticker icon in JPEG or GIF format.
Default setting: running cat
To hide the ticker icon, specify an image file with 1x1
pixels.
readtime Pause (seconds) before reloading the ticker text source.
Default: 10
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
24
<Environments> attributes Description
fontname Font for labels of the tree, radio buttons, and check
buttons.
Default: System default
fontsize Font size for labels of the tree, radio buttons, and check
buttons.
Default: System default
fonttype Font variation for labels of the tree, radio buttons, and
check buttons.
Values: plain, bold, italic
Default: System default
colbackselect Background color of selected items as RGB code
Default: 0,0,0
colbacknonsel Background color of unselected items as RGB code
Default: 255,255,255
colforeselect Foreground color of selected items as RGB code
Default: 255,255,255
colforenonsel Foreground color of unselected items as RGB code
Default: 0,0,0
notclogo Hide the TechniaTranscat logo at the bottom of the
window (true or false)
Default: false
nomyplmlogo Hide the myPLM logo at the bottom of the window
(true or false)
Default: false
msgtext Message in the status bar after starting myPLM. You
can define a string, or a file or URL to read.
Default: empty string
Example:
msgtext="myPLM is ready"
msgtext="c:\myPLM\msgtext.txt"
usersetmask File pattern for user settings operations
Default value: “*.CATSettings”
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
25
<Environments> attributes Description
graystartwait Start button refresh time (seconds)
Default: 2
graystartblock Start button refresh time (seconds) for the first refresh
cycle
Default: value of graystartwait
rereadtime Time after which the admin XML file is reloaded.
Positive value = hours
Negative value = milliseconds (intended for testing)
To reload the admin XML file manually, choose File >
Reload XML.
Default: never
nomyplmenvcomments Write an additional environment file named
<envname>.nocmt.txt without myPLM
comments in the header.
Values: true/false
If attribute envpar is true, this additional environment
file will be used when starting the application.
This responds to an issue from Dassault Systèmes:
Changing the header in the CATIA environment may
lead to unpredictable situations.
getcsidlexe Resolve CSIDL variables automatically before starting
CATIA. Set this attribute to the path of the
GetCSIDL2.exe tool.
See also 8 CSIDL utility for Windows
radiograynumber Value is -1: Radio button always available and selected
Value equals gifnum: Radio button unavailable; current
selection is kept
Default: -1
scriptsplit Insert a blank between the parts of the joint command
line (true/false).
Example: Assume the parts of a command line to join
are "str1" and "@str2".
a) scriptsplit="true"
Joined command line with a blank: "str1 str2"
b) scriptsplit="false"
Joined command line without a blank: "str1str2":
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
26
<Environments> attributes Description
allowemptyenvvar Variables from the CATIA environment with empty
string value are set as myPLM variables (true/false)
Default: false
favorites Enable myPLM favorites (true/false)
Default: false
See also 4 Favorites
updcheck Check for updates of the myPLM application.
Set the attribute to the user name or host group for
which to perform the update check.
Set the attribute to ‘all’ to perform the check for any
user.
updoems Check for updates of the OEM environments.
Set the attribute to the user name or host group for
which to perform the update check. Set the attribute to
‘all’ to perform the check for any user.
Leave the attribute value empty to disable update
checks.
updurl URL or file to where information about updates is
provided
pluginMyPLMStart Plug-in file path
Trigger event: After myPLM XML read/reread
pluginBeforeWriteEnvVariable Plug-in file path
Trigger event: Before writing a CATIA environment
variable
Input: Environment variable definition
Output: Environment variable definition
pluginAppendEnvVariables Plug-in file path
Trigger event: After writing all CATIA environment
variables
Output: One or more lines to append to the CATIA
environment
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
27
<Environments> attributes Description
pluginBeforeSolveVar Plug-in file path
Trigger event: Before manipulating the script attribute
value
Input: Script attribute value with unresolved internal
variables
Output: Command to execute
pluginBeforeStart Plug-in file path
Trigger event: Before executing the script attribute
value
Input: Script attribute value with resolved internal
variables
Output: Command to execute
pluginAfterStart Plug-in file path
Trigger event: After executing the script attribute value
Input: Return code from command as string
Output: Return code from plug-in
pluginMyPLMEnd Plug-in file path
Trigger event: Before myPLM exit
lastenvorder • top (default): Values from environments marked
with the attribute “lastenv” are inserted behind other
environment variables
• bot: Values from environments marked with the
attribute “lastenv” are inserted in front of other
environment variables
usersettingsallowed This controls the availability of the context menu on
tree nodes
• true (Default): Enable settings handling on tree
nodes
• false: Disable settings handling on tree nodes
Deprecated attributes
The following attributes of <Environments> are deprecated and should not be used.
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
28
To localize user interface text, use 7.25 <GUITexts> Definition of user interface text instead.
Deprecated
<Environments> attributes
Description
titletree Displayed header in tree
titlecheck Displayed header in add-ons
titleradio Displayed header in radios
titlebutton Displayed text on start button
tooltipexpsel Tooltip text
tooltipcolsel Tooltip text
tooltipexpall Tooltip text
tooltipcolall Tooltip text
tooltiphlpref Tooltip text
titlemenufile Menu text
titlemenuexit Menu text
titlemenuopts Menu text
titlemenubcks Menu text
titlemenudels Menu text
titlemenursts Menu text
titlemenutool Menu text
titlemenuhelp Menu text
titlemenuhlpr Menu text
titlemenuhlpt Menu text
titlemenuhlpa Menu text
txtusersetnothing Text user settings dialog
txtusersetbackup Text user settings dialog
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
29
Deprecated
<Environments> attributes
Description
txtusersetbckerr Text user settings dialog
7.2 <Environment> Definition of environments, access, startable script, and parameters
Parent elements: <Environments> or <Environment> or <Link>
Content model: <Environment> or <Setvar> or <Setenvvar> or <Link> or <Include> (any number)
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Environment> attributes Description
name Required. Tree node name.
Special options if the tree node is an addon node:
• Set the name “---” to display a separator instead of this node.
• Add the prefix “---“ to the name to hide the check box or radio
button for this node. The name is displayed as text for information
only.
icon Optional. Path and name of the icon file for this node. If not
specified, the node is displayed without an icon.
user Allow or deny access to this environment for certain user names.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- for case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
user="+frank;-someone;+~Test"
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
30
<Environment> attributes Description
host Allow or deny access to this environment for certain host groups.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
host="+admins;+staff;-guests"
script Command line (executable with arguments)
If the value starts with @, the string after @ is appended to the
preceding command line.
If the value starts with #, all environment variables are set before
starting the script. The environment variables are stored in the
resulting environment file in any case.
scriptpar Forward additional arguments received by myPLM to the script
(true/false)
Default: false
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
31
<Environment> attributes Description
test Hide this node based on conditions.
Conditions syntax:
f{<filename>} – Test if file is readable. Check several files with
logical operators: && AND, || OR, ! NOT
Wildcards * and ? can be used for test on file/folder.
test="f{c:\temp\file.txt}"
test="f{c:\temp\f1.txt&&c:\temp\f2.txt}"
<filename> -- Test if file is readable, short notation of f{<filename>},
cannot be combined with other conditions.
test="c:\temp\file.txt"
test="aNode??.* "
u{<username>} – Match current user name
test="u{theadmin}"
h{<hostname>} – Match host group
test="h{admins}"
v{<name> <operator> <string>} – Test a string variable.
Operators: “==” equal, “<>” different
test="v{varx==abc}"
test="v{varx<>abc}"
i{<name> <operator> <integer>} – Test an integer variable.
Operators: “==” equal, “<>” different, “>” greater, “<” less, “>=”
greater or equal, “<=” less or equal
test="i{num==123}"
test="i{num<=123}"
You can logically combine conditions:
• “&&” to combine conditions with logical AND. The “&” sign
must be escaped in XML as “&”.
• “||” to combine conditions with logical OR
• “!” to negate a result
test="f{c:\temp\file.txt}&&v{varx==abc}"
env Path and name of environment files. Separate multiple paths and
names by comma or semicolon
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
32
<Environment> attributes Description
lastenv Path and name of environment files. Values from these files are
added at the end of the respective environment variables.
envpar Add parameters –env and –direnv to the command line (true/false)
set Additional settings path to include in the CATReferenceSettingsPath
variable.
close Close myPLM after starting an application (true/false). If the node is
an addon node, this attribute is ignored.
Default: false
addon Use this node as add-on, radio button, or context menu entry.
Values:
false = This node is not an add-on node (default)
check = Add-on check box, not selected
checked = Add-on check box, selected
uncheck = Add-on check box, not selected; the setting from the last
written environment is ignored.
radio = Radio button
fixed = Add-on check box, permanently selected
fix = Add-on check box, permanently deselected
hidden = Add-on check box is selected and hidden
context = Context menu entry, inherited by all children of the
parent node. Use the script attribute to specify the command to
execute. myPLM variables can be used.
denystart Disable the start button for this environment (true/false)
adminstart Enable the start button for this environment for certain users and
groups.
This setting overrides denystart="true".
graystart Disable the start button if the specified file exists.
Example:
graystart="c:\temp\lock.txt"
batchnode Node only accessible in batch mode (true/false)
contextmenu Enable a context menu:
“CATIA” or not set (default): Handling of CATIA user settings
Other string: Title of customized context menu
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
33
<Environment> attributes Description
display Display this text instead of the name attribute.
filter Default value for the live filter in the add-ons shuttle
updoem Identifier for the currently installed OEM environment. This identifier
is required for OEM environment update checks.
gifnum When using a multi-layer GIF as icon, this variable defines the
number of the layer to be displayed (1,2,3, ...). The value can be a
fixed number or can be calculated by functions.
For built-in and custom functions see 12 License traffic plug-in.
groupname Addon check box nodes (check, checked, fix, fixed, uncheck, hidden)
with same groupname attribute values are grouped into a combo box.
Only one item of the combo box can be selected.
The combo box has the icon (icon, gifnum) and permissions (user,
host) attributes of the currently selected item; all other attributes are
taken from the first grouped addon node.
Example:
<Environment env="catia1.env" icon="catia.gif"
name="CatiaV5-1" script="...">
<Environment addon="check" env="cv1.env"
icon="cava.gif" name="CAVA-1"/>
<Environment addon="check" env="qc1.env"
groupname="qc" name="Q-Checker1"/>
<Environment addon="check" env="qc2.env"
groupname="qc" name="Q-Checker2"/>
<Environment addon="check" env="vd0.env"
groupname="vda" name="VDAFS-0"/>
<Environment addon="check" env="vd1.env"
groupname="vda" name="VDAFS-1"/>
</Environment>
The combo boxes in this example look like this:
context This attribute is deprecated and should not be used.
Use addon="context" instead.
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
34
7.3 <Setvar> Set internal variable at runtime
Parent elements: <Environment> or <Link> or <GlobalRadio>
Content model: empty
The attributes are required.
<Setvar> attributes Description
name Required. Name of the internal variable.
value Required. Value of the internal variable
7.4 <Setenvvar> Set internal environment variable at runtime
Parent elements: <Environment> or <Link> or <GlobalRadio>
Content model: empty
The attributes are required.
<Setenvvar> attributes Description
name Required. Name of the internal environment variable.
value Required. Value of the internal environment variable
7.5 <Link> Reference to a link node
Parent elements: <Environment>
Content model: empty
A <Link> node in <Environment> context has no child elements. See also 7.8 <Link> Definition of a
branch for re-use in environments.
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Link> attributes Description
name Required. Name of the internal variable.
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
35
<Link> attributes Description
promote Promote the referenced link node to siblings and children of this node
(true or false). The referenced link node also requires the attribute
promote="true".
Example:
<Environments>
<Environment name="E1" ... >
<Link name="L1" promote="true"/>
<Environment name="E12" ... >
<Environment name="E123" ... />
</Environment>
<Environment name="E2" ... >
<Link name="L2"/>
<Environment name="E22" ... >
<Environment name="E223" ... />
</Environment>
</Environments>
...
<Links>
<Link name="L1" promote="true">
<Environment name="A" addon="radio"/>
</Link>
<Link name="L2" promote="true">
<Environment name="B" addon="radio"/>
</Link>
</Links>
The fragment of the environment above is equivalent to the following
fragment with resolved links. Note that the referenced content of link
“L2” is not promoted to siblings and children.
<Environments>
<Environment name="E1" ... >
<Environment name="A" addon="radio"/>
<Environment name="E12" ... >
<Environment name="A" addon="radio"/>
<Environment name="E123" ... >
<Environment name="A" addon="radio"/>
</Environment>
</Environment>
<Environment name="E2" ... >
<Environment name="B" addon="radio"/>
<Environment name="E22" ... >
<Environment name="E223" ... />
</Environment>
</Environments>
...
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
36
7.6 <Include> Reference to an external part of the XML file
Parent elements: <Transcat> or <Environments> or <Environment> or <Links> or <Link> or
<GlobalRadios> or <GlobalRadio> or <Groups> or <Variables> or <Tools> or <ToolsSubMenu> or
<Options>
Content model: empty
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Include> attributes Description
name Required. File path, folder or URL of the external XML part.
In case of a folder, the folder will be scanned for *.xml files to
include.
user Allow or deny access to this <Include> node for certain user names.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- for case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
user="+frank;-someone;+~Test"
fallback If an include, defined by the name attribute, is not found, one or more
fallback includes can be defined, separated by comma.
Example: Include file inc00.xml; if not found, try inc02.xml; if this is
not found either, try inc01.xml
<Include name="inc00.xml"
fallback="inc02.xml,inc01.xml"/>
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
37
7.7 <Links> Branches for re-use in environments
Parent element: <Transcat>
Content model: <Link> or <Include> (any number)
The <Links> node has no attributes.
7.8 <Link> Definition of a branch for re-use in environments
Parent elements: <Links> or <Environment>
Content model: <Environment> or <Setvar> or <Setenvvar> or <Link> or <Include> (any number)
See also 7.5 <Link> Reference to a link node
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Link> attributes Description
name Required. Name of the link
promote Allow promotion of the referenced link node to siblings and children
of the linked node (true or false). The referenced link node also
requires the attribute promote="true".
7.9 <GlobalRadios> Buttons for license configuration settings
Parent element: <Transcat>
Content model: <GlobalRadio> or <Include> (any number)
Attributes are optional. If an optional attribute is not set, myPLM will assume default values.
See also 7.5 <Link> Reference to a link node
<GlobalRadios> attributes Description
startable Double-click a radio button to run the script command specified in
<GlobalRadio> nodes (true/false).
Default: false
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
38
7.10 <GlobalRadio> Button for license configuration settings
Parent element: <GlobalRadio>
Content model: <Setvar> or <Setenvvar> (any number)
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<GlobalRadio> attributes Description
name Required. Name of the radio button.
Special options:
• Set the name “---” to display a separator instead of this node.
• Add the prefix “---“ to the name to hide the radio button for this
node.
icon Required. Path and name of the icon file for this node.
set Additional settings path to include in the CATReferenceSettingsPath
variable.
user Allow or deny access to this button for certain user names.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
user="+frank;-someone;+~Test"
host Allow or deny access to this button for certain host groups.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
host="+admins;+staff;-guests"
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
39
<GlobalRadio> attributes Description
script Command line (executable with arguments)
If the value starts with @, the string after @ is appended to the
preceding command line.
If the value starts with #, all environment variables are set before
starting the script. The environment variables are added to the
environment in any case.
test Hide this node based on conditions.
Conditions syntax:
f{<filename>} – Test if file is readable
test="f{c:\temp\file.txt}"
u{<username>} – Match current user name
test="u{theadmin}"
h{<hostname>} – Match host group
test="h{admins}"
v{<name> <operator> <string>} – Test a string variable.
Operators: “==” equal, “<>” different
test="v{varx==abc}"
test="v{varx<>abc}"
i{<name> <operator> <integer>} – Test an integer variable.
Operators: “==” equal, “<>” different, “>” greater, “<” less, “>=”
greater or equal, “<=” less or equal
test="i{num==123}"
test="i{num<=123}"
You can logically combine several files to check:
“&&” to combine checks with logical AND. The “&” sign must be
escaped in XML as “&”.
“||” to combine checks with logical OR
“!” to negate a result
test="f{c:\temp\file.txt&&
c:\temp\file2.txt}"
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
40
<GlobalRadio> attributes Description
gifnum When using a multi-layer GIF as icon, this variable defines the
number of the layer to be displayed (1,2,3, ...). The value can be a
fixed number or can be calculated by functions.
For built-in and custom functions see 12 License traffic plug-in.
display Display this text instead of the name attribute.
7.11 <Groups> Access condition definition
Parent element: <Transcat>
Content model: <Group> or <Include> (any number)
Example:
<Groups>
<Group name="Group01">
<User name="obelix" />
<User name="asterix" />
</Group>
<Group name="Group02">
<User name="Santana" />
<Host name="pccad01" />
<Host name="pccad02" />
</Group>
<Group name="Group03">
<Host name="pccalc01" />
</Group>
...
</Groups>
7.12 <Group> Access condition definition
Parent element: <Groups>
Content model: <User> or <Host> (any number)
<Group> attributes Description
name Required. Name of the group
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
41
7.13 <User> Access condition definition
Parent element: <Group>
Content model: empty
<User> attributes Description
name Required. User name belonging to the group.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
7.14 <Host> Access condition definition
Parent element: <Group>
Content model: empty
<Host> attributes Description
name Required. Host name belonging to the group.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
7.15 <Language> GUI text localization
Parent element: <Transcat>
Content model: <Translations> (any number)
Example:
<Language name="lang">
<Translations name="titletree">
<Translation name="de" text="Programme"/>
<Translation name="en" text="Programs"/>
</Translations>
<Translations name="titlecheck">
<Translation name="de" text="Zusatzsoftware"/>
<Translation name="en" text="Additional Software"/>
</Translations>
</Language>
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
42
<Language> attributes Description
name Variable name for the language setting
7.16 <Translations> GUI text localization
Parent element: <Language>
Content model: <Translation> (any number)
For an example, see 7.15 <Language> GUI text localization.
<Language> attributes Description
name Name of GUI text variable
7.17 <Translation> GUI text localization
Parent element: <Translations>
Content model: empty
For an example, see 7.15 <Language> GUI text localization.
<Language> attributes Description
name Language ID
text Localized string
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
43
7.18 <Variables> Variable definitions
Parent element: <Transcat>
Content model: <Variable> (any number)
7.19 <Variable> Variable definition
Parent element: <Variables>
Content model: empty
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Variable> attributes Description
name Required. Variable name
type Path or value for assembling
Values: path, value
Default: value
keeporder Do not split values with multiple paths from a single environment
(true or false).
Default: false
value Default value
sort Sort order
Values:
• top (assembly from top to bottom)
• bot (assembly from bottom to top)
Default value: top
7.20 <Tools> Tools listed in the menu and toolbar
Parent element: <Transcat>
Content model: <Tool> or <ToolSubMenu> or <Include> (any number)
Example:
<Tools>
<ToolSubMenu name="Quality" title="TechniaTranscat">
<Tool name="Q-Monitor" title="TechniaTranscat"/>
</ToolSubMenu>
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
44
<Tool name="Editor" script="notepad.exe"/>
<Tool name="Rechner" script="calc.exe"/>
...
</Tools>
7.21 <Tool> entry
Parent elements: <Tools> or <ToolSubMenu>
Content model: empty
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Tool> attributes Description
name Required. Tool name in the menu
icon Required. Path and name of the icon file for this node.
user Allow or deny access to this button for certain user names.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
user="+frank;-someone;+~Test"
host Allow or deny access to this button for certain host groups.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
host="+admins;+staff;-guests"
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
45
<Tool> attributes Description
script Command line (executable with arguments)
If the attribute value starts with @, a variable can be set to a value:
script="@<varname>=<value>"
This is useful for language switching:
script="@LANG=EN"
title Title of the menu where this menu item is located.
Default: “Tools”
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
46
<Tool> attributes Description
test Hide this node based on conditions.
Conditions syntax:
f{<filename>} – Test if file is readable. Check several files with
logical operators: && AND, || OR, ! NOT
test="f{c:\temp\file.txt}"
test="f{c:\temp\f1.txt&&c:\temp\f2.txt}"
u{<username>} – Match current user name
test="u{theadmin}"
h{<hostname>} – Match host group
test="h{admins}"
v{<name> <operator> <string>} – Test a string variable.
Operators: “==” equal, “<>” different
test="v{varx==abc}"
test="v{varx<>abc}"
i{<name> <operator> <integer>} – Test an integer variable.
Operators: “==” equal, “<>” different, “>” greater, “<” less, “>=”
greater or equal, “<=” less or equal
test="i{num==123}"
test="i{num<=123}"
You can logically combine conditions:
• “&&” to combine conditions with logical AND. The “&” sign
must be escaped in XML as “&”.
• “||” to combine conditions with logical OR
• “!” to negate a result
test="f{c:\temp\file.txt}&&v{varx==abc}"
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
47
7.22 <ToolSubMenu> entry
Parent element: <Tools>
Content model: <Tool> or <Include> (any number)
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<ToolSubMenu> attributes Description
name Required. Name of the sub-menu, which is reference by menu items
title Title of the menu where this sub-menu is located.
Default: “Tools”
user Allow or deny access to this sub-menu for certain user names.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
user="+frank;-someone;+~Test"
host Allow or deny access to this sub-menu for certain host groups.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
host="+admins;+staff;-guests"
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
48
<ToolSubMenu> attributes Description
test Hide this sub-menu based on conditions.
Conditions syntax:
f{<filename>} – Test if file is readable. Check several files with
logical operators: && AND, || OR, ! NOT
test="f{c:\temp\file.txt}"
test="f{c:\temp\f1.txt&&c:\temp\f2.txt}"
u{<username>} – Match current user name
test="u{theadmin}"
h{<hostname>} – Match host group
test="h{admins}"
v{<name> <operator> <string>} – Test a string variable.
Operators: “==” equal, “<>” different
test="v{varx==abc}"
test="v{varx<>abc}"
i{<name> <operator> <integer>} – Test an integer variable.
Operators: “==” equal, “<>” different, “>” greater, “<” less, “>=”
greater or equal, “<=” less or equal
test="i{num==123}"
test="i{num<=123}"
You can logically combine conditions:
• “&&” to combine conditions with logical AND. The “&” sign
must be escaped in XML as “&”.
• “||” to combine conditions with logical OR
• “!” to negate a result
test="f{c:\temp\file.txt}&&v{varx==abc}"
icon Required. Path and name of the icon file for this sub-menu.
7.23 <Options> entry
Parent element: <Transcat>
Content model: <Option> or <Include> (any number)
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
49
7.24 <Option> entry
Parent element: <Options>
Content model: empty
Attributes are optional unless marked as “required”. If an optional attribute is not set, myPLM will
assume default values.
<Option> attributes Description
name Required. Name of the sub-menu, which is reference by menu items
user Allow or deny access to this button for certain user names.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
user="+frank;-someone;+~Test"
host Allow or deny access to this button for certain host groups.
Specify user names separated by semicolon “;”. Insert “+” before a
name to allow access; insert “-” before a name to deny access. Insert
“~” between name and +/- to be case-insensitive names.
You can use wildcards in names: “*” for any number of characters;
“?” for exactly one character
Default: Allow access for all users
Example:
host="+admins;+staff;-guests"
value Option string
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
50
<Option> attributes Description
test Hide this option based on conditions.
Conditions syntax:
f{<filename>} – Test if file is readable. Check several files with
logical operators: && AND, || OR, ! NOT
test="f{c:\temp\file.txt}"
test="f{c:\temp\f1.txt&&c:\temp\f2.txt}"
u{<username>} – Match current user name
test="u{theadmin}"
h{<hostname>} – Match host group
test="h{admins}"
v{<name> <operator> <string>} – Test a string variable.
Operators: “==” equal, “<>” different
test="v{varx==abc}"
test="v{varx<>abc}"
i{<name> <operator> <integer>} – Test an integer variable.
Operators: “==” equal, “<>” different, “>” greater, “<” less, “>=”
greater or equal, “<=” less or equal
test="i{num==123}"
test="i{num<=123}"
You can logically combine conditions:
• “&&” to combine conditions with logical AND. The “&” sign
must be escaped in XML as “&”.
• “||” to combine conditions with logical OR
• “!” to negate a result
test="f{c:\temp\file.txt}&&v{varx==abc}"
destination Define where the option string will be added. Values:
• cmdline: Add the value to the command line
• envfile: Add the value to the environment file
• intvar: Apply the value to myPLM variable specified by
attribute varname
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
51
<Option> attributes Description
varname Name of the internal variable to which the value is assigned if
destination is intvar
selection Show a file selection box. The result will be set to the internal
variable SelectionResult.
The value of this variable specifies the start directory and file
selection mask. Example:
selection="c:\temp\t*.ini"
7.25 <GUITexts> Definition of user interface text
Parent element: <Transcat>
Content model: See description of subnodes below.
You can overwrite the default user interface text using the various nodes. Define the customized user
interface text in the node attribute of the respective elements.
Example:
<GUITexts>
<titletree name="Applications"/>
<titlebutton name="Run"/>
</GUITexts>
<GUITexts> subnodes Description Default
titletree Displayed header in
tree
Application to Start
titlecheck Displayed header in
add-ons
Additional Software
titleradio Displayed header in
radios
License Configurations
titlebutton Displayed text on
start button
Start
titlemenufile Menu text. File
titlemenuexit Menu text. Exit
titlemenureread Menu text Reread XML”
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
52
<GUITexts> subnodes Description Default
titlemenuopts Menu text. Options
titlemenutool Menu text. Tools
titlemenuhelp Menu text. Help
titlemenuhlpr Menu text. Reference
titlemenuhlpt Menu text. Tutorial
titlemenuhlpa Menu text. About myPLM
tooltipexpsel Tooltip text. Expand selected
tooltipcolsel Tooltip text. Collapse selected
tooltipexpall Tooltip text. Expand all
tooltipcolall Tooltip text. Collapse all
tooltiphlpref Tooltip text. Help Reference
titlemenubcks Menu text. Backup User Settings
titlemenudels Menu text. Delete User Settings
titlemenursts Menu text. Restore User Settings
titlemodebcks User settings dialog Backup
titlemodedels User settings dialog Delete
titlemodersts User settings dialog Restore
txtusersetnothing User settings dialog Nothing to do for
txtusersetbackup User settings dialog Select directory to backup
txtusersetbckerr User settings dialog Not all files are backed-up
txtusersetdelete User settings dialog files
txtusersetdelerr User settings dialog Not all files are deleted
txtusersetrestore User settings dialog Select directory to restore
txtusersetresterr User settings dialog Not all files are restored
txtusersetconfirm User settings dialog to
txtusersetconfdel User settings dialog from
txtusersetselect User settings dialog Select”
txtclearlist Addon context menu Clear List
txtradioreset Radio context menu Reset User Settings
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
53
<GUITexts> subnodes Description Default
txtforcebaknotexist Error message DB The path set in
MYPLM_FORCE_BACKUPPAT
H does not exist:
MYPLM_FORCE_BACKUPPAT
H=
txterrorfromservice Error message DB Error using service:
txtradioreseterror Error message DB Error in reset command
txtdbservicenotavailable Error message DB Service not available:
txtdbcopyseterr1 Error message DB Error in command
txtdbcopyseterr2 Error message DB Using Settings from Server.
msgmaxrecdepthoverflow Error message Include recursion overflow > 25
msgerrorparsingxmlfile Error message ERROR parsing XML-File
msggeneralerrorinmyplm Error message ERROR in myPLM
msgenvfilenotwritable Error message File not writeable
msgexceptioninwriteenv Error message Except. writing environment
msgexceptioninreadenv Error message Except. reading environment
msgexceptioninreadvar Error message Except. reading variables list
msgerropenlicensefile Error message Error opening license file, switched
to DEMO mode
msgnovalidlicversion Error message No valid license for version, no
start initiated
msgexcupdatetoollist Error message Except. in updateToolList
msgvariablenotdefined Error message Variable not defined
msglinknotfound Error message Link node not found
msgincludenotfound Error message Include node not found
msgexcstartexecutable Error message Except. starting executable
msgunknownexception Error message An unknown exception occured,
system may be no more stable
msgexcactionperformed Error message Except. in actionPerformed
msgexcstartingscript Error message Except. starting script
shuttle_window_title Addon shuttle Addon-Shuttle
shuttle_dialog_title Addon shuttle Select/Deselect Addons
XML file structure
TechniaTranscat myPLM 1.3.12 Reference
54
<GUITexts> subnodes Description Default
shuttle_filter_title Addon shuttle Filter
shuttle_filter_clear Addon shuttle Clear
shuttle_availa_title Addon shuttle Available
shuttle_select_title Addon shuttle Selected
shuttle_availa_buttn Addon shuttle All
shuttle_select_buttn Addon shuttle All
shuttle_cancel_buttn Addon shuttle Cancel
shuttle_accept_buttn Addon shuttle OK
titlemenuaddfavorite Menu text Add to Favorite...
titlemenuedtfavorite Button text Edit Favorites ...
titledialogfavorite Favorites dialog Favorite Dialog
titledialogfavoname Favorites dialog Name
titledialogfavopath Favorites dialog Path
titledialogfavoicon Favorites dialog Icon
titledialogfavochoose Favorites dialog Choose ...
titledialogfavocancel Favorites dialog Cancel
titledialogfavook Favorites dialog OK
titleeditorfavorite Edit favorites dialog Favorites Editor
titleeditorttipup Edit favorites dialog Move entry up
titleeditorttipdn Edit favorites dialog Move entry down
titleeditorttipdel Edit favorites dialog Delete entry
titleeditorttipedt Edit favorites dialog Edit entry ...
titleeditorexport Edit favorites dialog Export ...
titleeditorimport Edit favorites dialog Import ...
titleeditorclose Edit favorites dialog Close
txtchoosefile Edit favorites dialog Choose a file
-
CSIDL utility for Windows
TechniaTranscat myPLM 1.3.12 Reference
55
8 CSIDL utility for Windows
The CSIDL utility for Windows (GetCSIDL2.exe) extracts the values for CSIDL variables from the
Windows registry.
There are two ways to make these values available in myPLM:
Get CSIDL variables automatically: Add the getcsidlexe attribute to the <Environments> node. Set
the attribute value to the path of GetCSIDL2.exe.
<Environments ... getcsidlexe="getcsidl2.exe" ... >
Get CSIDL variables in the myPLM start script: Run GetCSIDL2.exe at the command line and
redirect the output to a file. Then start myPLM with parameters -c and -v.
:: Redirect output of GetCSIDL2.exe to a file
GetCSIDL2.exe > csidl.txt
:: Start myPLM with parameters
java -jar -classpath myPLM.jar myPLM.user.MyPLM -c -v csidl.txt
News ticker file structure
TechniaTranscat myPLM 1.3.12 Reference
56
9 News ticker file structure
The news ticker can read text from a URL or text file, or display a static message. Define the source
using the tickertext and tickerback attribute:
• URL
• File
• Fixed message
Ticker text format
Hello user
<br>
Today’s weather:
Karlsruhe: Sunny, 25°C
Stockholm: Mostly sunny, 20°C
Rome: Sunny, 28°C
<br>
Tomorrow’s weather:
Karlsruhe: Partly cloudy, 20°C
Stockholm: Mostly sunny, 20°C
Rome: Sunny, 27°C
To separate ticker entries, begin a new line with <br>.
Text must use ISO 8859-1 encoding.
Formatted text using HTML and CSS
You can use HTML and CSS to format the news ticker text. The supported set of HTML tags and CSS
depends on the Java installation used with myPLM. Search the Java online documentation at
http://docs.oracle.com for “HTML.tag” and “CSS.attribute”.
The <br> tag cannot be used for manual line breaks.
Write the entire HTML code for one ticker entry in a single line.
<html><body><p
style="background-color:#FFFF00">Sunshine</p><p style="background-
color:#0000FF; color:#FFFFFF">Rain</p></body></html>
<br>
This is unformatted text. You can mix formatted and unformatted text in the
ticker.
Avoid using images in the news ticker. Images might not be displayed depending on their load time.
News ticker size
The news ticker’s size is defined by the following dimensions:
• Ticker width: Width of the application window minus the width of the company logo on the right
News ticker file structure
TechniaTranscat myPLM 1.3.12 Reference
57
• Ticker height: Height of the company logo on the right
News ticker logo
Use the tickericon attribute to define a logo to be shown left of the news ticker.
To hide the ticker icon, specify an image file with 1x1 pixels.
Language support
TechniaTranscat myPLM 1.3.12 Reference
58
10 Language support
The myPLM graphical user interface (GUI) is provided in English.
Additional languages can be defined in the myPLM XML file.
To define localized GUI text, see 7.15 <Language> GUI text localization.
Set default language at myPLM startup
The name of the language variable is defined by name attribute of the <Language> node.
Set the language variable in the myPLM startup command. For example, if the language variable is
named “lang” and the language ID is “en”, the default language can be set like this:
java ... -classpath myPLM.jar myPLM.user.MyPLM ... -Dlang=en
Language hot switch
You can configure controls for switching the GUI language while myPLM is running.
Example:
The following XML code defines buttons and menu entries to switch the GUI language to English or
German. The language variable name is “lang”, the language IDs are “en” and “de”.
<Tools>
<Tool icon="en.gif" name="@english" script="@lang=en" title="@Utility"/>
<Tool icon="de.gif " name="@deutsch" script="@lang=de" title="@Utility"/>
</Tools>
Example:
<Language name="lang">
<Translations name="titletree">
<Translation name="de" text="Programme"/>
<Translation name="en" text="Programs"/>
</Translations>
<Translations name="titlecheck">
<Translation name="de" text="Zusatzsoftware"/>
<Translation name="en" text="Additional Software"/>
</Translations>
</Language>
Internal variables
TechniaTranscat myPLM 1.3.12 Reference
59
11 Internal variables
Default internal variables
Name Description Default value
username User name unknown
Hostname Host name unknown
env Environment output file default
direnv Environment output directory (myPLM working directory)
showref Command to open the reference
manual
showtut Command to open the user manual.
The
browser Web link assigned to the placeholder
in the status bar
www.techniatranscat.com
params Parameter string from the myPLM
start command.
Example: Assume the following
command to start myPLM.
java -classpath myPLMuser_xx.jar
myplm.user.MyPLMGui -d
\myPLM.xml .\test.CATPart
This is the value of internal variable
params:
.\test.CATPart
RadioName Name of the latest selected
GlobalRadio button
SelectionResult Return value of the latest confirmed
file selection dialog
Custom internal variables
Custom internal variables can be defined in the <Setvar> node.
License traffic plug-in
TechniaTranscat myPLM 1.3.12 Reference
60
12 License traffic plug-in
12.1 Introduction
Icons for environments (<Environment>) and license options (<GlobalRadio>) can change their
appearance dynamically in response to the gifnum attribute value. This requires an icon file in GIF
format with multiple layers. The gifnum attribute value corresponds to the layer number.
The gifnum attribute can contain a function call to one of various built-in functions that return a layer
number. It is also possible to use custom functions from a customer-specific license traffic plug-in.
You can create a license traffic plug-in yourself, or contact TechniaTranscat for an individual solution.
When using a multi-layer GIF as icon, this variable defines the number of the layer to be displayed (1,
2, 3, ...). The value can be a fixed number or can be calculated by functions.
12.2 Built-in functions
The following functions are available to calculate the gifnum attribute value. Functions can be nested.
In case of an error, the functions return 0 (zero).
call – Call command line scripts or executables
call(<arg1>,<arg2>,...)
Use the exit code (stderr output) of the given command line script or executable. Arguments of the
command must be separated by comma.
Example: Set the gifnum attribute to the exit code of the following command:
cmd.exe /c "testcall.bat" -4
Definition of the gifnum attribute value (quotation marks " are encoded as " entities):
gifnum="call("cmd.exe","/c",
"test.bat",-4)"
env – Read an environment variable
env(<varname>)
Read value of an environment variable, where <varname> is the variable name.
file – Read from file
file(<path>,<line>)
Read number from the specified line of a file.
License traffic plug-in
TechniaTranscat myPLM 1.3.12 Reference
61
Example: Set gifnum to the value from file VDA.txt, line 1:
gifnum="file("VDA.txt",1)"
max – Get largest number
max(<number>,<number>,...)
Get the maximum of the specified numbers.
Examples: Set gifnum to the maximum value in the array
gifnum="max(4,5,1) "
gifnum="max(file("a.txt",3),file("b.txt",3)"
min – Get smallest number
min(<number>,<number>,...)
Get the minimum of the specified numbers.
sum – Sum values
sum(<number>,<number>,...)
Get the sum of the specified numbers.
bufurl – Read from URL
bufurl(<file_url>,<keyword>)
Scan the whole URL or file and return the number after the given keyword. The keyword and its value
are separated by ':' or ';' or ',' or '='.
Example: Read the given file or URL, and set gifnum to the value after “AL3#R1”:
gifnum="bufurl(http://localhost:8086/LUM01, AL3#R1)"
12.3 Custom functions
Call a custom function from the gifnum attribute
A custom function can be called like this:
<Environment addon="radio" icon="ampel.gif"
gifnum="package.classname(parameter/function1,parameter/function2,
...)"/>
License traffic plug-in
TechniaTranscat myPLM 1.3.12 Reference
62
Implementation
The plugin class should extend myPLMLicTrafficFunction and must implement
myPLMLicTrafficFunctionInterface.
At runtime, the following method is called:
public int solve(String[] args,int actIconNumber)
The return value is an integer and used as the gifnum attribute value. A negative number will result in
the entry being displayed without an icon.
args are the parameter values as String array.
actIconNumber is the actual set number.
For common use, the solve method from built-in functions can be called.
Function Description
String trim(String) Remove double quotes at begin and end of string
int solve(String[],int) Solves a string to number by calling a internal or external function
int parseInt(String) Return the number inside a string or 0, if no number exists
boolean isNumber(String) Return true if string is a number
debug(Object) Debug output to stderr
Code example
package customer;
import transcat.myplm.myPLMLicTrafficFunction;
import transcat.myplm.myPLMLicTrafficFunctionInterface;
public class addall extends myPLMLicTrafficFunction implements
myPLMLicTrafficFunctionInterface
{
public int solve(String[] args,int actIconNumber)
{
debug("Customer::addall:actIconNumber="+actIconNumber);
for(int i = 0;i < args.length;i++)
debug("Customer::addall:args["+i+"]="+args[i]);
int result = 0;
for(int i = 0;i < args.length;i++)
{
if(!isNumber(args[i]))
result += solve(args[i],actIconNumber);
else
result += parseInt(args[i]);
}
debug("Customer::addall:result="+result);
return result;
}
}
License traffic plug-in
TechniaTranscat myPLM 1.3.12 Reference
63
For further information, please contact TechniaTranscat: [email protected].
Information modifying plug-ins
TechniaTranscat myPLM 1.3.12 Reference
64
13 Information modifying plug-ins
Information modifying plug-ins can be triggered at certain events in the myPLM application. You can
use plug-ins for the following purposes:
• Run customer functions at certain events
• Modify a CATIA environment entry
• Append entries to a CATIA environment
• Modify a myPLM script command
The following types of plug-ins are available:
Plug-in type File extension Input parameter Output parameter
Java class .class String String
JavaScript function .js String Return value of the function
Windows/UNIX executable .exe String stdout as string
Windows batch file .bat String stdout as string
Windows VBScript .vbs String stdout as string
Notes:
• myPLM detects the plug-in language by the respective file extension.
• Java class plug-ins have access to the myPLM object.
• JavaScript plug-ins have access to internal variables from myPLM in the systHash global array.
To call a plug-in on certain events inside myPLM, add the corresponding attributes to the
<Environments> node. Input and output parameters are passed automatically, where applicable. Some
events do not pass parameters.
<Environments> attribute
linking to the plug-in file
Trigger event, input, output
pluginMyPLMStart Trigger event: After myPLM XML read/reread
Input: nothing
Output: nothing
pluginBeforeWriteEnvVariable Trigger event: Before writing a CATIA environment variable
Input: Environment variable definition <var>=<value>
Output: Environment variable definition <var*>=<value*>
pluginAppendEnvVariables Trigger event: After writing all CATIA environment variables
Input: nothing
Output: One or more lines to append to the CATIA environment
Information modifying plug-ins
TechniaTranscat myPLM 1.3.12 Reference
65
<Environments> attribute
linking to the plug-in file
Trigger event, input, output
pluginBeforeSolveVar Trigger event: Before manipulating the script attribute value
Input: Script attribute value with unresolved internal variables
Output: Command to execute
pluginBeforeStart Trigger event: Before executing the script attribute value
Input: Script attribute value with resolved internal variables
Output: Command to execute
pluginAfterStart Trigger event: After executing the script attribute value
Input: Return code from command as string
Output: Return code from plug-in
pluginMyPLMEnd Trigger event: Before myPLM exit
Input: nothing
Output: nothing