1. Marketing Installation and Administration Guide

This procedure is used for a new Web Survey Daemon (WSD) installation.

To prepare the WSD database:

  • Prepare an empty database or schema before running a WSD database creation script.

  • Do not run a creation script against an existing WSD schema or a schema that contains objects from an incomplete installation.

  • The database creation script creates two WSD accounts.

  • Select a distinct password for each account that complies with your organization's password policy.

    Credential Purpose Value used during database preparation
    Database owner Connects the database client and creates the WSD schema objects Database password
    WSD system Signs in to the WSD administration application Encrypted WSD password
    WSD SiebelSystem Authenticates WSD communication with Siebel Marketing Encrypted WSD password

  • Retain the clear passwords in an approved credential store. You need the clear system password to sign in to WSD and the clear SiebelSystem password when you configure the Web Survey outbound Web service.

    Note: Do not enter an encrypted value in a WSD or Siebel application password field.

Generate the Encrypted WSD Passwords

The WSD database creation scripts require values generated by OccamCrypto. Run the following command separately for the selected system and SiebelSystem passwords:
java -cp "<WSD_WEBAPP_ROOT>/WEB-INF/lib/occam-crypto.jar" com.siebel.occam.security.OccamCrypto 
encrypt <password>

Replace <WSD_WEBAPP_ROOT> with the installed WSD Web application directory and <password> with the applicable clear password. Copy only the encrypted value printed by the command. Keep the two outputs identified by account so that each value is entered at the correct database-script prompt.

The command receives the clear password as a command-line argument. Run it from an approved administrative session and protect command history, process information, terminal output, and copied values according to your organization's credential-handling requirements. Treat the encrypted output as a credential.

Database Requirements

The following table describes the database requirements:

Database Requirements
Oracle Database An empty WSD schema, its schema-owner credentials, and SQL*Plus
Microsoft SQL Server An empty WSD database, a table-owner SQL login with the required object-creation privileges, Windows PowerShell 5.1 or later, Microsoft ODBC Driver 18 for SQL Server, and sqlcmd on PATH
IBM Db2 An empty WSD schema, an authorized database user, the COMM_SPACE table space, and IBM CLPPlus in interactive mode; do not use classic Db2 CLP

Prepare an Oracle Database

To prepare an Oracle Database for WSD:

  1. Create an empty WSD schema and grant its owner the privileges required to create the WSD schema objects.

  2. Start SQL*Plus as the WSD schema owner. Omit the password from the command line:
    sqlplus -L <WSD_SCHEMA_USER>@<CONNECT_IDENTIFIER>
Enter password: <database_owner_password>

  3. At the SQL*Plus prompt, run the installed database creation script:

  4. At each protected prompt, paste only the encrypted value generated for the named account, and then press Enter. The value is not displayed.

  5. Confirm that the database creation script executed successfully and review the session for errors before exiting.

Prepare a Microsoft SQL Server Database

You need to use the Windows PowerShell launcher script to run communicatorSqlServer.sql.

To prepare a SQL Server database for WSD:

  1. Create an empty WSD database. Prepare a table-owner SQL login with the required object-creation privileges and set its default schema to the schema in which the WSD objects will be created.

  2. Open Windows PowerShell 5.1 or later and change to the installed WSD SQL directory:
    Set-Location "<WSD_HOME>\sql"
  3. Run the launcher with the SQL Server endpoint, empty database, table-owner login, and expected table-owner schema:
    .\runCommunicatorSqlServer.ps1 `
-Server "tcp:<SQL_SERVER>,<PORT>" `
-Database "<WSD_DATABASE>" `
-TableOwnerUser "<TABLE_OWNER_LOGIN>" `
-TableOwner "<TABLE_OWNER_SCHEMA>"

  4. At the hidden prompts, enter the table-owner database password and the two encrypted WSD values in the following order:

    • encrypted password for system;

    • encrypted password for SiebelSystem.

  5. Confirm that the launcher reports WSD SQL Server bootstrap completed successfully. and returns exit code 0.

The launcher verifies the selected database and the table-owner's default schema and stops if it finds an existing WSD table. Certificate validation is enabled by default. If the server certificate has been reviewed but its issuing authority is not trusted by the Windows host, add -TrustServerCertificate. This option accepts the server certificate without validating its certificate chain and must be used only in accordance with your organization's security policy.

Prepare an IBM Db2 Database

The Db2 database creation script uses CLPPlus protected prompts and substitution variables. Run it with IBM CLPPlus in interactive mode, not with classic Db2 CLP.

To prepare a Db2 database for WSD:

  1. Create an empty WSD schema and confirm that the target database contains a usable COMM_SPACE table space.

  2. Start CLPPlus as the authorized database user:
    clpplus <DB_USER>@<DB_HOST>:<PORT>/<DATABASE>
Enter password: <database_owner_password>

  3. Confirm that the connected user, database, and current schema are the intended WSD targets.

  4. At the CLPPlus prompt, run the installed database creation script:
    SQL> @<WSD_HOME>/sql/communicatorDB2.DDL
Enter encrypted password for WSD system:
Enter encrypted password for WSD SiebelSystem:

  5. Confirm that the query returns one row for system in organization 1 and one row for SiebelSystem in organization 2.

    Do not select or record the PASSWORD column.

  6. After WSD starts, sign in as system with its selected clear password. Use the selected clear SiebelSystem password when configuring the Web Survey outbound Web service.

Verify the Database Preparation

To verify the database preparation, after the database creation script completes:

  1. Review the complete client output and confirm that it contains no database errors.

  2. While connected as an authorized database user, run the following query:
    SELECT LOGIN, ORG_ID
FROM COMMON_USER
WHERE (LOGIN = 'system' AND ORG_ID = 1)
OR (LOGIN = 'SiebelSystem' AND ORG_ID = 2);

  3. Confirm that the query returns one row for system in organization 1 and one row for SiebelSystem in organization 2. Do not select or record the PASSWORD column.

  4. After the WSD starts, sign in as system with its selected clear password.

    Use the selected clear SiebelSystem password when configuring the Web Survey outbound Web service.

Troubleshoot WSD Database Preparation

To troubleshoot WSD database preparation:

Symptom Resolution
Java reports that OccamCrypto cannot be found or loaded Confirm that Java is available and that <WSD_WEBAPP_ROOT>/WEB-INF/lib/occam-crypto.jar exists. Retain any additional class-path entries required by the installed WSD delivery.
A required database client is not found Install and configure SQL*Plus for Oracle Database, sqlcmd and Microsoft ODBC Driver 18 for SQL Server, or IBM CLPPlus for Db2. Confirm that the required executable is available on PATH.
An encrypted-password prompt rejects the value Generate the value again for the intended account. Supply a single-line value of no more than 100 characters. Do not enter a blank value, CHANGE_ME, or a value containing internal whitespace. Leading and trailing whitespace from copying and pasting is removed.
Nothing appears when a password is typed or pasted The database scripts and SQL Server launcher use hidden prompts. The absence of displayed characters is expected. Enter or paste the value once and press Enter.
The database client cannot connect Verify the host, port, database or service name, database-owner login, password, and network access. Confirm that the connected owner and current schema are the intended WSD targets.
SQL Server reports a database or table-owner schema mismatch Verify Database, TableOwnerUser, and TableOwner. The table-owner login's default schema must match TableOwner.
SQL Server reports that the certificate chain is not trusted Configure the Windows host to trust the issuing authority. Use -TrustServerCertificate only after the certificate has been reviewed and organizational policy permits bypassing certificate-chain validation.
Db2 reports an error involving ACCEPT, HIDE, or an & variable Confirm that the script is running in interactive IBM CLPPlus. Classic Db2 CLP does not support the required prompt and substitution behavior.
Db2 reports that COMM_SPACE is undefined or unavailable Have the Db2 administrator create or make available the required COMM_SPACE table space, and then retry against an empty schema.
The script reports that an object already exists Stop the procedure. Verify that the selected schema is intended for a new WSD installation. Do not run the script over existing WSD objects.
A database error occurs after table creation begins The schema can be partially created. Use your approved database cleanup or restore procedure to return to an empty schema before retrying. Do not rerun the creation script over partial objects.