Calyx RIM Data Exchange

Data Exchange ADD Message

If your application imports data by using the InSight Data Exchange Web Service, the application constructs the messages that the applications posts to the Data Exchange Web Service.

ADD Message Example

<dataexchange version="3">
    <method type="ADD">        
        <object id="ID1" type="com::liquent::InSight::manager::
                         regintel::domain::RICountryDetail">
            <field id="owner">                
                <value>John Admin</value>            
            </field>            
            <field id="keywords">
            <value>keywords</value>
            </field>
            <field id="productTypes">
                <values>
                    <value>Pharmaceutical</value>
                    <value>Medical Device</value>
                </values>
            </field>
            <field id="description">
                <value>description</value>
            </field>
            <field id="countryId">
                <value>unit test country</value>
            </field>
            <field id="healthAuthorities">
                <values>
                    <value>authorities</value>
                </values>
            </field>
            <field id="comments">
                <value>comments</value>
            </field>
        </object>    
    </method>
</dataexchange>

ADD Message Components

Data Exchange Header

<dataexchange version=”3”>

The recommended version is the current version. For Calyx RIM 6.2, the current version is version 3.

Method

<method type=”ADD”>

Must be ADD for all ADD messages.

Object

<object id="ID1" type="
                  com::liquent::InSight::manager::regintel::domain::RICountryDetail ">

id must be unique for all objects in the message. A message can include multiple objects.

type must reference a metaclass unique type.

Field

<field id=" productTypes ">

id must reference the field name in the appropriate metaclass defined by type in the object component.

Values

<values>

A <values> tag  has multiple values for a field. The values are usually for a multi-select field in the user interface.

Value

 <value> Pharmaceutical </value>

If the referenced field is a drop-down list in the user interface UI, the value must be a valid value in the list. For free-text fields, normal validation rules apply.

ADD Message Grammar

Message: <Data Exchange header> Data Exchange Header: (<method>)+ Method: (<object>)+ Object: (<field>)+ Field: <value> | <values> Values: (<value>)+ Value: text

+ indicates one or more of the immediately preceding grouping. | indicates the preceding or following (not both) term or grouping. () indicates a grouping of the enclosed terms. <> indicates that the enclosed text is a term.