Team Collaboration Manager offers administrators command-line utilities that can be used from within programs and scripts to create roles and initialize configuration files. The utilities are installed in the FileNet\Collaboration\Tools folder during a Collaboration Engine installation. They are installed as batch files on Windows machines and as shell scripts on UNIX and Linux machines.
This configuration utility initializes the CollaborationApplications.xml and CollaborationEnterpriseSecurityDefinitions.xml files, which are located on the Collaboration object store in the Collaboration Store folder. Initialization of these files is a required step when configuring TCM. The data initialized in these files by this utility includes mail server settings, application server settings, time zone information, and the administrator user name.
init_config [-f <filename>] [zero or more parameters]
-f <filename> // The path and filename of a text file containing one or more input parameters username=value // User name for a user with object store administrative privileges on the Content Engine password=value // Password for user name (Caution: Password is displayed in clear text) object_store=value // Name of the Collaboration object store archive_mail=value // Mail server domain for archiving email. This must be identical to the DNS name for the server entered during the Mail Server installation. (example: mymail.example.com send_mail=value // Mail server domain for sending email (example: example.com) tcm_server=value // TCM Application server and port number (the URL that used to launch the TCM application; example: www.example.com/8080) ssl_server=value // Secure TCM Application server and port number (example: secure.example.com/9090) def_timezone=value // Default time zone (such as EST, CST, PST or America/Los Angeles) admin_name=value // Full administrator name (example: Administrator@exampledom.tcm.mycompany.com)
You can run init_config by specifying all parameters on the command line, or by listing parameters in an input file and passing the path of the input file to the utility using the -f switch. You can also combine an input file reference and one or more parameters (such as password) that may be excluded from the input file. When a parameter is specified both in the input file and on the command line, the parameter value from the command line takes precedence.
init_config username=<username> password=<password> archive_mail=<archive_mail> send_mail=<send_mail> tcm_server=<tcm_server> ssl_server=<ssl_server> def_timezone=<def_timezone> admin_name=<admin_name>
username=testUser object_store=Collaboration archive_mail=test.example.com send_mail=test.com tcm_server=test.example.com:8080 ssl_server=test.example.com:9090 def_timezone=PST admin_name=Administrator@exampledom.tcm.mycompany.com
init_config -f C:\myDirectory\inputFileName.txt password=myPassword
This utility provides a way to consolidate the steps required to create a new role within a Teamspace. It uses a template to create a new role file, modifies the file with the specified new role name, and saves the new file to the default location (Collaboration Store\Security Roles). It does not modify security settings for the new role; these must be specified either when creating the XML file that serves as the template for the new role file, or after the new role file is created. For information on specifying role-based security settings, see Security and roles.
As with init_config, you can run create_role with or without an input file, or with a combination of an input file reference and command-line parameters.
Before running create_role, you must retrieve and modify a copy of an existing role configuration file:
create_role [-f <filename>] [zero or more parameters]
-f <filename> // The path and filename of a text file containing one or more input parameters username=value // User name for a user with object store administrative privileges on the Content Engine password=value // Password for user name (Caution: Password is displayed in clear text) object_store=value // Name of the Collaboration object store role_label=value // User-readable label for the new role type=value // Level of privileges for this role (administrator | member | guest) symbolic_name=value // The internal name for the new role (must conform to CE rules for symbolic names) desc=value // A description of the role role_template=value // The location (pathname and filename) of an XML file that has been created for configuration of this role
create_role username=<username> password=<password> role_label=<role_label> type=<administrator | member | guest> sym_name=<symbolic_name> desc=<description> role_template=<role_template>
username=testUser object_store=Collaboration role_label="test Role" type=member symbolic_name=testRole desc="This is a rest role" role_template=c:\myDir\roleTemplate.xml
create_role -f C:\myDirectory\inputFileName.txt password=myPassword
Messages are sent to stdout. The following error conditions are monitored for both utilities: