Print      Open PDF Version of Online Help


Previous Topic

Next Topic

Specifying Record Types in Personal Extract Definitions

When creating a personal extract definition file, you must specify the record types that you want to extract in the definition file. For example:

<RecordType>

<Name>Acct Contact</Name>

<RecordType>

The record type name value that is specified in the personal extract definition file uses a name from the column, Object Name in the Access Profile XML File, in a table in an appendix of Oracle Migration Tool On Demand Guide. This value does not appear in the Oracle CRM On Demand UI. The field name values that are specified in the personal extract definition file are the Web Service v2.0 integration tag values for the specified record types. Administrators can retrieve the necessary information from Oracle CRM On Demand to populate correctly the personal extract definition file in two ways, as described in the following procedures.

Specifying the Record Type and Fields Manually

You can find the required record type name in Oracle Migration Tool On Demand Guide and then find the field names in the WSDL file for that record type.

To specify the record type and fields manually

  1. Using the default Display Name value for the record type, identify the corresponding value from the Object Name in the Access Profile XML File column.

    For information on the Display Name value, see Oracle Migration Tool On Demand Guide.

  2. Add the value to your personal extract definition file:

    <RecordType>

    <Name>Object Name in the Access Profile XML File</Name>

    <RecordType>

  3. Download the Web Services v2.0 Custom WSDL file for the top-level or child record type that you want to extract.
  4. Find the <ListOfObject> element for the record type in the WSDL file.

    In most cases, Object is equivalent to the default display name of the record type in Oracle CRM On Demand.

  5. Add the set of fields that you want to extract to the <RecordType> element in the personal extract definition file.

    The field names correspond to tags within the <ListOfObject> element:

    <RecordType>

    <Name>Object Name in the Access Profile XML File</Name>

    <ListOfField>

    <Field>

    <FieldName>Integration Tag from WS v2.0 WSDL</FieldName>

    </Field>

    <Field>

    <FieldName>Integration Tag from WS v2.0 WSDL</FieldName>

    </Field>

    <RecordType>

Specifying the Record Type and Fields by Using the Field Management Web Service

You can retrieve the required record type name and the field names by using the Field Management Web service, which is part of the Administrative Services API.

The elements returned in the SOAP response for the FieldManagamentRead and FieldManagementReadAll methods include the following:

  • <ObjectName>. The name of the record type.
  • <Name>. The internal name of the field used by Oracle CRM On Demand.
  • <DisplayName>. The name of the field used in the UI.
  • <IntegrationTag>. The custom integration tag name of the field.
  • <GenericIntegrationTag>. The default integration tag name of the field that Oracle CRM On Demand assigns.

For more information about the Field Management Web service, see Oracle Web Services On Demand Guide.

To specify the record type and fields by using the Field Management Web service

  1. Make a call to the Field Management Web service for each record type that you want to extract.
  2. In the SOAP response, identify the <ObjectName> for the record type.
  3. Add the <ObjectName> value to your personal extract definition file:

    <RecordType>

    <Name>ObjectName value from Field Management API</Name>

    <RecordType>

  4. Add the set of fields that you want to extract to the <RecordType> element in the personal extract definition file.

    The field names correspond to the <IntegrationTag> or <GenericIntegrationTag> value:

    <RecordType>

    <Name>ObjectName value from Field Management API</Name>

    <ListOfField>

    <Field>

    <FieldName>Integration Tag value from Field Management API</FieldName>

    </Field>

    <Field>

    <FieldName>Integration Tag value from Field Management API</FieldName>

    </Field>

    <RecordType>


Published 5/4/2012 Copyright © 2005, 2012, Oracle. All rights reserved. Legal Notices.