Skip Headers
Siebel CRM Advisor Administration Guide
Siebel Innovation Pack 2015
E24718-01
  Go to Documentation Home
Home
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
    View PDF

About the Advisor Project Files

Advisor uses the information you enter in the project to create the HTML and JavaScript files. These files define the basic structure and appearance of the application. These files are stored in Oracle's Siebel File System and listed in the Project Files tab. When you preview or deploy the project, these files and directories are created in two different directories, both under ISSRUN\CDAPROJECTS. For information about the Advisor files, see Siebel Advisor API Reference.

Advisor provides a structured approach to creating and managing the files that make up an application. An Advisor project is a collection of project objects that represent the files in an application.

Many of the project objects are identical, in name and underlying format, to the application files they represent. For example, the Application UI Definition file object in an Advisor project is precisely the same file as the Application UI Definition file in the associated application.

However, some application files are not represented as file objects in Advisor. For example, a Contents file in an application is represented in Advisor as a contents list table.

Certain application files are represented by a collection of Advisor project objects, as opposed to a single object. For example, a single Configuration Data file in an application is represented in Advisor as a collection of Configuration tables.

Advisor generates application files from Advisor project objects when you preview or deploy your project.

Advisor Project Structure

The organization in which Advisor presents the project objects reflects the organization of the associated application.

Project objects that define the overall appearance and functionality of the application are considered application-level objects. These application-level objects include the Application UI Definition file and a contents list table.

The application presents information related to one or more categories. Advisor groups all of the project objects related to a single category into a pageset.

Within each pageset, the project objects are organized into two categories: data objects and interface objects. Each data object is further classified as a feature data object or a configuration data object. The feature data and configuration data objects are Feature tables and Configuration tables respectively. The interface objects within a pageset are the Pageset UI Definition file and the Pageset UI Registry file.

Every pageset in an application, at a minimum, contains the following items:

  • A Pageset UI Definition file (oc_default_ui.htm)

  • A Pageset UI Registry file (pCar_i.htm)

  • At least one Configuration table

  • One or more Feature tables

  • One or more display pages

The Project Files Tab

The Project Files tab contains a list of the directories and files that make up your Advisor application. These files include HTML, Javascript, and images. You can use a text editor to change some of the files displayed on the Files tab.

Every application contains the directories and files listed in this section.

Engine File Directories

When you deploy or preview a project, first the engine files are copied from the file system source directory on the server, <Siebel Root Directory>\ISSTEMPL\<Localization Code>\EngineSourceFiles, to the project runtime directory for the Project Files Tab. Then any project files stored in the database are copied to the runtime directory. If you customize engine files on the server and files with the same name exist in the database (app_config.js, for example), your customized files will be overwritten. Therefore, if you want your customizations to persist after deployment or preview of the project, store them in the database by adding them to the Project Files tab.

The following engine directories and files are associated with each project:

  • The custom directory contains JavaScript files that you can edit to customize the behavior of the applications' engine without modifying the core engine code itself. You can also use the app_config.js file in this directory to set configuration variables, such as the size of the About window, for your application.

  • The ds directory contains the Pageset Properties file, pagesetID_x.js. It also contains product data files generated from the information you enter in Advisor Configuration and Feature tables. Do not edit the generated product data files. You can change information in the tables and regenerate the data files if you need to.

  • The jd directory contains the application module registry and its associated files. Do not edit files in this directory unless you are developing your own application modules.

Application File Directories

The pg directory contains the following application files:

  • Pageset UI Registry files.

  • Pageset UI Definition files.

  • Display pages for all the pagesets in your application.

  • A cascading style sheet, onlink.css, that defines the appearance of the contents list.

  • Any additional HTML and image files used to customize the appearance of display pages.

The UI Directory contains files that define the appearance of the Advisor application. These files apply to the application in general and not to any specific pageset.