3
Administration Tools Overview

A full range of administration tools are provided with Oracle Files to configure Oracle Files, start and stop domains and nodes, configure nodes, manage service and server objects, provide security for documents, work from the command line, migrate data and users to Oracle Files, import/export data and users from one Oracle Files schema to another, and monitor domain, service, and node performance. These include:

Configuration Wizards

Configuration wizards are used during installation to initially set up the Oracle Files domain and specify a default credential manager to associate with the domain. As you work with Oracle Files, you may wish to change these default settings. You can do this by running the various configuration wizards.

Oracle Files Configuration Assistant

The Oracle Files Configuration Assistant is an installation and configuration wizard that lets you create an Oracle Files domain.

The Configuration Assistant is specific for the release of Oracle Files. The tool performs these important functions:

Create the domain controller.
Create the nodes.
Configure protocol servers.
Create an Oracle Files schema and all associated objects in the Oracle9i database.

You launch the Configuration Assistant from the command line by executing the ifsca script, located in the following directory:

$ORACLE_HOME/ifs/files/bin

<pre>

You can also prepare or modify a response file and pass the filename to the Configuration Assistant as a parameter, for a non-interactive, or "silent," configuration. See the Oracle Collaboration Suite Installation Guide for details.

Oracle Files Credential Manager Configuration Assistant

The Oracle Files Credential Manager Configuration Assistant lets you create, edit, and configure Ifs credential managers and Oracle Internet Directory (OID) credential managers. This wizard launches automatically during configuration and enables you to accept the default Ifs credential manager or create an OID credential manager.

After initial installation and configuration of the domain, you can use this wizard to reconfigure credential managers. For example, if the Oracle Internet Directory associated with a particular credential manager you've created migrates to a different host on the network, you will need to reconfigure the OID credential manager accordingly. See Chapter 6, "Oracle Internet Directory and Credential Management" for more information.

Management Tools

Which management tool you use will depend on the function to be performed and whether you want to work with the Oracle Files domain as one of several middle-tier applications integrated with the Oracle Enterprise Manager Console.

Oracle Enterprise Manager Website

Oracle Enterprise Manager Website provides Web-based management tools designed specifically for Oracle9i Application Server. You can monitor and configure the components of your Oracle9i Application Server installations as well as access basic Oracle Files domain and node functions. It also allows administrators to monitor and dynamically tune the domain's nodes, services, and servers. Using Oracle Enterprise Manager Website, you can:

Start and stop the domain, nodes, services, and servers using a Web browser from any machine on the network;
Configure protocol servers, agents, nodes, services, and change settings dynamically, for the current runtime session; change settings permanently; and change default settings to be used as the basis for new servers;
Display runtime operational data about the domain, nodes, hosts, and servers at runtime, so you can monitor performance and change system configuration, if necessary.

Accessing the Oracle Enterprise Manager Website

From your web browser, access the Oracle Enterprise Manager Website by pointing your browser to:

http://hostname:1810/

<pre>

The page you see depends on the components you configured and the choices you made during Oracle9iAS installation and whether or not you installed an Oracle9iAS Infrastructure. For example, you might see the Oracle9iAS Farm Home page listing all of the application server instances associated with a particular Oracle9iAS instance or the Application Servers Home page listing all of the application server instances installed on the current host.

Command-line Utilities, Scripts, and Other Tools

Command-line utilities and scripts are interfaces for administrators familiar with Oracle products who want to work directly from the command line.

ifsctl

ifsctl is a tool for starting, stopping, and monitoring Oracle Files domains and nodes from the command line. Details are provided in "Starting Oracle Files from the Command Line" in Chapter 4.

Scripts

The following scripts may be used:

Script	Description
ifsca	Run the Oracle Files Configuration Assistant
ifscmca	Start the Oracle Credential Manager Configuration Assistant.
ifsctl	Manage domains and nodes.

Bulk Administration Tools for Oracle Files

A Subscriber Administrator can use the Bulk Creation and Update tools to administer users and workspaces in Oracle Files.

Each tool works in a similar manner: it reads an XML file containing a list of "actions" (for instance, create a workspace or update users), processes the list, and executes the actions.

The Bulk Creation and Update tools include:

User Administration Tool

The User Administration tool updates the profile of each user listed in an XML file, unless the user does not exist in the Subscriber. Some exceptions exist, however:

Quota: The User Administration tool does not update a user's quota should the quota exceed the granted limit. Also, a user's quota is not updated if the new value is below that of the user's consumed storage.
Locking and Unlocking Files: A user's Public Folder that is not empty cannot be disabled.

Note:

User passwords cannot be changed using the User Administration tool.

Besides user profiles, the XML file also contains an "action" which, in the case of the User Administration tool, is an "update action":

<action label="update">
<class>oracle.ifs.files.admin.bulk.user.action.UpdateNormalUsersAction</class> 

<pre>
<user>
  <userid>test.user</userid> 
  <quota>25</quota> 
  <locale>us</locale> 
  <publicfolder enabled="yes" /> 
  </user>
  </action>

The XML file must conform to the User Administration tool Document Type Definition (DTD).

DTD for the User Administration Tool

<!DOCTYPE users [
  <!ELEMENT users (defaults?, (action|condition)+)>
  <!ELEMENT defaults (property+)>

  <!ELEMENT condition (condition|action)+>         
  <!ATTLIST condition type NMTOKEN #REQUIRED>     
  <!ATTLIST condition op NMTOKEN #REQUIRED>       
  <!ATTLIST condition left CDATA #REQUIRED>       
  <!ATTLIST condition right CDATA #REQUIRED>      

  <!ELEMENT action (class, property*, user+)>
  <!ATTLIST action label ID #REQUIRED>
  <!ATTLIST action description CDATA #IMPLIED>

  <!ELEMENT class (#PCDATA)>
  
  <!ELEMENT property EMPTY>
  <!ATTLIST property name NMTOKEN #REQUIRED>
  <!ATTLIST property value CDATA #REQUIRED>

  <!ELEMENT user (userid, password?, email?, firstname?, lastname?, quota?, 
locale?, publicfolder?)>

  <!ELEMENT userid (#PCDATA)>
  <!ATTLIST userid enabled (yes|no) #IMPLIED>

  <!ELEMENT password (#PCDATA)>

  <!ELEMENT email (#PCDATA)>

  <!ELEMENT firstname (#PCDATA)>

  <!ELEMENT lastname (#PCDATA)>

  <!ELEMENT quota (#PCDATA)>

  <!ELEMENT locale (#PCDATA)>

  <!ELEMENT publicfolder EMPTY>
  <!ATTLIST publicfolder enabled (yes|no) "yes">

Running the User Administration Tool

To run the User Administration tool, the Subscriber Administrator must run:

oracle.ifs.admin.bulk.user.UsersAdministrationTool

Before running the User Administration tool, the following parameters must be specified in the following order:

Oracle Files Domain; for example, ifs://user-sun.us.company.com:1521:seamus:ifuser
Service Configuration Name; for example, MediumServiceConfiguration
Oracle Files Password
Oracle Files User Password
sba=<Subscriber Administrator username>; for example, sba=subscriber_admin
pwd=<Subscriber Administrator password>
file=<XML file containing the list of actions to perform>

For example, to invoke the User Administration tool, enter the following:

JAVA_HOME/bin/java -Xmx512m -DIFS.DOMAIN.NODE.OracleHome=$ORACLE_HOME 
-DIFS.DOMAIN.NODE.IfsHome=$IFSHOME 
oracle.ifs.files.admin.bulk.user.UsersAdministrationTool $IFSDOMAIN 
MediumServiceConfiguration $IFSSCHEMAPASSWORD $IFS_SYSTEM_USER $IFS_SYSTEM_
USER_PASSWORD sba=$1 pwd=$2 file=$3

Workspace Administration Tool

Running the Workspace Administration tool will "determine" whether the Workspace Creation tool or the Workspace Update tool will be invoked. If the Workspace Creation tool is invoked, one or more workspaces are created. If the Workspace Update tool is invoked, one or more workspaces are updated. The Workspace Update tool will use the workspace information contained in the XML file to update or create workspaces in Oracle Files.

Running the Workspace Administration Tool

The Subscriber Administrator invokes the Workspace Administration tool by running:

oracle.ifs.files.admin.bulk.workspace.WorkspacesAdministrationTool

To run the Workspace Administration tool, the following parameters must be specified in the following order:

Oracle Files Domain; for example, ifs://user-sun.us.company.com:1521:seamus:ifuser
Service Configuration Name; for example, MediumServiceConfiguration
Oracle Files Password
Oracle Files User Password
sba=<Subscriber Administrator username>; for example, sba=subscriber_admin
pwd=<Subscriber Administrator password>
file=<XML file containing the list of actions to perform>

Sample XML File

This XML file contains one "action" for updating workspaces and another "action" for creating workspaces:

<action label="create">
  
<class>oracle.ifs.files.admin.bulk.workspace.action.CreateWorkspacesAction</
class> 
<workspace name="test_workspace" type="public">
  <description>Test Workspace for the administration tool</description> 
  <member name="test.user" access="admin" /> 
  </workspace>
  </action>

<action label="update">
  
<class>oracle.ifs.files.admin.bulk.workspace.action.UpdateWorkspacesAction</
class> 
<workspace name="test_workspace">
  <quota>40</quota> 
  <publicfolder enabled="no" /> 
   </workspace>
  </action>

DTD for the Workspace Administration Tool

The XML file must conform to a Workspace Administration tool DTD. The following is a DTD file for the Workspace Administration tool:

<!DOCTYPE workspaces [

  <!ELEMENT workspaces (defaults?, (action|condition)+)>

  <!ELEMENT defaults (property+)>

  <!ELEMENT condition (condition|action)+>         
  <!ATTLIST condition type NMTOKEN #REQUIRED>     
  <!ATTLIST condition op NMTOKEN #REQUIRED>       
  <!ATTLIST condition left CDATA #REQUIRED>       
  <!ATTLIST condition right CDATA #REQUIRED>

  <!ELEMENT action (class, property*, workspace+)>
  <!ATTLIST action label ID #REQUIRED>
  <!ATTLIST action description CDATA #IMPLIED>

  <!ELEMENT class (#PCDATA)>
  
  <!ELEMENT property EMPTY>
  <!ATTLIST property name NMTOKEN #REQUIRED>
  <!ATTLIST property value CDATA #REQUIRED>

  <!ELEMENT workspace (description?, quota?, publicfolder?, member*)>
  <!ATTLIST workspace name NMTOKEN #REQUIRED>
  <!ATTLIST workspace type (public|private) #IMPLIED>

  <!ELEMENT description (#PCDATA)>

  <!ELEMENT quota (#PCDATA)> 

  <!ELEMENT publicfolder EMPTY>
  <!ATTLIST publicfolder enabled (yes|no) "no">

  <!ELEMENT member EMPTY>
  <!ATTLIST member name NMTOKEN #REQUIRED>
  <!ATTLIST member access (admin|RW|RO|delete) #REQUIRED>

Workspace Creation Tool

The Workspace Creation tool is invoked by the Workspace Administration tool to create new workspaces in Oracle Files. The Workspace Creation tool creates each workspace that is listed in the XML file unless it encounters errors. Such errors include:

A pre-existing Workspace name in the Subscriber.
A Workspace name containing any of the following characters: \ / : * ? " < > |
A Workspace Administrator is not specified in the list of members.

Creation of the Workspace(s) in the Subscriber exceeds the Subscriber's total quota.

Table 3-1 XML File Workspace Property Settings

Property	Attributes	Required	Valid Input	Default if Optional
Workspace	N/A	Yes	N/A	N/A
N/A	Name	Yes	N/A	N/A
N/A	Type	No	Public\| Private	Private
Description	N/A	No	N/A	N/A
Quota	N/A	No	MB	Subscriber's default Workspace quota
Publicfolder	N/A	No	N/A	Enabled if the Workspace type is public; disabled, otherwise
N/A	Enabled	No	Yes \| No	No
Member	N/A	No	N/A	N/A
N/A	Name	Yes	N/A	N/A
N/A	Access	Yes	Admin \| RO \| RW \| Delete	N/A