Page History
This section includes the following topics:• Add
- Add-on AppTier installation package descriptor file
...
- Add-on AppTier installation package contents
...
- ETD file
...
- About the titles file or files
Add-on AppTier installation package descriptor file
The Add-on AppTier installation package zip file should be accompanied by a descriptor XML file. AdminPoint receives the descriptor XML file when the Add-on AppTier is plugged-in.
The Add-on AppTier installation descriptor file carries the same name as the Add-on AppTier installation package zip file. The descriptor file extension is xml.
Add-on AppTier installation package descriptor file example
The following is an example of an Add-on AppTier installation package descriptor file.
...
The root element <sdk-package>; has no attributes• AppTier
- AppTier name element; has no attributes. Its text value is the Add-on AppTier name and it is used in AdminPoint plug-in dialog screen.
...
- Package files element has two Package file child elements. Their text values are the names of the Add-on AppTier installation package zip file and the descriptor XML file.
...
- The Package file element for the Add-on AppTier installation package zip file should have one attribute named package-to-set with a value of "true".
Add-on AppTier installation package contents
The Add-on AppTier plug-in installation package defines to the Precise environment how the information is structured. It defines the general characteristics of the application, entities, and counters.
There are several files inside the installation package. These XML files are prepared before Add-on AppTier installation on a server. All of the files are placed together in a zip file.
The following files are found in the installation package:• External
- External Technology Designer (ETD) file
...
- GUI resource file or files
The software designer assigns a version number to the Add-on AppTier installation package in order to differentiate between future versions of the information structure that may not be compatible.
The name of the installation package zip file should be as follows: I3SDK_application-name_version.zip
Table A-1 Installation 1 Installation package definitions
Element Description
...
version Identifies the current version for this installation package. Value: Numeric
ETD file
The ETD file defines entities and counters for each performance record.
ETD file example
The following is an example of the ETD file in the Add-on AppTier installation package. Notice the hierarchy of all elements, attributes, and sub-elements.
The following is the basic hierarchy of an XML-based ETD file:• The
- The root element is <SDK>
...
- General characteristics of the application and their attributes
...
- Entities and their attributes
...
- Counters and their attributes
<etd version="1.0">
<version major="0" minor="1"/>
...
<integration alerts="no" foresight="yes" />
<service-time />
</entity>
<!-- sender, user classification -->
...
<!-- recipients - execution counter -->
<counter tid="120">
<display color="33" colorRGB="126" sortable="yes" sum-format="number" avg-format="" />
...
<agent-installer-params />
</etd>
About ETD file definitions
Each entity and each counter has a set of properties that describe how they are received, stored, and displayed in Precise products.
The following table specifies version types under the EDT file SDK root element.
Table A-2 Types 2 Types of versions under the ETD file SDK root element
...
minor For documentation of the Add-on AppTier installation package version.
About ETD file application-level entities
Application-level definitions are a set of properties that describe the scope and display of data from the Add-on AppTier application.
The following table specifies the various identifiers for the add-on technology. The <application> element is a mandatory child element of the root element.
Table A-3 Application 3 Application element positioned under the Precise root directory
...
tid The title ID for the technology name.
Value: Numeric: always exists in the file or files. Mandatory: Yes
internal_name Internally identifies a Precise product.
Value: max length of 18. Always uppercase letters or digits only (no blanks or underscore used). Usually the value is derived from the title of the application.
...
id Identifies the add-on technology.
Value: always 2 characters; provided as part of the Precise registration procedure. Mandatory: Yes
range Used in conjunction with tid attributes to make the values unique across technologies. Value: Numeric; provided as part of the Precise registration procedure.
Mandatory: Yes
The following table specifies the collection mode and possible integration with Precise components. The <integration> element is a mandatory child element of <application>.
Table A-4 Integration 4 Integration element positioned under the application element
Integration attribute name Description network Specifies whether integration network monitoring is currently available. Must always be either Yes or No.
Value: Yes, if integration network monitoring is currently supported.
Value: No, if integration network monitoring is currently not supported. "No" is the default value.
Mandatory: No availability Specifies whether monitoring for availability is currently available. Must always be either Yes or No.
Value: Yes, if monitoring for availability is currently supported.
Value: No, if monitoring for availability is currently not supported. "No" is the default value. Mandatory: No (for future use) instance-is-server Specifies whether the same entity is used as both instance and server. Must always be either Yes or No.
Value: Yes, if instance is installed on a server.
Value: No, if instance is not installed on a server. "No" is the default value. Mandatory: No (for future use) agent-type Identifies the File or ARM collection. Value: either "file" or "arm". Mandatory: Yes
The following table specifies possible parameters for the PMDB load process. The <pw> element is an optional child element of <application>.
Table A-5 PMDB 5 PMDB element positioned under the application element
PW attribute name Description threshold The load threshold. Rows with a service time smaller than specified are collapsed into one row.
...
The following table specifies the entity that is used for SLA calculations. The <sla-entity> element is an optional child element of <application>.
Table A-6 sla6 sla-entity element positioned under the application element
...
eid If an entity with a Precise classification activity was defined, put its entity as value. Otherwise, use an empty string.
The following table specifies the collection properties. The <collection> element is a mandatory child element of <application>.
Table A-7 Collection 7 Collection element positioned under the application element
...
remote Specifies whether remote collection is available.
NOTE: The server where the Collector runs is different than the server where the monitored application runs.
...
The following table specifies the counters that make up the application's service time. The <service-time> element is a mandatory child element of <application>.
Table A-8 Service8 Service-time element positioned under the application element
...
Manager. Must have at least one child element <counter>; multiple children are allowed.
Each counter child must have a "tid" attribute with a value equal to the counter's "tid". (The child for the <counters> element is equal to the child of the root.)
...
The following table specifies a zoom display. The <zoom-displays> element is an optional element of <application>.
Table A-9 Zoom9 Zoom-displays element positioned under the application element
...
The following table specifies performance. The <performance> element is an optional element of <application>.
Table A-10 Performance 10 Performance element positioned under the application element
...
performance This element has no attributes (for future use).
About ETD file entities
This section contains functional and technical specifications for Add-on AppTier entities.
The following table specifies the entities for the Add-on AppTier. The <entities> element is a mandatory child element of the root.
Table A-11 Entities 11 Entities element positioned under the root element
...
entities Must have at least one child element <entity>. Multiple children are allowed.
The Instance and Server entities are mandatory. There must be one entity with a class activity.
This element has no attributes.
Only one entity per class attribute: client_ip, activity, program, application, user_name, instance or server, can be defined. Multiple entities with user-defined class are allowed
The following table defines one entity. The <entity> element is a mandatory child element of <entities>. Multiple instances are allowed.
Table A-12 Entity 12 Entity element positioned under the entities element
...
eid Uniquely identities an entity.
Value: One character, uppercase letter only. Mandatory: Yes
...
Value: Numeric, always exists in the file or files. Mandatory: No
Table A-12 Entity element positioned under the entities element
Entity attribute name Description
plural-grouping-tid If specified, this entity has a grouping function. It specifies the Title ID for a grouped entity in plural form, as it appears in the graph title.
...
These entities have the following length limitations:• Entity
- Entity Name (singular), maximum 30 characters
...
- Entity Name (plural), maximum 30 characters
...
- DB Column Name, 2 - 20 characters
The following table defines the display properties of the entity. The <display> element is a mandatory child element of <entity>.
Table A-13 Display 13 Display element positioned under the entity element
...
The following table defines the database related properties. The <data> element is a mandatory child element of <entity>.
Table A-14 Data 14 Data element positioned under the entity element
...
class Defines the classification used to map the entity to the Insight Cross-AppTier display.
Valid values: "activity", "program", "application", "user_name", "instance", "server", "client_IP", or "user_defined".
...
dbcolumn The name of the database column. Value: Yes, No
Mandatory: Yes
NOTE: Instance and Server entities have fixed database column names that are automatically set by Precise during plug-in installation. The attribute cannot be specified for these entities in the ETD file.
Table A-14 Data element positioned under the entity element
Data attribute name Description
mandatory Defines whether the database column is nullable. Values: Yes or No
...
collection-id The name of a field in a Collector file. Value: a valid XML tag.
Mandatory: Yes
NOTE: Instance and Server entities have no collection-id. The values for these entities in the
Collector file are specified in the rowset level; not in the row level.
The following table specifies loading parameters. The <load> element is an optional child element of <entity>.
Table A-15 Load 15 Load element positioned under the entity element
...
allow-drop Specifies whether this entity can be dropped during loading. (This option appears in PW load process parameters.)
Value: Yes, No
Mandatory: No (for future use)
The following table defines whether an entity can be filtered. The <filter> element is an optional child element of <entity>. If specified, it must have one child element <value> with a text value.
Table A-16 Filter 16 Filter element positioned under the entity element
...
The following table specifies whether this entity is applicable for other Precise products besides Insight. The <integration> element is an optional child element of <entity>.
Table A-17 Integration 17 Integration element positioned under the entity element
...
The following table specifies whether this entity has a special service time breakdown. The <service-time> element is an optional element of <entity>.
Table A-18 Service18 Service-time element positioned under the entity element
...
service-time This element has no attributes (for future use).
About etd file counters
This section contains functional and technical specifications for Add-on AppTier counters.
The following table specifies the counters for the Add-on AppTier. The <counters> element is a mandatory child element of the root.
Table A-19 Counters 19 Counters element positioned under the root
...
This element has no attributes.
Execution counter must be defined in the etd.xml file (only one can be defined). Although the counter is defined, the agent does not need to report this counter in the data file.
The following table defines the attribute for one counter only. The <counter> element is a mandatory child element of <counters>.
Table A-20 Counter 20 Counter tid element positioned under the counters element
...
tid The Title ID for a counter.
Value: Numeric, always exists in file or files. For different counters, the values of tid must be specified in intervals of 10.
...
The following table defines the display properties of the counter. The <display> element is a mandatory child element of <counter>.
Table A-21 Display 21 Display element positioned under the counters element
...
sum-format Displays the format summed value.
Value: see counter display formats table for Display sub-elements. Mandatory: Yes
avg-format Displays the format average value.
Value: see counter display formats table for Display sub-elements. Mandatory: Yes
...
NOTE Ignore the diagonal lines in some of the color boxes.
Figure A-1 Color 1 Color code table
The following table specifies counter display formats for Display sub-elements positioned under the counter sub-element.
Table A-22 Counter 22 Counter display formats for the Display sub-elements positioned under the counter sub-element.
...
Duration sum-format: HH:MI:SS
avg-format: HH:MI:SS.TTT Time counter (format for Service-time classification)
...
The following table defines database related properties. The <data> element is a mandatory child element of <entity> and <counter>.
Table A-23 Data 23 Data element positioned under the counter element
...
The following table specifies additional fields that are neither entities or counters. The <misc-fields> element is a mandatory child element of the root.
Table A-24 Misc24 Misc-fields element positioned under the root element
...
This element has no attributes.
The following table defines the field for a counter. The <field> element is a mandatory child element of <misc-fields>.
Table A-25 Field 25 Field element positioned under misc-fields element
...
The following table defines the database related properties. The <data> element is a mandatory child element of <field>.
Table A-26 Data 26 Data element positioned under field element
...
The following table specifies the name of the timestamp field in the Collector file. The timestamp field is a mandatory field child element of <misc-fields>.
Table A-27 Timestamp 27 Timestamp field positioned under the misc-fields element
...
The following table specifies needed parameters for installation. The <agent-installer-params> element is an optional child element of the root.
Table A-28 Agent28 Agent-installer-params element positioned under the root element
...
The following are counter guidelines:• Service
- Service Time, at least one is required
...
- Executions, always fixed
...
- Counter Name, maximum 15 characters
...
- DB Column Name, between 2 - 20 characters
...
About the titles file or files
The titles file or files specify captions and headings that are displayed in Precise products. These are the application names as well as entity and counter names. A different titles file exists for each required language. At the least, one English-language titles file named titles-en.xml has to be created.
...
The following is the basic hierarchy of an XML-based titles file:• The
- The root element is named with the language code; has no attributes
...
- Add-on AppTier name
...
- Entity names in a single variation
...
- Entity names in a plural variation
...
- Entity group names in a single variation
...
- Entity group names in a plural variation
...
- Counter names
The following table specifies the properties for the Add-on AppTier name element. The <t> element is a mandatory child element of the root element.
Table A-29 Add29 Add-on AppTier name element properties
...
<t> sub-element properties vary under the following elements:• <entity>
- <entity> element
...
- <entity-single> element
...
- <entity-grouping> element
...
- <entity-grouping-single> element
The following table specifies <t> sub-element properties for various elements.
Table A-30 Sub30 Sub-element properties for <t> under various elements
...
The text value for the <t> element is the entity name as it should be displayed by Precise products. The following table specifies the properties for <t> sub-elements under the <fields> element.
Table A-31 Sub31 Sub-element properties for <t> under the <fields> element
...
The text value for the <t> element is the counter name as it should be displayed by Precise products.
Precise. Performance intelligence from click to storage. Learn more > >
...