User Community Service Desk Downloads
If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Override Services

Override services are services that enable setting, deleting, and viewing overrides on instance and master records. All override services are part of <service class="com.ataccama.nme.internal.engine.services.override.OverridesServiceBundle"/>.

We use a placeholder instance entity Example, a placeholder master entity Example, and a placeholder Master View Mv to illustrate the functionality of services.

Instance override services

Requests on the instance layer use the following parameters for record identification.

Parameter Description

entityType

Instance table name as defined in the model.

recordId

ID of the record.

getInstanceOverrides

Lists all or selected overrides applied on a given record. Use attributeName to specify the attributes for which the overrides should be listed.

Request
<request>
    <entityType>party</entityType>
    <recordId>1982</recordId>
    <attributeSelector>
        <attributeName>src_first_name</attributeName>
        <attributeName>src_last_name</attributeName>
    </attributeSelector>
</request>

The response lists all attributes on which overrides have been applied and their values as seen before the override was applied, that is, values computed by the engine.

Get instance overrides response
<response>
      <entityType>party</entityType>
      <recordId>1982</recordId>
      <overrides>
        <override>
          <attributeName>src_first_name</attributeName>
          <value>Janette</value>
        </override>
        <override>
          <attributeName>src_last_name</attributeName>
          <value>Smith</value>
        </override>
      </overrides>
</response>

setInstanceOverrides

Applies an override on one or several attributes in a given record. Use the attributeName-value pair to set overrides.

It is possible to override only src_ values.
Request
<request>
    <entityType>party</entityType>
    <recordId>1982</recordId>
    <overrides>
        <override>
            <attributeName>src_first_name</attributeName>
            <value>John</value>
        </override>
        <override>
            <attributeName>src_last_name</attributeName>
            <value>Smith</value>
        </override>
    </overrides>
</request>

The response is empty.

deleteInstanceOverrides

Deletes applied overrides on specified attributes in a given record. Use attributeName to specify which attributes should drop their overrides.

Request
<request>
    <entityType>party</entityType>
    <recordId>1982</recordId>
    <attributes>
        <attributeName>src_first_name</attributeName>
        <attributeName>src_last_name</attributeName>
    </attributes>
</request>

The response is empty.

deleteAllInstanceOverrides

Deletes all applied overrides in a given record.

Request
<request>
    <entityType>party</entityType>
    <recordId>1982</recordId>
</request>

The response is empty.

Master override services

Requests on master layers use three parameters for record identification.

Parameter Description

viewName

Name of the master layer or view.

entityType

Master table name as defined in the model.

recordId

ID of the record.

getMasterRecordOverrides

Lists all or selected overrides applied on a given record. Use attributeName to specify the attributes for which the overrides should be listed.

Request
<request>
    <viewName>masters</viewName>
    <entityType>party</entityType>
    <recordId>1982</recordId>
    <attributes>
        <attributeName>cmo_first_name</attributeName>
        <attributeName>cmo_last_name</attributeName>
    </attributes>
</request>

The response lists all attributes on which overrides have been applied and their values as seen before the override was applied, that is, values computed by the engine.

Get master record overrides response
<response>
      <viewName>masters</viewName>
      <entityType>party</entityType>
      <recordId>1982</recordId>
      <overrides>
        <override>
          <attributeName>cmo_first_name</attributeName>
          <value>Janette</value>
        </override>
        <override>
          <attributeName>cmo_last_name</attributeName>
          <value>Smith</value>
        </override>
      </overrides>
</response>

setMasterRecordOverrides

Applies an override on one or several attributes in a given record. Use the attributeName-value pair to set overrides.

Request
<request>
    <viewName>masters</viewName>
    <entityType>party</entityType>
    <recordId>1982</recordId>
    <overrides>
        <override>
            <attributeName>cmo_first_name</attributeName>
            <value>John</value>
        </override>
        <override>
            <attributeName>cmo_last_name</attributeName>
            <value>Smith</value>
        </override>
    </overrides>
</request>

The response is empty.

deleteMasterRecordOverrides

Deletes applied overrides on specified attributes in a given record.

Request
<request>
    <viewName>masters</viewName>
    <entityType>party</entityType>
    <recordId>1982</recordId>
    <attributes>
        <attributeName>src_first_name</attributeName>
        <attributeName>src_last_name</attributeName>
    </attributes>
</request>

The response is empty.

deleteAllMasterRecordOverrides

Deletes all applied overrides in a given record.

Request
<request>
    <viewName>masters</viewName>
    <entityType>party</entityType>
    <recordId>1982</recordId>
</request>

The response is empty.

Was this page useful?