Print      Open PDF Version of Online Help


Previous Topic

Next Topic

About Personal Extract Definitions

A personal extract definition is an XML file that defines a set of data that Oracle CRM On Demand synchronizes with a client application. The personal extract definition specifies a list of record types, the list of fields for each record type, and the filter criteria used to determine which data is synchronized. The two types of personal extract definition are as follows:

  • Role-specific. It is used for all users with the specified role.
  • Default. It is used for all users who do not have a role-specific personal extract definition defined.

On the Personal Extract Definition List page, you can upload multiple personal extract definitions for a single client application. Each client application can have one active default personal extract definition and one active personal extract definition for each role. For more information about uploading personal extract definitions, see Managing Personal Extract Definitions.

When a personal export request is created through a Web services call, the data defined in the personal extract definition is exported to one or more CSV files. The personal extract definition used is either a role-specific personal extract definition or the default personal extract definition for the client. The default definition is used if no role-specific personal extract definition has been created.

Example of a Personal Extract Definition XML File

The following example illustrates the structure of a personal extract definition XML file. In this example, the Account Name and Location fields for the Account record type and the AccountId and ContactId fields for the Account Contact child record type are specified.

<?xml version="1.0" encoding="utf-8"?>

<PersonalExtract>

<ClientName>Mobile Client</ClientName>

<Description>PED for Mobile Client</Description>

<DateTimeFormat></DateTimeFormat>

<TimeZone></TimeZone>

<Delimiter></Delimiter>

<ListOfRecordType>

<RecordType>

<Name>Account</Name>

<ViewMode>Personal</ViewMode>

<BookId></BookId>

<IncludeSubBooks></IncludeSubBooks>

<ListOfField>

<Field>

<FieldName>AccountName</FieldName>

</Field>

<Field>

<FieldName>Location</FieldName>

</Field>

</ListOfField>

</RecordType>

<RecordType>

<Name>Acct Contact</Name>

<ListOfField>

<Field>

<FieldName>AccountId</FieldName>

</Field>

<Field>

<FieldName>ContactId</FieldName>

</Field>

</ListOfField>

</RecordType>

</ListOfRecordType>

</PersonalExtract>

For sample personal extract definition XML files that you can use, see Examples of Personal Extract Definition XML Files.

XML Elements of the Personal Extract Definition File

The following table describes each of the elements in the personal extract definition XML file.

XML Element

Required

Default Value

Element Contents

<PersonalExtract>

Yes

Not applicable

The root element of the personal extract definition.

<ClientName>

Yes

Not applicable

The name of the client. This name is displayed in the UI when a personal extract definition is saved.

<Description>

No

Not applicable

A description of the client. The description is displayed in the Personal Extract Definition List page.

<DateTimeFormat>

No

USA

The DateTime format for values in the exported CSV files. All values supported by the export functionality are allowed: USA, CAN, UK, EUR, and Other.

<TimeZone>

No

User Default

 

The time zone used for Date, Time, or DateTime values in the exported CSV files. The values are: User Default, Company Default, or any time zone value that Oracle CRM On Demand supports.

<Delimiter>

No

Comma

The delimiter value used in the exported CSV files. The values are: Comma or Semi-Colon.

<ListOfRecordType>

Yes

Not applicable

Contains the list of record types to be exported for a client.

<RecordType>

Yes

Not applicable

Contains the definition of the records to be exported for a record type.

searchspec

(attribute of <RecordType>)

 

 

No

All visible

The filter criteria for a record type. The syntax is the same as that used in the searchspec argument in the Web Services v2.0 QueryPage method. The fields are specified using the Web Services v2.0 integration tag. All operations of the Web Services v2.0 call are supported in the searchspec attribute. For more information, see Oracle Web Services On Demand Guide.

<Name>

Yes

Not applicable

The name of the record type. It can be a parent or a child record type. For child record types, the name is the child access object ID. For more information, see Oracle Migration Tool On Demand Guide. In that guide, record type names are listed under the Object Name in the XML File column in the table of object names and their corresponding display names in the UI. For more information, see Specifying Record Types in Personal Extract Definitions.

All record types and fields supported by the Web Services v2.0 API are supported.

<ViewMode>

No

See section about using <ViewMode> and <BookId>

The level of access to be applied. For more information about the values of ViewMode, see Oracle Web Services On Demand Guide.

<BookId>

No

Not applicable

A book to which records are assigned.

<IncludeSubBooks>

No

Y

Whether to include subbooks. The values are: Y and N.

<ListOfField>

Yes

Not applicable

Contains the list of fields to be exported for a record type.

<Field>

Yes

Not applicable

Contains a field to include in the export.

<FieldName>

Yes

Not applicable

The name of the field. The names are the internal names that are used in the Web Services v2.0 WSDL file for the record type.

For custom fields, you can specify either the custom or generic integration tag for the field. For example, a custom field of type Text (Short) might have a custom integration tag of stCustomTextSample and a generic integration tag of customtext01. For more information about integration tags, see Setting Up Custom Field Integration Tags and Specifying Record Types in Personal Extract Definitions.

About Using <ViewMode> and <BookId>

In personal extract definitions, you can use <ViewMode> and <BookId> to restrict the records exported for a record type to a particular access level or book. When using <ViewMode> and <BookId> the following rules are applied by Oracle CRM On Demand:

  • If neither a ViewMode nor BookId value is specified, then ViewMode is set to Broadest.
  • If a ViewMode value is not specified but a BookId is specified, then the record type is exported with the BookId applied, and the ViewMode is set to Context.
  • If both ViewMode and BookId values are specified and ViewMode does not have the value Context, then the BookId is used, and the ViewMode is set to Context.

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