To run the IdcCommand utility, specify the following parameters on the command line or in the DomainHome/ucm/cs/bin/intradoc.cfg configuration file.

The Launcher uses Bourne Shell-like quotation rules. A string can be inside double quotation marks (") to escape spaces. A backslash (\) can precede any character to provide that character. After a final command line is computed, the Launcher separates it into spaces without quotation marks. Each string is then used without quotation marks as an entry in the argv array for the command.

After reading the configuration files, the Launcher processes variable substitutions. Some variables can have extra computations to validate directories or files, build command-line argument lists, or construct PATH-like variables.

These special computations are performed for variables based on their type. To set a type for a variable, set TYPE_variable_name=typename in any of the configuration files listed previously.

The following list describes Launcher variable types:

• file

  file Launcher Variables
  TYPE_PASSWD_FILE=file
  PASSWD_FILE_sys5=/etc/passwd
  PASSWD_FILE_bsd=/etc/master.passwd

  This type looks for a file. If the value of variable_name is a path to an existing file, it is kept. If not, every variable beginning with variable_name_ is checked. The last value, which is a path to an existing file, is used for the new value of variable_name.

  In this example PASSWD_FILE is set to /etc/master if /etc/master.passwd exists, or it is set to /etc/passwd</span> if /etc/passwd exists. Otherwise, PASSWD_FILE is undefined.

• directory

  directory Launcher Variables
  TYPE_JDK=directory
  JDK_java_home=$JAVA_HOME
  IdcNativeDir=$IdcHomeDir/native
  DEFAULT_JDK_DIR=$OS_DIR/$PLATFORM
  JDK_legacy142=$DEFAULT_JDK_DIR/j2sdk1.4.2_04
  JDK_default=$DEFAULT_JDK_DIR/jdk1.5.0_07
  

  In this example, JDK is set to the same value as the last of the JDK_ variables that is a directory. Typically, this would point at the JDK installed with Oracle Fusion Middleware. Note that JDK_java_home references $JAVA_HOME; if a variable is not defined in any configuration file but is in the environment, the environment value is used.

• executable

  executable Launcher Variables
  TYPE_JAVA_EXE=executable
  JAVA_EXE_default=java$EXE_SUFFIX
  JAVA_EXE_jdk_default=$JDK/bin/java$EXE_SUFFIX

  The executable type looks for an executable. It works very much like the file type, but looks through every directory in $PATH for each candidate value. In this example JAVA_EXE is set to the Java executable in the JDK if it exists. Otherwise it is set to the first Java executable in the PATH.

• list

  list Launcher Variables
  TYPE_JAVA_OPTIONS=list
  JAVA_MAX_HEAP_SIZE=384
  DEFINE_PREFIX=-D
  JAVA_OPTIONS_BIN_DIR=${DEFINE_PREFIX}idc.bin.dir=$BIN_DIR
  JAVA_OPTIONS_maxheap=${JAVA_MAX_HEAP_SIZE+-Xmx${JAVA_MAX_HEAP_SIZE\}m}
  JAVA_OPTIONS_service=${IS_SERVICE+$JAVA_SERVICE_EXTRA_OPTIONS}

  The list type computes a list of options for an executable. Each value that begins with variable_name_ becomes a quoted option, and variable_name is set to the entire list. In this example, JAVA_OPTIONS is set to the string:

  "-Didc.bin.dir=/intradocdir/bin/" "-Xmx384m"
  

• path

  path Launcher Variables
  IdcResourcesDir=${IdcResourcesDir-$IdcHomeDir/resources}
  BASE_JAVA_CLASSPATH_source=$IdcResourcesDir/classes
  BASE_JAVA_CLASSPATH_serverlegacy=$SharedDir/classes/server.zip
  BASE_JAVA_CLASSPATH_server=$JLIB_DIR/idcserver.jar

  TYPE_JAVA_CLASSPATH=path

  JAVA_CLASSPATH_legacy=$CLASSPATH

  JAVA_CLASSPATH_orig=$IntradocDir/classes

  JAVA_CLASSPATH_unpackaged=$SharedDir/classes

  JAVA_CLASSPATH_components=$COMPONENTS_CLASSPATH

  JAVA_CLASSPATH_server=$SharedDir/classes/server.zip

  JAVA_CLASSPATH_refinery=$SharedDir/classes/idcrefinery.zip

  JAVA_CLASSPATH_flexion=$SharedDir/classes/flexionxml.jar

  JAVA_CLASSPATH_ldap=$SharedDir/classes/ldapjdk.jar

  The path type computes a path-like value.The value of each variable starting with variable_name_ is appended to the value of variable_name separated by the value of PATH_SEPARATOR. In this example, BASE_JAVA_CLASSPATH is set to a very long class path.

• lookupstring

  lookupstring Launcher Variables
  TYPE_VDK_PLATFORM=lookupstring
  PARAMETER_VDK_PLATFORM=${PLATFORM}_${UseVdkLegacySearch+vdk27}
  VDK_PLATFORM_aix_vdk27=_rs6k41
  VDK_PLATFORM_aix_=_rs6k43
  VDK_PLATFORM_hpux_vdk27=_hpux11
  VDK_PLATFORM_hpux_=_hpux11
  VDK_PLATFORM_freebsd_vdk27=_ilnx21
  VDK_PLATFORM_freebsd_=_ilnx21
  VDK_PLATFORM_linux_vdk27=_ilnx21
  VDK_PLATFORM_linux_=_ilnx21
  VDK_PLATFORM_solaris_vdk27=_ssol26
  VDK_PLATFORM_solaris_=_ssol26
  VDK_PLATFORM_win32_vdk27=_nti40
  VDK_PLATFORM_win32_=_nti40

  The lookupstring type uses a second parameter to construct a lookup key for the final value. The second parameter is the value of $PARAMETER_variable_name. If this value is undefined, the current value of variable_name is used as the lookup key. In this example, PARAMETER_VDK_PLATFORM has the value of ${PLATFORM}_ or ${PLATFORM}_vdk27 depending on the value of UseVdkLegacySearch.

  This value is then used to look up the value of the variable VDK_PLATFORM_${PARAMETER_VDK_PLATFORM} which is then enclosed in quotation marks and assigned to VDK_PLATFORM.

• lookuplist

  lookuplist Launcher Variables
  TYPE_STARTUP_CLASS=lookuplist
  STARTUP_CLASS_version=Installer --version
  STARTUP_CLASS_installer=Installer
  STARTUP_CLASS_WebLayoutEditor=IntradocApp WebLayout
  STARTUP_CLASS_UserAdmin=IntradocApp UserAdmin
  STARTUP_CLASS_RepositoryManager=IntradocApp RepositoryManager
  STARTUP_CLASS_Archiver=IntradocApp Archiver
  STARTUP_CLASS_WorkflowAdmin=IntradocApp Workflow
  STARTUP_CLASS_ConfigurationManager=IntradocApp ConfigMan

  The lookuplist type uses a second parameter to construct a lookup key for the final value. The second parameter is the value of $PARAMETER_variable_name. If this value is undefined, the current value of variable_name is used as the lookup key.

  Unlike lookupstring, lookuplist does not enclose the final value in quotation marks. For this example, the current value of STARTUP_CLASS is version. STARTUP_CLASS is replaced with the value Installer --version.

After processing the computed settings, the Launcher iterates over all variables that begin with the string EXPORT_. The value of each variable is used as an environment variable name, which has the value of the second half of the EXPORT_ variable assigned. For example, EXPORT_IDC_LIBRARY_PATH=LD_LIBRARY_PATH exports the value of the IDC_LIBRARY_PATH variable with the name LD_LIBRARY_PATH.

The variable JAVA_COMMAND_LINE is used to get the command line. Any command line arguments to the Launcher that have not been consumed are appended to the command line. On UNIX systems, the command line is parsed and quoting is undone and then execv is called. On Windows, a shutdown mutex is created and CreateProcess is called with the command line. Care should be taken because CreateProcess does not undo backslash-quoting.

The principal mechanism for debugging the Launcher is to add the flag -debug before any arguments for the final command. You can also create a file named $BIN_DIR/debug.log which triggers debug mode and contain the debug output.

The Launcher has knowledge of the following configuration entries, which it either sets or uses to control its behavior. Note that these configuration variables might change or be removed in future releases of Content Server:

• IDC_SERVICE_NAME: the name of the win32 service used for service registration, unregistration, startup, and shutdown.

• IDC_SERVICE_DISPLAY_NAME: the display name of the win32 used for service registration.

• IntradocDir: the base directory for relative path names.

• IdcBaseDir: an alternate name for IntradocDir.

• IdcResourcesDir: set to $IdcHomeDir/resources if otherwise undefined.

• IdcNativeDir: defaults to $IdcHomeDir/native if otherwise unset.

• PATH_SEPARATOR: set to either colon (:) or semi-colon (;) if otherwise unset.

• STARTUP_CLASS: set to the name of the Launcher executable.

• MUTEX_NAME: the name used to create a shutdown mutex on win32.

• BEFORE_WIN_SERVICE_START_CMD: if set, is a command line that is executed before a win32 service starts.

• UseRedirectedOutput: if set tells the Launcher on win32 to redirect the output from the Java VM to a file.

• ServiceStartupTimeout: the time out used for waiting for a Java process to successfully start on win32.

  Note:

  By using Launcher.exe, changing the status.dat file, and altering the value of the JVM command line, you could theoretically run any Java program as a Windows service. This is not recommended for normal use, but it does explain some ways you could configure the Launcher.

To use the Launcher, you must first rename the Launcher.exe file to an executable with the same name as the class file to be launched. Typical examples include IdcServer.exe and IntradocApp.exe.

You can modify the configuration file for the applications you need to run. The following example shows configuration file entries that are sufficient to launch nearly all Content Server applications.

Configuration File Entries for Content Server Applications
<?cfg jcharset="Cp1252"?>
#Content Server Directory Variables
IntradocDir=C:/domain/idcm1/

CLASSPATH=$COMPUTEDCLASSPATH;$SHAREDDIR/classes/jtds.jar

BASE_JAVA_CLASSPATH_source=$IdcResourcesDir/classes
BASE_JAVA_CLASSPATH_serverlegacy=$SharedDir/classes/server.zip
BASE_JAVA_CLASSPATH_server=$JLIB_DIR/idcserver.jar

Other applications, such as Oracle WebCenter Content: Inbound Refinery, require additional classes in the class path. This file can also be modified to enable Content Server to be run with different Java Virtual Machines.

The CLASSPATH is designed to look for class files in order of the listed entries. In other words, the Launcher will search the entire DomainHome/ucm/idc/native directory before it looks in the resources directory or server.zip file. This is desirable if the users want to overload Java classes without patching the ZIP file.

Additionally, the Launcher can be used to install, uninstall, and run Java applications as Windows services, if they follow the correct API for communicating back to the Launcher. For more details on how to make any Java application run as a Windows service with the Launcher, see the source code for IdcServer.java or IdcAdmin.java.

The COMPUTEDCLASSPATH is used to add class files to the CLASSPATH that the Launcher uses. To add class files, override this flag.

The following example shows a command to run Content Server with the IBM virtual machine on a Windows operating system.

Command for Running Content Server with a Custom JVM
#customized for running the IBM VM
JAVA_EXE=full path

When using a custom JVM, specify the full path to the Java executable file to be used.

JvmCommandLine=$JAVA_EXE $JAVA_OPTIONS $JAVA_SERVICE_EXTRA_OPTIONS $DEFINE_PREFIXjava.endorsed.dirs=$ENDORSEDPATH $APPEND_CLASSPATH "$CLASSPATH" $STARTUPCLASS

You can set JAVA_COMMAND_LINE_SELECTION entry in the configuration file to idcclassloader or traditional.

If you choose to change which JVM you are using, and if that VM has all the standard Sun SDK JAR files, then it is better to use the J2SDK configuration entry to relocate the root directory of the SDK directory rather than use JAVA_EXE to specify the location of the Java executable. (This is not applicable for the IBM VM.)

The J2SDK variable changes the directory where the Sun SDK libraries are found (such as tools.jar). If you change this entry without setting the JAVA_EXE entry, then Java executables are assumed to be in the bin directory of the path in J2SDK. The default value for J2SDK is ...\shared\os\win32\j2sdk1.4.2_04.

To add a value to JAVA_OPTIONS, use JAVA_OPTIONS_server=-server or another similar value.

The following table describes commonly used command-line options. Those options noted with an asterisk (*) are available on a Windows operating system only. Unmarked options are available for a Windows or UNIX operating system.

IDC_LIBRARY_PATH_customfiles=/path-to-customfiles

PATH=$SHAREDDIR\\os\\win32\\lib\\;$SHAREDDIR\\search\\vdk\\_nti40\\bin;$SHAREDDIR\\search\\vdk\\_nti40\\filters;$OLDPATH

If you want to load custom .dll files, you should put them in the IdcHomeDir/native/win32/lib directory.