Building enterprise-level extensions

About this task

To build your modified Enterprise-Level extensions such as templates, resource files, customized webpages, entities, and so forth:

Procedure

  1. Create a new XML file named as descriptor.xml and add the following entry:
    <ExtensionsDescriptor>
       <Package Name="<RESOURCE_IDENTIFIER>"/>
    </ExtensionsDescriptor>

    where <RESOURCE_IDENTIFIER> refers to the unique resource identifier defined for identifying the resources belonging to an Enterprise.

  2. Generate a custom JAR file containing the Enterprise-Level extension files. The custom JAR file should have the following directory structure depending on the extensions you have made:
    Note: Before creating the custom JAR, make sure to copy the descriptor .xml file to the root of the JAR file.
    • /template/ <TEMPLATE_SPECIFIC_FOLDER> — for storing the extended template files
      Where TEMPLATE_SPECIFIC_FOLDER refers to the directory that contains the specific templates. For example:
      • api—For storing the API-specific templates
      • email—For storing E-mail-specific templates
      • event—For storing Event-specific templates
      • userexit—For storing UE-specific templates
    In addition to templates, you can put JAR files, resource files, entity extensions, and customized webpages in the JAR file by creating the required folder in the root of the JAR file. For example,
    • /jars—For storing the required JAR files
    • /uijars—For storing the UI-specific JAR files
    • /entities—For storing the extended entity XMLs
    • /webpages—For storing the customized webpages
    • /resources—For storing the modified resource files
  3. After creating the JAR file, deploy the new JAR file by running the InstallExtensions.sh (or InstallExtensions.cmd on Windows) utility from the INSTALL_DIR/bin directory. For example:

    ./InstallExtensions.sh <filename>

    Here, <filename> refers to the path to the JAR file you created in step 2.

What to do next

After building the template extensions, make sure that you re-build the resources.jar.