Component application descriptor

The component application descriptor contains information about a specific computer system, server, or module deployed within a server, along with information about the participation of the component within the application.

Components can include computer systems, database servers, Java EE servers, or modules within servers. You can use a separate descriptor for each module, or a single descriptor for all modules within a server.

A component application descriptor must be deployed in the descriptor directory of each server that is a component of the business application, or contains modules that are components of the business application. Use component application descriptors instead of the WebSphere® or Weblogic sensors to add the Java EE components to a business application for a finer granularity to the discovered dependencies. For more information, see Best Practices for Discovering Business Applications on the TADDM wiki at https://github.com/TADDM/taddm-wiki/wiki/Business-Application-Mapping

An application descriptor is an XML with the following format:

<component-app-descriptor
        app-instance-name="instance_name"
        grouping-pattern>
    <component-descriptor
        type="component_type"
        name="component_name"
        marker-module="true|false"/>
</component-app-descriptor>

The elements and attributes of the component application descriptor file are as follows:

Table 1. Component application descriptor elements and attributes
Component descriptor element Description and attributes
component-app-descriptor The root element for the component application descriptor.
app-instance-name (Required) The name of the application instance.
grouping-pattern The name of the grouping pattern that includes the definition of the business application.
component-descriptor (Required) The element for the component information.
type (Required) A component descriptor can apply to a computer system (host), a server in its entirety, or to individual modules within a server. The type attribute specifies this relationship, and can have either of the following values:
  • host - a computer system.
  • server - a software server, for example an application server.
  • module - a software module deployed on a server.
  • deployable - any component that is deployed on a server.
name The name of the component. Required when the type attribute is set to module or deployable.
marker-module (Optional) A special type of module definition for Java EE domains. When a module is indicated as a marker module, Java EE-managed servers within the domain that include the marker module are treated as having all of its modules included in the application. For other types of software servers that are not application servers like Java EE domains, the marker module indicates that all the deployed components on the server that include the marker module are included in the business application. You can specify the following values for the marker module:
  • true
  • false
Note: To remove a component from a business application that was created with a component application descriptor, you must edit the business application in the Data Management Portal.