Adding a Custom Application

This procedure describes the steps you need to follow to integrate a custom application into the dynamic user interface. The custom application appears in the My Desk menu along with ENOVIA products.

  1. Create a directory for your application's JSPs within the ematrix directory. This directory is under the staging directory within the RMI installation directory. This directory is equivalent to the subdirectories for the ENOVIA products, such as ematrix/engineeringcentral. Place all your JSPs in this directory.

  2. Create an images directory under the subdirectory you created in Step 1. Place all image files for your application in this directory.

    You must run the warutil and deploy the archive file when you are done adding files for the application.

  3. List your custom application in the DisplayedSuites property in emxSystem.properties. The name you give it here is the name you should use when adding the properties for the suite in Step 4.

    Custom applications cannot have the same name as an existing application and they cannot have the same name as an existing application without the "eServiceSuite" prefix. For example, the name for Engineering Central is eServiceSuiteEngineeringCentral so you cannot have a custom application with the name eServiceSuiteEngineeringCentral or EngineeringCentral.

    eServiceSuites.DisplayedSuites = 
    eServiceSuiteEngineeringCentral,  \
        eServiceSuiteTeamCentral,         \
        CustomCentral \

  4. Add a set of properties to emxSystem.properties to tell the system the name of your application directory, properties files, and other important information. Each ENOVIA product has a set of properties and the set for a custom application called Custom Central is shown below. Create an equivalent set for your application and change the property names and the values to reflect your application. The property names should match the name used in the DisplayedSuites property. For a description of the properties, see emxSystem.properties.

    # Custom Central
    CustomCentral.URL = common/emxNavigator.jsp
    CustomCentral.Directory = customcentral
    CustomCentral.ApplicationPropertyFile = 
    emxCustomCentral.properties
    # ApplicationStartPage is within 'Directory' specified
    CustomCentral.ApplicationStartPage = emxCustomFrames.jsp
    CustomCentral.StringResourceFileId = 
    emxCustomCentralStringResource
    CustomCentral.PropertyFileAlias=emxCustomCentralProperties

  5. Define a submenu for the application. Creating a submenu for the application effectively registers it. The submenu will contain all top-level commands for your application. For instructions on creating menus and commands, see About Building Menus.

  6. Register new schema and configure existing schema as needed using the instructions in Configuring Using Schema.

    If you add a custom type, you can specify the icon to use for the type's root tree node using the emxFramework.smallIcon.TYPE_SYMBOLIC_NAME property in emxSystem.properties. For more information, see About the Icon for a Type's Tree.

  7. Define additional and configure existing trees, tables, forms, and menus as needed.