Previous Topic: About Data Lookup XML SchemaNext Topic: Database Guide


Full XML Schema

This section describes the full XML schema for event metadata and includes the type and value attributes for relevant tabs.

<?xml version="1.0" ?> 

<apm schema_version="1" xmlns="http://www.orchestria.com" 
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance 
xsi:schemaLocation=http://www.orchestria.com xmleventattributes.xsd >

    <event>

    <!--  general attributes                                        --> 
    <security id="1234" /> 
    <!--  This attribute is stored in the database and may be       --> 
    <!--  validated against a session security ID at search time    --> 
    <!--  to ensure that only allowed users can view this event     --> 

    <!--  Email attributes  --> 
    <email>
        <attributes draft="true" /> 
           <!--  draft = true or false  --> 
       <channel>web</channel> 
       <protocol>gmail</protocol> 
       <embedding>
           <process_as>IM</process_as> 
            <!--  Can be set to IM, eFax, or Bloomberg   --> 
            <network_name>Bloomberg</network_name> 
            <!--  Can be set Bloomberg, Mindalign, Jabber, HubConnex, etc  --> 
        </embedding>
        <header type="x-header" guid="">
            <!—type = x-header, mapi_prop, or notes_prop  --> 
           <item type="xs:string" name="" item_id="0">
               <!—  type = "xs:string|..."  --> 
           </item>
        </header>
        <envelope direction="none" security="none">
            <!—  direction = one, incoming, outgoing, or transit  --> 
            <!—  security =  none, enc, sig, encsig, or secure  --> 
            <subject>Email Subject</subject> 
            <participants>
                <participant partClass="to" no_create="false">
                    <!— partClass = to, cc, bcc, from, robo, sobo, or transport" -->
                    <!-- no_create = true or false  --> 
                    <displayName /> 
                    <address addrType="smtp" primary="true" default="true">
                        <!—  addrType = smtp, ex, x400, and so on  --> 
                        <!—  primary = true or false  --> 
                        <!—  default =  true or false  --> 
                        <!-- no_create = true or false  --> 
                    </address>
                </participant>
            </participants>
        </envelope>
    </email>

    <!--  File attributes  --> 
    <file>
        <host>HostName</host> 
        <hash type="sha-256">hashvalue</hash> 
        <signature offset="0" length="0">FileSig</signature> 
        <filename>Filename.txt</filename> 
        <volume>C:</volume> 
        <path>C:\folder\</path> 
        <device local="true" type="printer" connection="network" 
                removable="true" server="server_name" 
                location="my location">MyPrinter</device> 
            <!—  local = true or false  --> 
            <!—  type = printer or drive  --> 
            <!—  connection = usb, network, IDE, PCI, SCSI, and so on  --> 
            <!—  removable = true or false  --> 
            <!—  location = user defined physical printer location  --> 
        <application>application</application> 
        <application_path>path</application_path> 
        <channel>web</channel> 
        <protocol>gmail</protocol> 
        <url>http://server.com/files</url> 
        <created>2000-01-01T00:00:00</created> 
        <modified>2000-01-01T00:00:00</modified> 
        <accessed>2000-01-01T00:00:00</accessed> 
            <!-- date format: yyyy-mm-ddThh:mm:ss  --> 
        <size>0</size> 
        <file_attr compressed="true" encrypted="true" hidden="true"
                   offline="true" readonly="true" system="true" 
                   temporary="true" archive="true" /> 
            <!—  File attributes = true or false. Individual, but will 
            typically only be present if they are "true"  --> 
        <title>Doc Title</title> 
        <subject>Doc Subject</subject> 
        <author>Doc Author</author> 
        <property_set name="">
            <property name="" prop_id="1" type="xs:string">Prop Value</property> 
        </property_set>
        <stream name="">
            <size>0</size> 
        </stream>

        <participants>
            <participant partClass="policy" no_create="false">
                <!—  partClass = policy, owner, creator, assoc, 
                src, dest, or host  --> 
               <!-- no_create = true or false  --> 
                <username /> 
                    <!-- username = CA Data Protection user name --> 
                <address addrType="smtp” primary="true" default="true">
                    <!--  addrType = smtp, ex, x400, and so on  --> 
                    <!--  primary = true or false  --> 
                    <!--  default = true or false  --> 
                </address>
            </participant>
        </participants>
        <database>
            <type>SQL</type> 
            <name>Database Name</name> 
            <source type="query">SELECT * from MyTable</source> 
                <!--  type = query, table, or view  --> 
            <datasource>datasource from connection string</datasource> 
            <header>
                <column name="Column Name" type="varchar" size="255" /> 
            </header>
            <data>
                <row>
                    <cell>Cell Data</cell> 
                    <cell stream_index="0" size="1024" /> 
                         <!--  cell tags must be one of two types: specifying 
                         data directly; or a reference to a stream  --> 
                </row>
            </data>
        </database>
    </file>
</event>

    <!--  Policy  --> 
    <policy>
        <state>
            <smart_tags>
               <smart_tag name="">
                   <!--  Each smart tag can have multiple values   --> 
                   <value /> 
               </smart_tag>
            </smart_tags>
           <flags>
               <flag name="block_notify" /> 
                   <!—name = stopped, block_notify, block_quiet, and so on. 
                   Based on the list of event state names  --> 
            </flags>
        </state>

        <client_actions policy_id="id_string">
            <mail_block>
                <dialog_title>Blocked Title</dialog_title> 
                <dialog_message>Blocked Message</dialog_message> 
            </mail_block>
            <mail_warned decision_id="id_string">
                <dialog_title>Warn Title</dialog_title> 
                <dialog_message>Warn Message</dialog_message> 
            </mail_warned>
           <mail_personal decision_id="id_string">
               <dialog_title>Title</dialog_title> 
               <dialog_message>Message</dialog_message> 
           </mail_personal>

           <mail_inform decision_id="id_string">
               <dialog_title>Inform Title</dialog_title> 
               <dialog_message>Inform Message</dialog_message> 
           </mail_inform>
           <mail_forward>
               <subject>Email subject</subject> 
               <body>Email body</body> 
               <to>Recipient address</to> 
           </mail_forward>
           <mail_reply attach_original="true" reprocess="true">
               <subject>Email subject</subject> 
               <body>Email body</body> 
           </mail_reply>

           <mail_new attach_original="true">
               <subject>Email subject</subject> 
               <body>Email body</body> 
               <!--    Multiple email addresses of each type can be specified. Each 
               address is either a ‘substitute’ address or, (if ‘substitute’ is 
               missing or set to "address") is specified by the Address value. -->
               <from substitute="original_sender">Address</from> 
                   <!—  substitute = original_sender, apm_user, or address  --> 
               <to substitute="all_recipients">Address</to> 
                   <!—  substitute = original_sender,  to_recipients,
                   cc_recipients, bcc_recipients, all_recipients, or address" --> 
               <cc substitute="all_recipients">Address</cc> 
                   <!—substitute = original_sender, to_recipients, 
                   cc_recipients, bcc_recipients, all_recipients, or address" --> 
               <bcc substitute="all_recipients">Address</bcc> 
                   <!—substitute = original_sender, to_recipients, cc_recipients, 
                   bcc_recipients, all_recipients, or address" --> 
           </mail_new>

           <mail_move_to_bcc>
               <recipient substitute="all_recipients">Address</recipient> 
                   <!-- substitute="all_recipients|address"  --> 
           </mail_move_to_bcc>
           <mail_set_xheader>
               <name>xheader name</name> 
               <value>xheader value</value> 
           </mail_set_xheader>

           <web_block>
               <redirect_url>redirection url</redirect_url> 
           </web_block>

           <appmon_block /> 
           <appmon_update_timout>
               <timeout_milliseconds>0</timeout_milliseconds> 
           </appmon_update_timout>
           <appmon_title_timout>
               <timeout_milliseconds>0</timeout_milliseconds> 
           </appmon_title_timout>

           <file_delete secure="true" /> 
           <file_replace secure="true">
               <replacement_text>Replacement text</replacement_text> 
           </file_replace>
           <file_copy mode="absolute" if_conflicts="copy">
               <!--  mode = relative or absolute  --> 
               <!-- if_conflicts = discard, overwrite, or copy  --> 
               <location>Copy location</location> 
           </file_copy>

            <file_tag target="original">
                <!--  target = original or copy  --> 
                <name>Tag name</name> 
                <value>Tag value</value> 
            </file_tag>
             <file_block>
                <dialog_title>Blocked Title</dialog_title> 
                <dialog_message>Blocked Message</dialog_message> 
            </file_block>
        </client_actions>

        <action_results policy_id="id_string">
            <!-- action_res = cancel, continue, or personal  --> 
            <all_results>
                <mail_warned decision_id="id_string" action_res="continue" /> 
                <mail_personal decision_id="id_string" action_res="continue" /> 
                <mail_inform decision_id="id_string" action_res="continue" /> 
            </all_results>
            <old_policy_results>
                <mail_warned decision_id="id_string" action_res="continue" /> 
                <mail_personal decision_id="id_string" action_res="continue" /> 
                <mail_inform decision_id="id_string" action_res="continue" /> 
            </old_policy_results>
        </action_results>

    </policy>

    <!--  user  --> 
    <user /> 

</apm>