Edit configuration filesYou can edit configuration files in two ways: by editing configuration settings in the wsadmin client, or by editing the configuration XML files directly. In both cases, first check out the configuration files and later check them back in using the wsadmin client.
- Start the wsadmin client by completing the following steps:
- From the dmgr host, go to...:
where <app_server_root> is the WAS installation directory and <dm_profile_root> is the dmgr profile directory, typically dmgr01. For example, on Windows:
Attention: You must run the following command to start the wsadmin client from this specific directory because the Jython files for the product are stored here. If you try to start the client from a different directory, then the execfile() command that you subsequently call to initialize the administration environment for an IBM Connections component does not work correctly.
- Enter the following command to start the wsadmin client:
- AIX or Linux:./wsadmin.sh -lang jython -user <admin_user_id> -password <admin_password> -port <SOAP_CONNECTOR_ADDRESS Port>
- Microsoft Windows:wsadmin -lang jython -user <admin_user_id> -password <admin_password> -port <SOAP_CONNECTOR_ADDRESS Port>
- <admin_user_id> is the user name of a person in the Administrator role on the IBM WAS.
- <admin_password> is the password of the WAS administrator.
- <SOAP_CONNECTOR_ADDRESS Port> is the SOAP port for the WAS. The default value of the SOAP port is 8879. If you are using the default port value, you do not need to specify this parameter. If you are not using the default and you do not know the port number, you can look up its value in the WAS Integrated Solution Console. To look up the SOAP port number, perform the following steps:
- Open the WAS Integrated Solution Console for the deployment manager, and then select System Administration -> dmgr.
- In the Additional properties section expand Ports, and then look for the SOAP_CONNECTOR_ADDRESS port entry to find the port number.
- AIX or Linux:./wsadmin.sh -lang jython -username primaryAdmin -password p@assword -port 8879
- Microsoft Windows:wsadmin -lang jython -username primaryAdmin -password p@assword -port 8879
- Access the application configuration files:
where <application_py_file> is one of the following:
- IBM Connections-wide: connectionsConfig.py
- Activities: activitiesAdmin.py
- Blogs: blogsAdmin.py
- Bookmarks: dogearAdmin.py
- Communities: communitiesAdmin.py
- Files: filesAdmin.py
- Forums: forumsAdmin.py
- Home Page: homepageAdmin.py
- News: newsAdmin.py
- Profiles: profilesAdmin.py
- Search: searchAdmin.py
- Wikis: wikisAdmin.py
If prompted to specify a service to connect to, type 1 to pick the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a local file path, pick the node where the file is stored. This information is not used by the wsadmin client when you are making configuration changes.
- Check out the configuration file for the application using the following command:
- <service_name> is one of the following:
- IBM Connections-wide: LCConfigService
- Activities: ActivitiesConfigService
- Blogs: The configuration settings for the Blogs application are not made in a configuration file, so no files need to be checked out, updated, and checked back in for Blogs. Unlike the other applications, when you edit Blogs configuration properties, the changes are written directly to the Blogs database tables.
- Bookmarks: DogearCellConfig
- Communities: CommunitiesConfigService
- Files: FilesConfigService
- Forums: ForumsConfigService
- Home Page: HomepageCellConfig
- News: NewsCellConfig
- Profiles: ProfilesConfigService
- Search: SearchCellConfig
- Wikis: WikisConfigService
- <working_directory> is the temporary working directory to which the configuration XML and XSD files are copied by the checkOutConfig command. The XML file contains the configuration settings and the corresponding XSD files is used to validate the XML file. The files are kept in this working directory while you make changes to them using the updateConfig command. When you run the checkInConfig command, the updated configuration file is copied from the temporary directory to where these files are located and overwrites the existing XML file. When you specify a path to the working directory on a system running Microsoft Windows, use a forward slash for the directory. For example: "C:/temp".
Note: AIX and Linux only: The directory must grant write permissions or the command will not run successfully.
- <cell_name> is the name of the WAS cell hosting the IBM Connections application. This argument is case-sensitive, so type it with care. To obtain the cell name:print AdminControl.getCell()
Note: This input parameter is case-dependent.
- Common IBM Connections properties:LCConfigService.checkOutConfig("C:/temp","foo01Cell01")
- Home Page:HomepageCellConfig.checkOutConfig("/temp","foo01Cell01")
- News repository:NewsCellConfig.checkOutConfig("/temp","foo01Cell01")
- Optional: If you want to see what the current values of the configuration properties are, use the following command to retrieve a list of them:
where <service_name> is one of the service names defined in step 4.
- Edit the values of the configuration properties that you want to change. Some properties must be edited using the wsadmin client; others can only be edited by editing the configuration XML file directly.
See the documentation for the individual application sections to see a list of the configuration properties you can edit for that application.
- Update the value of the version stamp configuration property to force users' browsers to pick up this change. See Required post-customization step for more details.
- After making edits, check the configuration files back in using the following command:
where <service_name> is one of the service names defined in step 4. You do not need to perform this step for the Blogs application.
Note: You must run the checkin during the same wsadmin session in which you ran the checkout command.
- After making updates, type the following command to deploy the changes:
- To exit the wsadmin client, type exit at the prompt.
- Stop and restart the servers hosting the edited IBM Connections applications.
Note: If you changed any Blogs configuration settings, the changes were written directly into the Blogs database tables. Therefore, you do not need to stop and restart the server hosting the Blogs application for the changes to take effect.
IBM Connections configuration property values
Find out what configuration properties you can edit for each application.
IBM Connections configuration files
Configuration files are XML-formatted files that store configuration information for IBM Connections.
Parent topicAdminister applications
Export LTPA keys
Importing LTPA keys
Starting the wsadmin client
Turning off active content filtering
Use the Profiles database as the user directory
Required post-customization step