This section describes the administrative scripts that assist you in working with BusinessObjects Enterprise on UNIX. The remainder of this guide discusses the concepts behind each of the tasks that you can perform with these scripts. This reference section provides you the main command-line options and their arguments.
ccm.sh
The ccm.sh script is installed to the bobje directory of your installation. This script provides you with a command-line version of the CCM. This section lists the command-line options and provides some examples.
Note:
•
Arguments in square brackets [ ] are optional.•
By default, servers are named with a hostname.servertype convention. If the option requires the server name, use servertype as the server name. If the option requires the fully qualified server name, usehostname.servertype. If you are unsure of a server’s fully qualified name, look in the ccm.config file, locate the server’s launch string, and use the value that appears after the -name option.
UNIX Tools
Script utilities
8
BusinessObjects Enterprise XI Release 2 Administrator’s Reference Guide 77
•
Arguments denoted by other authentication information are provided inthe second table.
CCM Option Valid Arguments Description
-help n/a Display command-line help.
-start all or servername Start each server as a process. Use the short form of the server name.
-stop all or servername Stop each server by terminating its Process ID. Use the short form of the server name.
-restart all or servername Stop each server by terminating its Process ID; then each server is started. Use the short form of the server name. -enable all or hostname.servertype
[other authentication information] Enable a started server so that it registers with the system and starts listening on the appropriate port. Use the fully qualified form of the server name.
-disable all or hostname.servertype
[other authentication information] Disable a server so that it stops responding to BusinessObjects Enterprise requests but remains started as a process. Use the fully qualified form of the server name.
-display server [other authentication
information] Reports the server’s current status (enabled or disabled). The CMS must be running before you can use this option.
-updateobjects [other authentication information] Update objects migrated from a previous version of BusinessObjects Enterprise into your current CMS system database. Use this option after running cmsdbsetup.sh.
UNIX Tools
Script utilities
8
This table describes the options that make up the argument denoted by other authentication information.
The CCM reads the server launch strings and other configuration values from the ccm.config file. For details, see “ccm.config” on page 79.
Examples
These two commands start and enable all the servers. The Central Management Server (CMS) is started on the local machine and the default port (6400): ccm.sh -start all
ccm.sh -enable all
These two commands start and enable all the servers. The CMS is started on port 6701, rather than on the default port:
ccm.sh -start all
ccm.sh -enable all -cms MACHINE01:6701
These two commands start and enable all the servers with a specified administrative account named SysAdmin:
ccm.sh -start all
ccm.sh -enable all -cms MACHINE01:6701 -username SysAdmin - password 35%bC5@5 -authentication LDAP
This single command logs on with a specified administrative account to disable a Job Server that is running on a second machine:
ccm.sh -disable MACHINE02.businessobjects.com.reportserver - cms MACHINE01:6701 -username SysAdmin -password 35%bC5@5 -authentication secLDAP
Authentication Option
Valid arguments Description
-cms cmsname:port# Specify the CMS that you want to log on to. If not specified, the CCM defaults to the local machine and the default port (6400). -username username Specify an account that provides
administrative rights to BusinessObjects Enterprise. If not specified, the default Administrator account is attempted. -password password Specify the corresponding password. If not
specified, a blank password is attempted.
Note: To specify the -password argument, you must also specify the - username argument.
-authentication secEnterprise, secLDAP Specify the appropriate authentication type for the administrative account. If not specified, secEnterprise is attempted.
UNIX Tools
Script utilities
8
BusinessObjects Enterprise XI Release 2 Administrator’s Reference Guide 79
ccm.config
This configuration file defines the server launch strings and other values that are used by the CCM when you run its commands. This file is maintained by the CCM itself, and by the other BusinessObjects Enterprise script utilities. You typically edit this file only when you need to modify a server’s command line. For details, see “Command lines overview” on page 62.
cmsdbsetup.sh
The cmsdbsetup.sh script is installed to the bobje directory of your installation. The script provides a text-based program that enables you to configure the CMS database, CMS clusters, and to set up the audit database. You can add a CMS to a cluster by selecting a new data source for its CMS database. You can also delete and recreate (re-initialize) a CMS database, copy data from another data source, or change the existing cluster name. Note: Before running this script, back up your current CMS database. Also be sure to see the BusinessObjects Enterprise Administrator’s Guide for additional information about CMS clusters and configuring the CMS database.
The script will prompt you for the name of your CMS. By default, the CMS name is hostname.cms. That is, the default name of a CMS installed on a machine called MACHINE01 is MACHINE01.cms. To check the name of your CMS (or any other server), view the contents of ccm.config and look for the server’s launch string. The server’s current name appears after the -name option.
For more information about configuring the CMS database or setting up the auditing database, see the BusinessObjects Enterprise Administrator’s Guide.
configpatch.sh
The configpatch.sh script is installed to the bobje/enterprise/
generic directory of your installation. Use the configpatch.sh script when installing patches that require updates to system configuration values. After installing the patch, run configpatch.sh with the appropriate .cf file name as an argument. The readme.txt file that accompanies BusinessObjects Enterprise patches tells you when to run configpatch.sh, and the name of the .cf file to use.
UNIX Tools
Script utilities
8
serverconfig.sh
The serverconfig.sh script is installed to the bobje directory of your installation. This script provides a text-based program that enables you to view server information and to add and delete servers from your installation. This script adds, deletes, modifies, and lists information from the ccm.config file. When you modify a server using serverconfig.sh, you can change the location of its temporary files. For the Central Management Server, you can change its port number or enable auditing. For the Input File Repository Server or the Output File Repository Server, you can enter the root directory.
To add/delete/modify/list UNIX servers
1. Go to the bobje directory of your installation. 2. Issue the following command:
./serverconfig.sh
The script prompts you with a list of options:
•
1 - Add a server•
2 - Delete a server•
3 - Modify a server•
4 - List all servers in the config file3. Type the number that corresponds to the action you want to perform. 4. If you are adding, deleting, or modifying a server, provide the script with
any additional information that it requests.
Tip: The script will prompt you for the name of your CMS. By default, the CMS name is hostname.cms. That is, the default name of a CMS installed on a machine called MACHINE01 is MACHINE01.cms. However, in this script you can enter hostname to check the name of your CMS (or any other server), view the contents of ccm.config, and look for the server’s launch string. The server’s current name appears after the - name option.
5. Once you have added or modified a server, use the CCM to ensure that the server is both started and enabled.
For more information about each of these topics, see the BusinessObjects Enterprise Administrator’s Guide.
UNIX Tools
Script utilities
8
BusinessObjects Enterprise XI Release 2 Administrator’s Reference Guide 81
sockssetup.sh
The sockssetup.sh script is installed to the bobje directory of your installation. The script provides a text-based program that enables you to configure the Web Component Adapter (WCA) and the Central Management Server (CMS) when they must communicate across one or more SOCKS proxy server firewalls. For technical information about BusinessObjects Enterprise and firewalls, see the BusinessObjects Enterprise Administrator’s Guide.
To modify SOCKS configuration
1. Go to the bobje directory of your installation. 2. Issue the following command:
./sockssetup.sh
3. Type wca to configure the communication between the WCA and the CMS. Or, type servers to configure SOCKS information between the remaining servers.
The script may prompt you for the name or “friendly name” of the server. By default, each server’s name is hostname.servertype. To check the name of a server, view the contents of ccm.config and look for the server’s launch string. The server’s current name appears after the -name option. The “friendly name” of the WCA by default is hostname.wca. To check the name of the WCA, look for the <display-name> of the WCA as listed in the web.xml file in the WEB-INF directory of the webcompadapter.war archive. (This archive is found in the businessobjects_root/
enterprise/JavaSDK/applications directory, where
businessobjects_root is the root directory of your BusinessObjects Enterprise installation.)
4. Specify one of the available actions:
•
Type show to display any SOCKS servers that have already been entered with this script. A blank list is displayed if no servers have been added.•
Type create to add a new SOCKS server to the list.•
Type modify to change one of the SOCKS servers in the list.•
Type delete to remove a SOCKS server from the list.•
Type moveup or movedown to modify the sequence of SOCKS servers. 5. Proceed through the script and provide any additional information that itrequests:
•
If you are creating a new entry in the list, you will typically need to provide the name or IP address of the SOCKS server, the port number it is listening on, the version number of the SOCKS server (4UNIX Tools
Script templates
8
or 5), and any authentication information that the BusinessObjects Enterprise servers will require in order to establish a connection with your SOCKS server.
•
If you choose to delete, modify, or move an existing entry, you will be asked to specify the server “by index.” Type the number that corresponds to the SOCKS server you want to modify.For details about SOCKS and the importance of the sequence of servers, see the BusinessObjects Enterprise Administrator’s Guide.
uninstallBOBJE.sh
The uninstallBOBJE.sh script is installed to the bobje directory of your installation. This script deletes all of the files installed during your original installation of BusinessObjects Enterprise by running the scripts in the bobje/uninstall directory. Do not run the scripts in the uninstall directory yourself: each of these scripts removes only the files associated with a single BusinessObjects Enterprise component, which may leave your BusinessObjects Enterprise system in an indeterminate state.
Before running this script, you must disable and stop all of the BusinessObjects Enterprise servers.
Note:
•
The uninstallBOBJE.sh script will not remove files created during the installation process, or files created by the system or by users after installation. To remove these files, after running installBOBJE.sh, perform an rm -rf command on the bobje directory.•
If you performed the “system” installation type, you will also need to delete the run control scripts from the appropriate /etc/rc# directories.Script templates
These scripts are provided primarily as templates upon which you can base your own automation scripts.