Versions Compared

Key

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

...

The following is an example of an Add-on AppTier installation package descriptor file.

<sdk-package>
     <apptier-name> Generic Mail Server </apptier-name>
     <package-files>
          <package-file package-to-set="true"> GenericMailServer.zip
          </package-file>
     </package-files>
</sdk-package>

The following is the basic hierarchy of an XML-based descriptor file:

...

  • 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"/>
     <!-- application level definitions -->
     <application id="MS" tid="1" internal_name="MAILSERVER" range="20000">
          <integration network="no" availability="no" instance-is-server="no" agent-type="file" /> <!-- "file" or "arm" collection mode -->
          <pw threshold="0"/>
          <sla-entity eid="A" />
          <collection dir="products/sdk/MS" remote="no" min-activity-report="3" max-activity-report="15" availability-report="15" />
          <service-time>
               <counter tid="100" />
          </service-time>
          <zoom-displays />
          <performance />
     </application>
     <entities>
          <!-- mail msg, activity -->
          <entity eid="A" tid="501" plural-tid="502" grouping-tid="503" plural-grouping-tid="504" length="256">
               <display mandatory="yes" order="1" />
               <data class="activity" type="varchar" dbcolumn="MAIL_MSG" mandatory="yes" last-summary="all" collection-id="msg" />
               <load allow-drop="no" />
               <integration alerts="no" foresight="yes" />
               <service-time />
          </entity>
          <!-- sender, user classification -->
          <entity eid="U" tid="511" plural-tid="512" grouping-tid="513" plural-grouping-tid="514" length="256"
               <display mandatory="no" order="6" />
               <data class="user_name" type="varchar" dbcolumn="SENDER" mandatory="yes" last-summary="all" collection-id="sender" />
               <load allow-drop="no" />
               <integration alerts="no" foresight="yes" />
               <service-time />
          </entity>
          <!-- sender ip, "client ip" classification -->
          <entity eid="C" tid="521" plural-tid="522" grouping-tid="523" plural-grouping-tid="524" length="256">
               <display mandatory="no" order="7" />
               <data class="client_ip" type="varchar" dbcolumn="SENDER_IP" mandatory="yes" last-summary="all" collection-id="C_IP" />
               <load allow-drop="no" />
               <integration alerts="no" foresight="yes" />
               <service-time />
          </entity>
          <!-- msg type, "user defined" classification, no grouping -->
          <entity eid="T" tid="531" plural-tid="532" length="256">
               <display mandatory="no" order="9" />
               <data class="user-defined" type="varchar" dbcolumn="MSG_TYPE" mandatory="yes" last-summary="all" collection-id="type" />
               <load allow-drop="no" />
               <integration alerts="no" foresight="yes" />
               <service-time />
          </entity>
          <!-- instance - name of mail server -->
          <entity eid="I" tid="541" plural-tid="542" grouping-tid="543" plural-grouping-tid="544" length="256">
               <display mandatory="yes" order="2" />
               <data class="instance" type="varchar" mandatory="yes" last-summary="all" />
               <load allow-drop="no" />
               <integration alerts="no" foresight="yes" />
               <service-time />
          </entity>
          <!-- server machine -->
          <entity eid="S" tid="551" plural-tid="552" grouping-tid="553" plural-grouping-tid="554" length="256">
               <display mandatory="yes" order="3" />
               <data class="server" type="varchar" mandatory="yes" last-summary="all" />
               <load allow-drop="no" />
               <integration alerts="no" foresight="yes" />
               <service=time />
          </entity>
     </entities>
     <counters>
          <!-- delivery time - service time -->
          <counter tid="100">
               <display color="34" colorRGB="123" sortable="yes" sum-format="duration-HH:MI:SS" avg-format="avgDuration-HH:MI:SS.TTT" />
               <data class="service" type="float" dbcolumn="DELIVERY_TIME" mandatory="yes" func="SUM" collection-id="delivery" />
          </counter>
          <!-- msg size - statistical counter -->
          <counter tid="110"
               <display color="30" colorRGB="125" sortable="yes" sum-format="byteFloat" avg-format="byteFloat" />
               <data class="statistic" type="float" dbcolumn="MSG_SIZE" mandatory="yes" func="SUM" collection-id="size" />
          </counter>
          <!-- recipients - execution counter -->
          <counter tid="120">
               <display color="33" colorRGB="126" sortable="yes" sum-format="number" avg-format="" />
               <data class="execution" type="float" dbcolumn="REQUESTS" mandatory="yes" func="SUM" collection-id="recipients" />
          </counter>
     </counters>
     <misc-fields>
          <!-- timestamp field -->
          <field tid="999">
               <data class="timestamp" type="timestamp" dbcolumn="TIMESTAMP" mandatory="yes"
               <collection-id="D" />
          </field>
     </misc-fields>
     <agent-installer-params />
</etd>

About ETD file definitions

...

Display Attribute NameDescription
color

Specifies the color code for Insight bar graphs.

Value: Figure A- 1

Info

The value is the sequential number before the bracket.

Mandatory: Yes

colorRGB

Specifies the color code for Report Manager reports.

Value: Figure A- 1

Info

The value is the hexadecimal value on the right of the color that then needs to be converted to its equivalent decimal value. For example color with the code 0 and hexdecimal value 071685 becomes 464516 decimal.

Mandatory: Yes

sortable

Specifies whether a counter appears in an Insight sort drop down list.

Value: Yes, No

Mandatory: Yes

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

...