Oracle CRM On Demand Desktop Administration Guide > Customizing Oracle CRM On Demand Desktop > Customizing Oracle CRM On Demand Desktop >

Files in the Customization Package


To customize certain Oracle CRM On Demand Desktop features, you can modify XML files and JavaScript files in the customization package. Oracle CRM On Demand Desktop includes the following basic customization capabilities:

  • Adjusting the business logic to suit the business environment
  • Customizing the user interface
  • Specifying security and data validation rules

For more information, see Where Oracle CRM On Demand Desktop Stores Data in the File System.

About the Customization Package

The customization package consists of two types of files:

  • Common platform JavaScript files that should not be changed during customization
  • Product-specific files that include Javascript files and XML files.

    You must tune product-specific files during customization to change the Oracle CRM On Demand Desktop behavior according to desired business logic in Oracle CRM On Demand.

Common platform files are added or replaced as required during an upgrade to the current version of Oracle CRM On Demand Desktop. For more details, see Table 14 and Table 15.

NOTE:  Make sure that you have not changed any of the common platform files during the customization process. If you have changed any of those files, then make sure to migrate all the changes manually. It is preferable to restructure your customization to move all the changes to product-specific files and avoid any changes to the common platform JavaScript files.

JavaScript Files in the Customization Package

Table 14 describes the JavaScript files that Oracle CRM On Demand Desktop includes in the customization package.

Table 14. JavaScript Files in the Customization Package
JavaScript File Name
Description

Common Platform Files

NOTE:  Do not change common platform files during customization.

actions_support.js

Defines the common toolbar action support functions that are called from the actions.js file.

activity_processor.js

New for Version 2.0. Defines the common business logic for all the complex activity-related processing for calendar events, tasks, and email.

autoresolve_helpers.js

New for Version 2.0. Defines common helpers that are called from the autoresolver.js file.

data_model.js

Defines the common logic that handles the complex relations between objects and joined fields. This data model is initialized in the business_logic.js file.

form_helpers.js

Defines common JavaScript helpers for handling user interface events.

helpers.js

Defines the common utility functions to reuse in different files.

idle.js

Defines the Idle Processing Manager and common idle handlers.

md5.js

Defines how to implement message digest algorithm (MDA).

NOTE:  The md5.js file pertains to one of the many message digest algorithms available.

mvg_dialogs.js

Defines controls for multi-value groups (MVG).

raw_item_functions.js

Defines general functions that access Microsoft Outlook items.

od_helpers

Defines common utility functions to reuse in different files that are specific to Oracle CRM On Demand.

security_manager.js

Defines the common security model and manager used in the security_utils.js file.

Product-Specific Files

actions.js

Defines the handlers for toolbar actions.

This file includes functions for sharing email replies or forwards, and the Save Correspondence manager handler.

application_script.js

Defines the main entry point script file for the product and initializes the basic script context.

This file includes the Scriptable First Run Assistant and supports extended activity processing (partially extracted to the activity_processor.js common file). It also includes two additional handlers for always sharing email replies or forwards and the Save Correspondence manager handler. Scriptable objects open from the Microsoft Windows Control Panel on the Sync Issues and Collision pages.

autoresolver.js

Defines functions with predefined rules to resolve conflicts when possible, based on business requirements.

The major common code duplications reused in the file have been extracted to the new autoresolve_helpers.js common file to minimize and clarify the coding. This file implements a scriptable associations auto-resolver.

business_logic.js

Defines the business logic for product behavior and defines the basic data model for object relations.

This file includes a flexible activity processing model with field length restrictions support. Options for email attachments processing have moved to the Options page. Search criteria have been updated for like type searches. This file supports opening association objects from the Microsoft Windows Control Panel. The file contains settings for the custom scripted SalesBook form.

forms.js

Defines the user interface actions for all the custom forms and dialogs.

This file includes online lookups for SalesBook forms and supports record pin mode on the form. In addition, it supports custom view controls for external data storage and supports default visibility for subforms. This file validates addresses migrated from Microsoft Outlook contacts to Oracle CRM On Demand after installation.

security_utils.js

Defines the security definitions for types of objects and their relations.

This file supports record pin mode. It restricts the deletion of contacts from Oracle CRM On Demand (either by adding the record to an exclusion list so that it is not included on the client even though it is present on the server, or by cancelling the deletion). This file contains additional restrictions for Opportunity.Product (where Product is a child record of the Opportunity record).

XML Files in the Customization Package

Table 15 describes the XML files that Oracle CRM On Demand Desktop includes in the customization package. For more information, see Creating and Publishing the Customization Package.

NOTE:  All XML files in the customization package are considered product-specific, so you can customize these files as required for your business requirements.

Table 15. XML Files in the Customization Package
XML File Name
Description

connector_configuration.xml

This XML file provides the following capabilities:

  • Defines objects that are synchronized
  • Defines the criteria that Oracle CRM On Demand Desktop uses to detect duplicate objects in the Oracle CRM On Demand database
  • Defines the preset filters for a custom synchronization

For more information, see Customizing Oracle CRM On Demand Desktop.

This file supports sliding dates that reflect the concept of recurrent activity handling. The sliding dates refer to the relative date filter criteria, for example: the next month (next 30 days), the last month (last 30 days), tomorrow, yesterday, and so on. Users can choose to only include activity records due in the next 30 days. This file also includes delete prohibit restrictions at the synchronizer level.

data_sources.xml

New for Version 2.0. Describes the data sources that are used for joining fields between objects and used in online lookups.

dialogs.xml

Defines the layout of a custom dialog box. For more information, see Customizing a Dialog Box.

This file contains custom view controls that support an external database. The notes design uses a number of additional fields.

forms_XX.xml

These XML files provide the following capabilities:

  • Indicates the fields that Oracle CRM On Demand Desktop uses to store references between objects
  • Defines the form layout for each object
  • Defines the field validation rules on a form
  • Defines business logic in JavaScript
  • Defines controls that Oracle CRM On Demand Desktop uses on a form

The business_logic.js file describes most business logic. It is recommended that you use JavaScript in one of the forms_xx.xml files to define business logic only if Oracle CRM On Demand Desktop executes this logic in the current form. If many objects are involved, then it is recommended that you define business logic in the business_logic.js file.

NOTE:  Throughout this document, the term forms_xx.xml refers generically to the forms_11.xml file or the forms_12.xml file.

For more information, see Customizing a Form.

This file contains custom view controls, combo boxes, and primary selectors. The file also contains auto-complete controls that support an external database. It supports an inline (an email To: line style) multi-value group (MVG).

info.xml

This XML file provides the following capabilities:

  • Defines the product name
  • Defines the version of the package
  • Defines compatible product and package versions
  • Defines the general comments for the package

Oracle CRM On Demand Desktop does not currently use this information. You can use it to track the package version. You can use the product name and version to check compatibility.

lookup_view_defs.xml

Sets configuration options for the SalesBook control of Oracle CRM On Demand Desktop. This control defines references between objects. Oracle CRM On Demand Desktop uses it in lookup controls. For more information, see Customizing the SalesBook Control.

This file is provided for backward compatibility with earlier releases.

package_res.xx_XX.xml

Defines various resources for the customization package. For more information, see Customizing the Email Address of the Support Team.

This file includes a number of string and image resources.

platform_configuration.xml

Defines the custom data that Oracle CRM On Demand Desktop deletes if you remove Oracle CRM On Demand Desktop. For more information, see Specifying Which Data Oracle CRM On Demand Desktop Removes from Microsoft Outlook.

For this release, Oracle CRM On Demand Desktop has made some minor changes in this file.

od_basic_mapping.xml

This XML file provides the following capabilities:

  • Defines field mapping between Oracle CRM On Demand Desktop and Microsoft Outlook
  • Defines field mapping between Oracle CRM On Demand Desktop and an Oracle CRM On Demand application
  • Describes objects to add to Microsoft Outlook
  • Defines the form that Oracle CRM On Demand Desktop uses to display an object in Microsoft Outlook
  • Defines a set of custom Microsoft Outlook views that Oracle CRM On Demand Desktop applies for an object

This file supports the <multiwriter> writer and supports external data storage to reduce Microsoft Outlook storage. It describes objects to add to DB FACADE storage. For more information on DB FACADE storage, see Customizing How Oracle CRM On Demand Desktop Maps Fields.

od_meta_info.xml

This XML file provides the following capabilities:

  • Defines the object types that Oracle CRM On Demand Desktop supports
  • Defines fields and their types
  • Defines the XML element names that Oracle CRM On Demand Desktop uses to build an Oracle CRM On Demand message

For more information, see Customizing Meta Information.

This file contains support for custom view modes for different operations (such as query changes, deduplication, and obtaining an object by its ID).

toolbars_XX.xml

Defines custom toolbars that Oracle CRM On Demand Desktop displays on a native Microsoft Outlook form, custom form, or in a Microsoft Outlook window. This book uses toolbars.xml to generically refer to this file. Oracle CRM On Demand Desktop uses the following files according to the version of Microsoft Outlook installed on the client:

  • toolbars_12.xml for Microsoft Outlook 2007
  • toolbars_14.xml for Microsoft Outlook 2010

External JavaScript files define all programmable actions for a toolbar. For more information, see Customizing a Toolbar.

This file contains functionality for always sharing email replies and forwards, along with the Save Correspondence manager handler.

views.xml

Defines the views that Oracle CRM On Demand Desktop uses in Oracle CRM On Demand Desktop forms and Microsoft Outlook windows. For more information, see Customizing a View.

Oracle CRM On Demand Desktop Administration Guide, Version 5.2 Copyright © 2017, Oracle and/or its affiliates. All rights reserved. Legal Notices.