Calyx RIM Data Exchange

Data Exchange UPDATE Message

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

UPDATE Message Example

Note that this example is identical to the example in Data Exchange UPSERT Message, except for <method type=”UPDATE”> in the following example. 

<?xml version="1.0" encoding="UTF-8"?>
<dataexchange version="3">
    <method type="UPDATE">         
        <object id="updateID1" type="com::liquent::                                
                               InSight::manager::
                               registration::domain::                               
                               Application">             
            <field id="name">                
                <value>UpdatedTESTAPPNAME</value>             
            </field>            
            <field id="code">                 
                <value>UpdatedTESTAPPCODE</value>
            </field>             
            <field id="clinicalTrialsNumber">
                <value>CTN #2</value>             
            </field>
            <field id="procTypeId">                 
                <value>National US</value>             
            </field>             
            <field id="relatedSet">
                <value>RelatedApp2</value>             
            </field>
            <field id="progCode">                
                <value>UpdatedTESTAPPCODE</value>             
            </field>            
            <field id="arbitrationFlag">                 
                <value>No</value>
            </field>             
            <field id="internalCode">
                <value>INTERNALCODE</value>             
            </field>
            <field id="submittorId">                 
                <value>United States</value>             
            </field>             
            <field id="legalDistTypeId">                 
                <value>Prescription-Only</value>
            </field>             
            <field id="legalBasisId">
                <value>New Legal Basis</value>             
            </field>
            <field id="statusDate">                
                <value>2011-12-03</value>             
            </field>            
            <field id="statusId">                 
                <value>Planned</value>
            </field>             
            <field id="impid">                
                <value>Some updated impi ID</value>             
            </field>
            <field id="regionId">                 
                <value>United States</value>             
            </field>             
                <query id="query for updateID1" type="com::                                             
                                                liquent::
                                                InSight::
                                                manager::
                                                registration::
                                                domain::
                                                Application">                
            <field id="code">                    
                <value>SOMETESTAPPNAME</value>                 
            </field>            
        </query>         
    </object>     
</method>
</dataexchange>

UPDATE Message Components

Data Exchange Header

<dataexchange version=”3”>
The recommended version is the current version. For InSight Data Exchange 6.2, the current version is version 3.

Method

<method type=”UPDATE”>
Must be UPDATE for all UPDATE operations.

Object

<object id="ID1"
                  type="com::liquent::InSight::manager::registration::domain::Application">

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="statusId">

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

Query

<query id="query for updateID1"
                  type="com::liquent::InSight::manager::registration::domain::Application">
id must be unique for all queries in the Data Exchange message. A message can include multiple queries.

type must reference a metaclass unique type that you are querying against.

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>Planned</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.

UPDATE Message Grammar

Message: <Data Exchange header> Data Exchange Header: (<method>)+ Method: (<object>)+ Object: (<field>)+ <query> Query: (<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.