3D PLM Enterprise Architecture

First Time Declaration: the CATletList.xml file

The CATlets list and position are specified in an xml document named CATletList.xml. As for most of the Portal configuration file, this file can also be prefixed by third party applications to have a custom CATletList.xml file.
Here is an example of a CATletList.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<CATletList>
  <BrowserCATlets>
    <CATlet icon="Resources/IF_W_Search.gif"
            label="SearchTreeCATlet"
            help="/help/english/ptlug/ptlugbt0700.htm"
            help.fr="/help/french/ptlug/ptlugbt0700.htm"
            help.en="/help/english/ptlug/ptlugbt0700.htm"
            mode="CONNECTED"
            url="bean://com.dassault_systemes.catweb.bookmarktree.BookmarkTreeCATlet?serializedData=SearchProject.xml">
    </CATlet>

    <CATlet icon="Resources/IF_Files.gif"
            label="RemoteTreeCATlet"
            help="/help/english/ptlug/ptlugbt0700.htm"
            help.fr="/help/french/ptlug/ptlugbt0700.htm"
            help.en="/help/english/ptlug/ptlugbt0700.htm"
            help.de="/help/german/ptlug/ptlugbt0700.htm"
            help.ja="/help/japanese/ptlug/ptlugbt0700.htm"
            mode="CONNECTED"
            url="bean://com.dassault_systemes.catweb.bookmarktree.BookmarkTreeCATlet?serializedData=FileTreeProject.xml">
    </CATlet>

    <CATlet icon="Resources/IF_Files_local.gif"
            label="LocalTreeCATlet"
            help="/help/english/ptlug/ptlugbt0700.htm"
            help.fr="/help/french/ptlug/ptlugbt0700.htm"
            help.en="/help/english/ptlug/ptlugbt0700.htm"
            url="bean://com.dassault_systemes.catweb.bookmarktree.BookmarkTreeCATlet?serializedData=LocalFileTreeProject.xml">
    </CATlet>
  </BrowserCATlets>

  <ViewerCATlets>
    <CATlet icon="Resources/I_Lite3D.gif"
            label="3DRemoteCATlet"
            help="/help/english/ptlug/ptlugwd0600.htm"
            help.fr="/help/french/ptlug/ptlugwd0600.htm"
            help.en="/help/english/ptlug/ptlugwd0600.htm"
            mode="CONNECTED"
            url="bean://com.dassault_systemes.catweb.remote.controller.RemoteCATlet3D">
    </CATlet>
  </ViewerCATlets>

  <OtherCATlets>
    <CATlet icon="Resources/PerfMeter.gif"
            label="PerformanceCATlet"
            help="/help/README_en.htm"
            help.fr="/help/README_fr.htm"
            help.en="/help/README_en.htm"
            url="bean://com.dassault_systemes.catweb.perfmeter.PerfCATlet">
    </CATlet>
  </OtherCATlets>
</CATletList>

The CATlet declaration is contained between the tag CATletList. The CATlets can be arranged into three categories:

• The browser CATlets category declared with the tag <BrowserCATlets> contains the CATlet that will be located inside the WebInfo part of the Portal. A tab will be added in the WebInfo part for each CATlet declared in this category.
• The viewer CATlets category declared with the tag <ViewerCATlets> contains the CATlet that will appears inside the WebSpace part of the Portal.
• The third category, the other CATlets, declared with the tag <OtherCATlets> contains CATlets that fit in neither previous categories.

Each CATlet is declared with the tag CATlet. This tag contains many attributes that will describe all information relative to the CATlet.

• The icon attribute specifies the icon path that will represent the CATlet inside the Portal. This path is usually relative to the Portal runtime installation
• The label attribute describes a NLS label for the CATlet. The NLS translation of the label that will be used is extracted from the dsdskwidgets_xx.properties. If the matching attribute cannot be found, the default attribute label is taken into account
• The help attribute specifies a path on a html documentation for the CATlet. The help path is described by the attribute help.locale where locale is the selected locale at runtime (fr, en, de ...).
• The url attribute describes the CATlet class name as well as some customization at startup. For more details about this url syntax, refers to the PortalURI paper.
• The multiThread attribute tells if the CATlet can support multi threading or not. This attribute can take the value true or false. A false value means that the CATlet will always be instantiated inside the AWT-event thread. This is very useful for Swing CATlets.
• The mode attribute tells in which mode the CATlet is intended to run: when connected to a server, when running as a nomad or simply in both mode. Given the current mode and this attribute value the CATlet may or may not appear inside the Webtop. The right values for this attribute are BOTH, CONNECTED and NOMADE (all three in uppercases)

This declaration is called "first-time" declaration because the browser CATlet category is initialized from this file only the first time you launch the Portal. As this categories can be configured at runtime by each user, this list is saved in an other xml file named WebTopConfiguration_user.xml and is currently stored on the server (usually in $HOME/CATSetting of the user). A backup of this file is stored at each new connection. and is suffixed by ".bak". When the Portal has no server connection, this file is saved in the /tmp of the client.

[Top]

Subsequent Declarations: the WebTopConfiguration_user.xml File

The next time you launch the Portal, the CATlet list for the browsers will be read from the WebTopConfiguration_user.xml file that is currently stored in the user's settings directory (usually $HOME/CATSettings on the server)
Here is an example of such a file:

<?xml version="1.0" encoding="UTF-8"?>
  <WebTopConfiguration>
    <Tab icon="Resources/IF_W_Search.gif"
         isShared="false"
         mode="CONNECTED"
         multiThread="true"
         name="Search Tree"
         originalSerializedData="SearchProject.xml"
         url="bean://com.dassault_systemes.catweb.bookmarktree.BookmarkTreeCATlet?serializedData=Search_Tree_ddl.xml"
         visible="true">
    </Tab>

    <Tab icon="Resources/IF_Files.gif"
         isShared="false"
         mode="CONNECTED"
         multiThread="true"
         name="Remote File Tree"
         originalSerializedData="FileTreeProject.xml"
         url="bean://com.dassault_systemes.catweb.bookmarktree.BookmarkTreeCATlet?serializedData=FileTreeProject.xml"
         visible="true">
     </Tab>
   </WebTopConfiguration>

This file contains only some of the information described in the CATletList.xml file as the other needed information will be taken from this last file. Note that the content of this file may evolve in the future. Other information than a list of CATlets may be also described in this file.

[Top]

History

Copyright © 2000, Dassault Systèmes. All rights reserved.