Siebel Installation Guide for Microsoft Windows > Requirements for Installing and Configuring Siebel Business Applications > Planning Your Siebel Deployment >

Creating the Siebel File System


This topic is part of Planning Your Siebel Deployment.

The Siebel File System is a shared directory, or set of directories, that is network-accessible to the Siebel Server and that can store files such as attachments for use by Siebel Business Applications. Siebel File System directories might optionally exist on multiple separate devices or partitions.

Each File System directory might be created on a server computer where you have installed a Siebel Server, or on another network server that can share the directory, so that it is available to the Siebel Server. Consult your third-party documentation for requirements for networked file systems.

Creating multiple Siebel File System directories in different locations can enable you to store larger volumes of data. As new file attachments are inserted, they are evenly distributed to these multiple File System directories. If you create multiple File System directories, then you must include all of the directory locations, delimited by commas, when you specify the Siebel File System location during configuration of your Siebel environment. Each File System directory location must be uniquely named within the network context where it will be accessed.

You can exclude certain types of files from being saved to the Siebel File System, as determined by their file extensions. For more information about setting system preferences to enable this feature and to specify the file extensions to be excluded, see Siebel Security Hardening Guide.

Siebel File System Requirements

The following are requirements for the Siebel File System. Additional requirements are noted later in this topic.

  • You specify the Siebel File System directory when you configure and deploy the Siebel Enterprise using Siebel Management Console. Siebel Management Console creates the Siebel File System directory if the directory specified for the File System does not exist. However, t is recommended that you create the primary Siebel File System directory with appropriate permission before you configure the Siebel Enterprise.
  • The Siebel File System directory location must be specified using UNC format, such as \\computer_name\FS. If this directory is located on the same computer or operating system instance where you are installing and configuring Siebel Business Applications software, then the directory must be created as a shared directory. The user running the Siebel Management Console must have write permission in the Siebel File System directory.
  • It is strongly recommended that you disable short file-name generation on Windows server computers or operating system instances hosting the Siebel File System. Using this type of file-naming can cause severe performance issues when the file system grows to a large size.
  • The underlying physical file system must use file locking. Valid locks must be returned that are appropriate to the action being undertaken. For example, when a file is created or written to, an exclusive lock is needed. File locking must ensure the integrity of the files accessed. If a write lock is acquired for a file, then no other process must be able to access the file. For more information and recommendations, see 759070.1 (Article ID) on My Oracle Support.
  • If the operating systems of the computers hosting the Siebel Server and a File System directory are different (for example, one Windows and one UNIX), then you might have to deploy a third-party cross-platform networking tool, such as Samba, to allow both computers to share the directory. See your third-party vendor documentation for details.
  • You must create a separate Siebel File System for each Siebel Enterprise. For example, if you have development and test databases, then you must have two separate Siebel Enterprises, and therefore two Siebel File Systems.
  • The ability to use multiple directories and devices for the Siebel File System does not apply to the Siebel Mobile Web Client, for which the Siebel File System must use a single directory on the client computer.
  • If you operate a File System directory as part of a cluster for failover purposes, then you must create the directory on a clustered disk drive with a clustered network share resource. For information about clustering your servers and about deployment options for the Siebel File System, see Siebel Deployment Planning Guide.

Siebel File System and Siebel Server Components

Each Siebel Server accesses the Siebel File System (for the Siebel Enterprise) by means of a dedicated server component, called File System Manager (alias FSMSrvr). Individual Siebel Web Clients require no direct knowledge of the locations of the Siebel File System directories, because they connect to FSMSrvr through the Application Object Manager component on the Siebel Server to request file uploads or downloads. The Application Object Manager passes such requests to FSMSrvr, which processes the requests through interaction with the File System directories.

Because the Siebel Server is the sole access mechanism to the Siebel File System, the user with administrative privileges for the Siebel Server, and no other user, must have access privileges to the File System directories. This precaution protects the File System from direct physical access by all other users.

Some Siebel Server components might access the Siebel File System directly, without using File System Manager.

Siebel File System Parameter

The Siebel File System parameter defines the particular directory or set of directories that you are using for the Siebel File System. Specify multiple File System directories delimited by commas.

The Siebel File System parameter can be defined at the Siebel Enterprise level, Siebel Server level, or server component level. For example, for a Siebel Server dedicated for use with Siebel EIM, you might choose to use a Siebel File System location that is not in general use in the Siebel Enterprise. Use Siebel Server Manager to individually modify the parameter at the Siebel Server or component level, if the File System that is to be used by a particular Siebel Server or applicable component has different directory locations than are defined for the Siebel Enterprise.

The value of the Siebel File System parameter cannot exceed 2048 characters in length.

NOTE:  Verify that the network names of servers that support the Siebel File System are properly recorded in your copy of the worksheet in Siebel Deployment Planning Worksheet. Use the computer names, not the IP addresses, for the Siebel File System names. IP addresses are not supported.

Siebel File System Utilities

The following utilities are available to help you manage your Siebel File System directories: sfscleanup and sfspartition.

  • Use sfscleanup to clean up orphan files in the Siebel File System.
  • Use sfspartition to configure an existing Siebel File System to use multiple partitions or multiple directories.

For information about using these utilities, see Siebel System Administration Guide.

Naming a Siebel File System Directory

Each Siebel File System directory name must be alphanumeric, must begin with an alphabetic character, and cannot contain special characters or spaces. Underscores are permitted. For example, you might name a directory something like this:

\\server\siebel

Such a directory might be referred to using the following notation:

\\SiebelFS\siebel17

where:

  • SiebelFS is the host name of the computer (for example, where a dedicated computer is used for the Siebel File System).
  • siebel17 is the name of the shared directory.

You have to specify all of the applicable UNC sharenames (delimited by commas) when configuring the Siebel Enterprise. These shared directories must be available to all of the Siebel Servers in the Siebel Enterprise.

NOTE:  When you create a Siebel File System shared directory, only the associated Siebel Servers must be allowed to create subdirectories in that location. Do not manually create subdirectories in that location.

As part of the Siebel Server installation, File System Manager automatically generates a set of subdirectories under each Siebel File System root directory. Some of these directories are described in Table 21.

Table 21. Siebel File System Subdirectories
Subdirectory
Purpose

att

Main subdirectory for file attachments

atttmp

Temporary directory for file attachments

CFGCache

Files used by Siebel Product Configurator

CFGDefs

Files used by Siebel Product Configurator

cms

Files used for outbound communication requests

eim

Siebel transaction files for Siebel EIM

ISS_OBrkCache

Files used by Siebel Product Configurator

Marketing

Main subdirectory for Siebel Marketing

red

Rule edit cache for Siebel Product Configurator

ssp

Session preferences

userpref

Siebel user preferences

For a migration installation case, Siebel File System subdirectories from previous releases are retained. Some of these directories might no longer apply in the current release, due to evolving feature support in Siebel Business Applications.

For more information about some of the Siebel File System subdirectories, see applicable documentation on Siebel Bookshelf, including Siebel System Administration Guide.

Setting Up the Siebel File System

Use the following procedures to set up the Siebel File System directories.

NOTE:  In addition to using the following steps, you must install the third-party software required to view standard attachment types, such as Microsoft Word, Excel, or Lotus Notes, on client computers where users run Siebel Business Applications.

To set up the Siebel File System

  1. Create each directory on the applicable server and record all of the directory locations in the copy that you made of the worksheet in Siebel Deployment Planning Worksheet.
  2. Using Windows Explorer, select the directory, and then choose File, then Properties, and then Sharing. Select Share this folder.
  3. Type a name for the Share name.

    NOTE:  When you want to add a client or new user to this share, you click Add under the Security tab to browse for the user or group name.

    You might want to type the number of the Siebel release that you are installing in the Comments field for future identification. However, completion of the field is not required.

    NOTE:  When installing a new File System directory, do not change the default setting for Maximum Allowed.

  4. To grant UNC access to the Siebel administrator, click Permissions and choose the appropriate user or group name. When you want to add a client or new user to this share, you click Add to browse for the user or group name.

    NOTE:  Only the system administrator for the Siebel Server, and no other user, must have access privileges to the Siebel File System directories.

  5. From the Permissions list, make sure that Full Control is selected.
  6. Click OK to finish.
  7. Grant Windows access to each Siebel Server and client:
    1. On the Security tab, select the appropriate user or group name and make sure that Full Control is selected on the Permissions list.
    2. Click Advanced.
    3. On the Access Control Settings dialog box, make sure that you check the option to allow inheritable permissions from the parent to propagate to this object.
  8. To close the Permissions and File Properties dialog boxes, click OK.
Related Topics

Populating the Siebel File System

Related Books

Siebel Deployment Planning Guide

Siebel System Administration Guide

Siebel Security Guide

Siebel Security Hardening Guide

Siebel Installation Guide for Microsoft Windows Copyright © 2017, Oracle and/or its affiliates. All rights reserved. Legal Notices.