EOTF_DVM Service

This section describes the Service Operations available as web services for DVM:

  • EOTF_DVM_LOOKUP

  • EOTF_DVM_IMPORT.v2

  • EOTF_DVM_IMPORT.v1

This service operation is used to lookup values from a DVM.

Alias: dvmLookupValue

Type: Synchronous

Request Message: EOTF_DVM_LOOKUP_REQ.V1

This is an example of the soap body for the request:

<soapenv:Body>
      <dvm:dvmLookupValue>
         <dvm:mapname>?</dvm:mapname>
         <!--2 or more repetitions:-->
         <dvm:Values>
            <dvm:domain>?</dvm:domain>
            <!--1 or more repetitions:-->
            <dvm:element name="?"/>
         </dvm:Values>
         <dvm:Values>
            <dvm:domain>?</dvm:domain>
            <!--1 or more repetitions:-->
            <dvm:element name="?"/>
         </dvm:Values>
         <dvm:targetDomain>?</dvm:targetDomain>
      </dvm:dvmLookupValue>
   </soapenv:Body>

Element Name

Description

mapname

The name of the domain value map to lookup values in.

Values

This element holds the elements and values to be found in the DVM.

domain

The name of the target domain provided on the lookup request.

element

Represents a DVM element and its value.

targetDomain

The name of the domain the lookup request should return values for.

Response Message: EOTF_DVM_RESPONSE.V1

Element Name

Description

status

The status of the operation. Returns Success or Exception.

reason

If there is an exception, the reason will be returned.

requestValues

This element hold the reference values used for a lookup operation. For partially qualified lookups these values may differ from the values provided in the request.

domain

The name of the reference domain provided on the lookup request.

element

The DVM element and its value.

responseValues

The values returned for the lookup operation.

domain

The name of the target domain provided on the lookup request.

element

The DVM element in the target domain and its value.

Use this service operation to import a Domain Value Map definition and values into the Enterprise Transformation Framework, based on the PeopleSoft schema.

Type: Asynchronous-One Way.

Alias: import_dvm

Default: Yes

Request Message: EOTF_DVM.V2

This is an example of the soap body for an import request using PeopleSoft schema:

<soapenv:Body>
      <dvm:dvm>
         <dvm:name>?</dvm:name>
         <!--Optional:-->
         <dvm:description>?</dvm:description>
         <!--Optional:-->
         <dvm:comments>?</dvm:comments>
         <dvm:elements>
            <!--2 or more repetitions:-->
            <dvm:element name="?" order="?" dataType="string" dataLength="?"⇒
 isCommon="false"/>
            <dvm:element name="?" order="?" dataType="string" dataLength="?"⇒
 isCommon="false"/>
         </dvm:elements>
         <dvm:domains>
            <!--1 or more repetitions:-->
            <dvm:domain name="?">
               <!--1 or more repetitions:-->
               <dvm:element name="?" qualifier="false"/>
            </dvm:domain>
         </dvm:domains>
         <!--Optional:-->
         <dvm:rows>
            <!--1 or more repetitions:-->
            <dvm:row>
               <!--2 or more repetitions:-->
               <dvm:cell>?</dvm:cell>
               <dvm:cell>?</dvm:cell>
            </dvm:row>
         </dvm:rows>
      </dvm:dvm>
   </soapenv:Body>

Element Name

Description

description

The DVM description.

Optional

comments

Comments about the DVM.

Optional

elements

This element holds the DVM's element list.

element

Represents a DVM element.

domains

This elements holds the DVM's domain list.

domain

This element represents a domain in a DVM.

element

This represents an element in the DVM domain.

rows

This represents all the rows of data in the DVM.

row

Each DVM row of values.

cell

This is the value for this row and the for each element in the same order as defined in elements.

Use this service operation to import a Domain Value Map definition and values into the Enterprise Transformation Framework, based on the FMW schema.

Type: Asynchronous-One Way.

Alias: import_dvm

Default: No

Request Message: EOTF_DVM.V1

This is an example of the soap body for an import request using FMW schema:

<soapenv:Body>
      <dvm:dvm name="?">
         <!--Optional:-->
         <dvm:description>?</dvm:description>
         <dvm:columns>
            <!--2 or more repetitions:-->
            <dvm:column name="?" qualifier="false" order="?"/>
            <dvm:column name="?" qualifier="false" order="?"/>
         </dvm:columns>
         <!--Optional:-->
         <dvm:rows>
            <!--1 or more repetitions:-->
            <dvm:row>
               <!--2 or more repetitions:-->
               <dvm:cell>?</dvm:cell>
               <dvm:cell>?</dvm:cell>
            </dvm:row>
         </dvm:rows>
      </dvm:dvm>
   </soapenv:Body>

Element Name

Description

description

The DVM description.

Optional

columns

This element holds the DVM's column list.

column

Represents a DVM column.

rows

This represents all the rows of data in the DVM.

row

Each DVM row of values.

cell

This is the value for this row and the for each column in the same order as defined in columns.