Server (Cells) Messaging Home
Space shortcuts
Space Tools
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

The add_modifier message provides information about a metadata modifier to be added to the database. An add_modifier message implies that the user is adding a modifier leaf, folder or container to a given term or modifier folder or container. This message is used in both addModifier and excludeModifier Ontology cell operations.

Add a Modifier to the Tree

To add a modifier to the tree, the sequence of events is as follows:

  1. The client requests to add a leaf or folder to a given (editable) parent term or modifier node.
  2. The Ontology server performs the following steps:
    1. Parses the modifier information to obtain the key / TABLE_CD
    2. Queries the TABLE_ACCESS table for the table name associated with the TABLE_CD
    3. Inserts the new modifier leaf, folder or container into the Ontology metadata table


  1. The client populates the selected parent node with the new modifier.



add_modifier Request Message

An add_modifier message requires the user to specify the modifier to be added. No additional attribute settings are necessary.
Example:
<span style="color: #0000ff"><</span><span style="color: #a31515">message_body</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">ns6:add_modifier</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">level</span><span style="color: #0000ff">></span>1<span style="color: #0000ff"></</span><span style="color: #a31515">level</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">applied_path</span><span style="color: #0000ff">></span>\Custom Metadata\Smoking status\Smoker{color:#0000ff}</applied_path<span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">key</span><span style="color: #0000ff">></span>\\CUST\Heavy{color:#0000ff}</key<span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">name</span><span style="color: #0000ff">></span>Heavy<span style="color: #0000ff"></</span><span style="color: #a31515">name</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">visualattributes</span><span style="color: #0000ff">></span>RAE<span style="color: #0000ff"></</span><span style="color: #a31515">visualattributes</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">synonym_cd</span><span style="color: #0000ff">></span>N<span style="color: #0000ff"></</span><span style="color: #a31515">synonym_cd</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">totalnum</span> <span style="color: #ff0000">xmlns:xsi</span><span style="color: #0000ff">=</span>"<span style="color: #0000ff"><a href="http://www.w3.org/2001/XMLSchema-instance" class="external-link" rel="nofollow">http://www.w3.org/2001/XMLSchema-instance</a></span>" <span style="color: #ff0000">xsi:nil</span><span style="color: #0000ff">=</span>"<span style="color: #0000ff">true</span>" <span style="color: #0000ff">/></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">basecode</span><span style="color: #0000ff">></span>heavy<span style="color: #0000ff"></</span><span style="color: #a31515">basecode</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">facttablecolumn</span><span style="color: #0000ff">></span>modifier_cd<span style="color: #0000ff"></</span><span style="color: #a31515">facttablecolumn</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">tablename</span><span style="color: #0000ff">></span>modifier_dimension<span style="color: #0000ff"></</span><span style="color: #a31515">tablename</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">columnname</span><span style="color: #0000ff">></span>modifier_path<span style="color: #0000ff"></</span><span style="color: #a31515">columnname</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">columndatatype</span><span style="color: #0000ff">></span>T<span style="color: #0000ff"></</span><span style="color: #a31515">columndatatype</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">operator</span><span style="color: #0000ff">></span>LIKE<span style="color: #0000ff"></</span><span style="color: #a31515">operator</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">dimcode</span><span style="color: #0000ff">></span>\Heavy{color:#0000ff}</dimcode<span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">comment</span> <span style="color: #0000ff">/></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">tooltip</span><span style="color: #0000ff">></span>Heavy [\Custom Metadata\Smoking status\Smoker
]<span style="color: #0000ff"></</span><span style="color: #a31515">tooltip</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"><</span><span style="color: #a31515">sourcesystem_cd</span><span style="color: #0000ff">></span>lcp5_manualentry<span style="color: #0000ff"></</span><span style="color: #a31515">sourcesystem_cd</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"></</span><span style="color: #a31515">ns6:add_modifier</span><span style="color: #0000ff">></span>
<span style="color: #0000ff"></</span><span style="color: #a31515">message_body</span><span style="color: #0000ff">></span>

add_modifier Response Message

A status type of DONE or ERROR is specified in the response header. No specialized <message_body> is returned to the client.

  • No labels