Deploying Workspaces

The following information describes the process of deploying workspaces.

To deploy the workspace file

1. Find the workspace.war file from the SAM installed folder and rename it to workspacedelivery.war.

2. Copy the workspacedelivery.war file to the applicationcontainer_internal/webapps folder. This deployment is done on the server where Siebel Tools is installed.

   Note: If SAM is not set up in this server, then copy US_export_policy.jar and local_policy.jar from the bin folder in the SAM installed folder and place it in lib/security under your Java home.

3. Change the content of Siebel_Tomcat_home\webapps\workspacedelivery\resources\properties\workspace.properties to match the workspace database connection. Choose from the following properties, based on your database type:

   Oracle Database

   jdbc.driverClassName=oracle.jdbc.driver.OracleDriver
   jdbc.url=jdbc:oracle:thin:@<server name>:<portnumber>/<instance name>
   jdbc.username=<TBLO>
   jdbc.password=<encrypted password>
   jdbc.tblo=<TBLO>

   DB2 UDB

   jdbc.driverClassName=com.ibm.db2.jcc.DB2Driver
   jdbc.url=jdbc:db2://<server name>:<portnumber>/<DB Alias>
   jdbc.username=<TBLO>
   jdbc.password=<encrypted password>
   jdbc.tblo=<TBLO>

   DB2 390

   jdbc.driverClassName=com.ibm.db2.jcc.DB2Driver
   jdbc.url=jdbc:db2://<server name>:<portnumber>/<DB Alias>
   jdbc.username=<database user>
   jdbc.password=<encrypted password>
   jdbc.tblo=<TBLO>

   Microsoft SQL Server

   jdbc.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
   jdbc.url=jdbc:sqlserver://<server name>\\<instance name>:<portnumber>;databaseName=<TBLO>
   jdbc.username=<TBLO>
   jdbc.password=<encrypted password>
   jdbc.tblo=<TBLO>
   jdbc.intBranchName=<workspace branch where you want to deliver your changes>
   jdbc.siebelUsername=<Siebel user name>
   jdbc.siebelPassword=<Encrypted Siebel password>
   jdbc.logPath=<Create a local folder for API to write log files to, like C:/workspace>
   jdbc.toolsPath=<Siebel Tools path, eg: C:/Siebel/18.0.0.0.0/18_03_Tools>
   jdbc.siebelDSN=<Siebel DSN>

   Note: Place a copy of your DB2 license jar file (db2jcc_license_cisuz.jar) to your Siebel Tomcat lib folder. Restart the Tomcat server, in case your Siebel DB is DB2 UDB or DB2 390 (z/OS).

4. This step is optional. Use this for workspacedelivery REST API to call back SAM to record success and failure actions.

   jdbc.samURL=http://<Server name>:<portnumber>/sam
   jdbc.samUsername=<A user who has a role which has ownership to do success and failure actions for example delivery@<emaildomain.com>
   jdbc.samPassword=<Encrypted SAM password>
   jdbc.samSuccessActionID=<Action Id for post successful delivery> 
   jdbc.samFailureActionID=<Action Id for post failed delivery>

   Note: To encrypt the password, use the link http://server_name:port_number/emailapprover/encrypt/password_to_encrypt

5. Restart Tomcat server and open the link http://server_name:port_number/workspacedelivery/ in any browser to see the welcome message, Welcome to Siebel Workspace Delivery Adaptor!!!

   Note: Restart Tomcat server only after finalizing the configuration or making any changes during configuration and testing.

To test the workspace delivery REST API

You can use Postman or any similar utility to test the API functionality before configuring SAM. After bringing up the Workspacedelivery application, as mentioned in step 1 through 4 (you can leave the optional section for the testing), use Postman to do a POST action on the URL http://server_name:port_number/workspacedelivery/workspace/. Provide the following raw JSON content after altering the value according to your workspace name and request id.

{
		"wsname":"test",
		"requestid":"test"
	}

This would start a Siebel Tools instance and it would try to deliver the workspace. You will get a successful delivery message or a failure message accordingly. If you find any issues, then check the workspace.properties file, make corrections, and restart Tomcat before you retest delivery.