Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
Install and configure the Service Manager Server
Tip Install Service Manager in a development environment and then convert or push the installation to your production environment.
Install the Windows Server
To install the Service Manager Server on a Windows system, complete the following tasks.
Task 1: Install the Service Manager Server
To install the Service Manager Server, follow these steps:
- Log on to the Windows server as a user with local administrator privileges.
- Extract the server package file into the appropriate drive of the server.
- Navigate to the Installation\Server folder, and double-click setupserver-9.60.exe.
- Click Next to read and accept the licensing agreement.
- Select the I accept the terms of the License Agreement option. The Next button becomes active.
-
Click Next to accept the default installation folder: C:\Program Files (x86)\Micro Focus\Service Manager 9.60\Server, or click Choose to choose a different installation location.
Caution Do not install the server over existing versions of ServiceCenter or Service Manager. Install in a new folder. The Service Manager server folder name cannot contain parentheses or use non-ASCII characters. The server cannot start if installed in a folder with a non-compliant folder name.
Note If you have two different versions of the Service Manager Server (for example, the 9.21 server and 9.60 server) installed on the same server host, you will not be able to start both of them at the same time - your attempt to start the second server will fail with an error in the server log that indicates the program that created the shared memory is incompatible with the current program. This is because the two servers are different binaries, which cannot be attached to the same shared memory.
- Click Next to prepare the installation process. The summary information page opens.
- Click Install to copy the installation files.
- When the installation is complete, click Next.
-
Select the Run the Server Configuration Utility after installation option to open the configure server tool at the end of the installation.
Note You can skip this step and configure the Service Manager server manually by editing the RUN\sm.ini initialization file in a text editor.
-
Click Done to exit the installation wizard. The server installation is complete, and the Configuring Service Manager Server wizard opens. Follow the steps in the next section to configure the server.
Task 2: Configure the Service Manager Server
You can customize your server installation by modifying the Service Manager initialization file (sm.ini).
You can define the processes that the system starts automatically and the system’s startup parameters from the Service Manager configuration file (sm.cfg), which determines how the system starts when started from a service.
If you select the Run the Server Configuration Utility after installation option, the configuration tool starts automatically during your installation.
When you install the server for the first time, the default settings are configured for the sample database. While this tool is intended to configure new or test implementations running the out-of-box sample data, you can use it whenever you want to change the settings in your system’s sm.ini file. Refer to the Service Manager Help for a complete list of the parameters stored in the sm.ini file.
Caution The configuration utility overwrites your current sm.ini settings. You should back-up your system’s sm.ini file prior to running the configuration utility to prevent any accidental data loss or loss of service.
To configure the Service Manager server, follow these steps:
- Run the Server Configuration Utility, configure.bat, located in the <Service Manager installation path>\Server directory.
- Specify the listener ports:
- HTTP Port (system): The communications port on which you want Service Manager to listen to client connection requests. The default port is 13080.
Note For a new server installation, the configuration wizard does not display the Enable HTTPS Port and HTTPS Port options, because SSL is not enabled by default (the sm.ini file contains the sslconnector:0 parameter). If you have already set sslconnector:1 in the sm.ini file and then rerun the configuration utility, the configuration wizard displays two HTTPS options so that you can reconfigure the HTTPS settings:
- Enable HTTPS Port: Select this option to enable an HTTPS port.
- HTTPS Port: The communication port on which you want Service Manager to listen to secure client connection requests.
- Specify the database type and connection information:
- Database Type: The database that you want to use to store your data.
SQL Database Name:
For Microsoft SQL Server, this is the ODBC DSN name. Note that Microsoft SQL Server is supported for a Windows platform only.
For Oracle Database, this is the Network Service Name in tnsnames.ora.
- SQL User: The user that Service Manager should connect to your database with.
- SQL Password: The password for the user that Service Manager should use to connect to your database.
Use Unicode Data Type: Use this option if you need to support multiple languages that are not supported by one collation. Otherwise, use the right collation and do not select this option. For information about how to select SQL Server collations, refer to the SQL Server documentation.
Caution Be aware that this operation is not reversible.
- Click Verify Connection to confirm that Service Manager can connect to the database.
Upload the SM demonstration data, if desired. All new Service Manager installations require this. Uploading the demonstration data also uploads the out-of-box 9.60 applications. If you are upgrading only the Service Manager client and server, you do not have to upload the data. The new client and server can connect to your old system.
Note Before your system goes live, you need to purge the out-of-box demonstration data by running the PurgeOutofBoxData unload script. For details, see knowledge article KM718390.
Caution Do NOT upload the data into an existing production system. Instead, you need to perform an applications upgrade. For more information, see Service Manager Applications Upgrade .
Note If you selected the Unicode data type for SQL Server, the applications and demonstration data are uploaded as Unicode. Additionally, to indicate that your SQL Server database uses Unicode, the read-only Use Unicode Data Type flag is turned on in the sqlserver record of the sqldbinfo table.
- Specify the listener ports:
-
In a text editor, open the sm.ini file and add the following parameters:
- jsaccessfilereadregex
- jsaccessfilewriteregex
- jsaccesscmdregex
Important These parameters specify access restrictions from JavaScript code for file access and command execution. Configuration of these parameters is required so that users with Process Designer tailoring rights are not able to use the available Service Manager JavaScript APIs to directly access the underlying host file system and command line.
For more information about how to configure these parameters, see Startup parameters: JavaScript access.
Install the Linux Server
Note The following convention identifies variables that may change depending on
your particular installation: <variable>. When you see a variable in brackets during the installation,
replace the variable with information specific to
your system. Do not type the brackets (< >) as part of the command.
To install the Service Manager Server on a Linux system, complete the following tasks.
Task 1: Install the Service Manager Server
To install the Service Manager Server, follow these steps:
- Log on to the Linux server as a user with local administrator privileges.
- Extract the server package file into the appropriate drive of the server.
- Navigate to Installation/Server directory.
-
Run the setupLinuxX64-9.60.bin script.
Note The setup scripts assume you will run them from an X-Windows environment. If you prefer to run the scripts from a console instead, add “-i console” to the command line. For example,
setupLinuxX64-9.60.bin –i console. - Accept the license agreement.
-
At the installation script prompt, type the absolute installation directory where you want to install Service Manager, or accept the default one. Follow these rules:
-
Do not install the server over an existing version of ServiceCenter or Service Manager. Install in a new folder.
Note If you have two different versions of the Service Manager Server (for example, the 9.21 server and 9.60 server) installed on the same server host, you will not be able to start both of them at the same time - your attempt to start the second server will fail with an error in the server log that indicates the program that created the shared memory is incompatible with the current program. This is because the two server versions are different binaries, which cannot be attached to the same shared memory.
-
The installer will ask you to confirm if the specified installation directory is correct. If you specify an invalid directory, the installer behaves unexpectedly.
- Do not use the "~" symbol when entering the path. InstallShield treats this as a regular character, and will create a directory with the name '~'.
The system takes several minutes to uncompress the files and complete the server installation.
-
- Click Finish to exit the wizard.
-
If you want to use an OpenJDK JRE, make sure your Linux host has Internet access and then run one of the following commands as a superuser (such as root) in the Server installation directory:
- For Red Hat Linux or Oracle Linux: run the "
installOpenJDK.sh -i4sm" command. - For SUSE Linux: run the "
installOpenJDKSUSE.sh -i4sm" command.
If you want to use an Oracle JRE, do the following:
- Update the JAVA_HOME environment variable to make it point to the Oracle jre.
- From the Server's RUN directory, run the "setupLinks.sh jre" command as the owner of the Service Manager installation directory. This will create a symbolic link for the Oracle jre.
For more information, see the JRE support section in Deployment architecture.
- For Red Hat Linux or Oracle Linux: run the "
-
To automatically configure the server, run the configure script in your <Service Manager Server installation path> directory to update the sm.ini file.
Note You can also configure the Service Manager server by editing the sm.ini configuration file. Follow the instructions in the next task if you want to configure the server manually.
Task 2: Configure the Service Manager Server
You can customize your server installation by modifying the Service Manager initialization file (sm.ini).
You can define the processes the system starts automatically and the system’s startup parameters from the Service Manager configuration file (sm.cfg), which determines how the system starts when started from the smstart script.
When you install the server for the first time, the default settings are configured for the sample database. While this tool is intended to configure new or test implementations running the out-of-box sample data, you can use it whenever you want to change the settings in your system’s sm.ini file. Refer to the Service Manager Help for a complete list of the parameters stored in the sm.ini file.
Caution The configuration utility overwrites your current sm.ini settings. You should back-up your system’s sm.ini file prior to running the configuration utility to prevent any accidental data loss or loss of service.
To configure the Service Manager server, follow these steps:
-
From a console, run the server configuration script, configure, located in the <Service Manager installation path>/Server directory:
configure -consolemode
- Specify the listener ports:
- HTTP Port (system): The communications port on which you want Service Manager to listen to client connection requests. The default port is 13080.
- Enable HTTPS Port: Select this option to enable an HTTPS port.
- HTTPS Port: The communication port on which you want Service Manager to listen to secure client connection requests.
Note For a new server installation, the configuration wizard does not display the Enable HTTPS Port and HTTPS Port options, because SSL is not enabled by default (the sm.ini file contains the sslconnector:0 parameter). If you have already set sslconnector:1 in the sm.ini file and then rerun the configuration utility, the configuration wizard displays these two HTTPS options so that you can reconfigure the HTTPS settings.
- Specify the database type and connection information:
- Database Type: The database that you want to use to store your data.
SQL Database Name:
For Oracle Database, this is the Network Service Name in tnsnames.ora.
- SQL User: The user that Service Manager should connect to your database with.
- SQL Password: The password for the user that Service Manager should use to connect to your database.
-
Verify the connection to confirm that Service Manager can connect to the database by running the command sm -sqlverifyconnection in the Service Manager RUN directory.
-
Upload the SM demonstration data, if desired. All new Service Manager installations require this. Uploading the demonstration data also uploads the out-of-box 9.60 applications. If you are upgrading only the Service Manager client and server, you do not have to upload the data. The new client and server can connect to your old system.
Note Before your system goes live, you need to purge the out-of-box demonstration data by running the PurgeOutofBoxData unload script. For details, see knowledge article KM718390.
Caution Do NOT upload the data into an existing production system. Instead, you need to perform an applications upgrade.
- Specify the listener ports:
-
In a text editor, open the sm.ini file and add the following parameters:
- jsaccessfilereadregex
- jsaccessfilewriteregex
- jsaccesscmdregex
Important These parameters specify access restrictions from JavaScript code for file access and command execution. Configuration of these parameters is required so that users with Process Designer tailoring rights are not able to use the available Service Manager JavaScript APIs to directly access the underlying host file system and command line.
For more information about how to configure these parameters, see Startup parameters: JavaScript access.
Tip Next, go to Start the Service Manager Server if this is a new installation.
