Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table A-2 Types of versions under the ETD file SDK root element

Version

...

TypesDescription
majorFor

...

documentation of the Add-on AppTier installation package version.
minor

...

For documentation of the Add-on AppTier installation package version.

About ETD file application-level entities

...

Table A-3 Application element positioned under the Precise root directory

Application

...

Attribute NameDescription
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.

Mandatory: Yes

...

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 element positioned under the application element

Integration

...

Attribute NameDescription
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 element positioned under the application element

PW

...

Attribute NameDescription
threshold

The load threshold. Rows with a service time smaller than specified are collapsed into one row.

Value: Numeric, if specified.

Mandatory: No (for future use)

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 sla-entity element positioned under the application element

sla-entity

...

Attribute NameDescription
eidIf 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 element positioned under the application element

Collection

...

Attribute NameAttributes
dir

The relative path under the Precise Listener where Collector files are harvested. A valid path name always includes a forward slash "/" as a file separator.

...

For example: products/sdk/MS.

Mandatory: Yes

remote

...

Specifies whether remote collection is available.

...

Info

The server where the Collector runs is different than the server where the monitored application runs.

Value: Yes, No. "No" is the default value.

Mandatory: No

min-activity-

...

report

Specifies the minimum frequency for reporting activity data (largest time slice).

Value: Numeric, if specified.

Mandatory: No (for future use)

max-activity-

...

report

Specifies the maximum frequency for reporting activity data (smallest time slice).

Value: Numeric, if specified.

Mandatory: No (for future use)

availability-

...

report

Specifies the frequency for reporting availability data (size of time slice).

Value: Numeric, if specified.

Mandatory: No (for future use)

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 Service-time element positioned under the application element

Service-

...

timeDescription
service-

...

time

Specifies the display order for the service time breakdown in Insight and Report

...

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.)

This element has no attributes.

The following table specifies a zoom display. The <zoom-displays> element is an optional element of <application>.

Table A-9 Zoom-displays element positioned under the application element

Zoom-displays

...

Element NameDescription
zoom-

...

displaysThis element has no attributes (for future use).

The following table specifies performance. The <performance> element is an optional element of <application>.

Table A-10 Performance element positioned under the application element

Performance

...

Element NameDescription
performanceThis element has no attributes (for future use).

About ETD file entities

This section contains functional and technical specifications for Add-on AppTier entities.

...

Table A-11 Entities element positioned under the root element

Entities

...

Element NameDescription
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 element positioned under the entities element

Entity

...

Attribute NameDescription
eid

Uniquely identities an entity.

Value: One character, uppercase letter only.

Mandatory: Yes

tid

...

The Title ID for an entity, as it appears in the drop-down menu list.

Value: Numeric, always exists in the file or files.

Mandatory: Yes

plural-

...

tid

The Title ID for an entity in plural form, as it appears in the graph title.

Value: Numeric, always exists in the file or files.

Mandatory: Yes

grouping-

...

tid

If specified, this entity has a grouping function. It specifies the Title ID for a grouped entity, as it appears in the drop-down menu list.

Value: Numeric, always exists in the file or files.

Mandatory: No

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.

Value: Numeric, always exists in the file or files.

Mandatory: No

length

...

The maximum length value in numbers.

Value: Numeric

Mandatory: Yes

These entities have the following length limitations:

...

Table A-13 Display element positioned under the entity element

Display

...

Attribute NameDescription
mandatory

Defines whether the entity graph can be hidden in Insight display settings.

Value: Yes, No

Mandatory: Yes

order

...

Defines the position of the entity's graph in the Insight "all" display.

Value: Numeric

Mandatory: Yes

The following table defines the database related properties. The <data> element is a mandatory child element of <entity>.

Table A-14 Data element positioned under the entity element

Data

...

Attribute NameDescription
classDefines 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".

Mandatory: Yes

type 
dbcolumn 
  
  
  

type    Defines the data type of a database column. Value: "varchar"

...