1. Database Upgrade Guide
  2. Executing the Upgrade

Executing the Upgrade

Prepare the Payload

The following table provides the Supported Siebel Version List.

Corresponding Siebel Version AcceptedSiebel Input Version (current_ siebel_version)
7.8.2 v7.8.2sia
8 v8.0sia
8.1.1.10 v8.1.1.10sia
13 v8.1.1.11sia
14 v8.1.1.14sia
8.2.2 v8.2.2sia
8.2.3 v8.2.2.3sia
13 v8.2.2.4sia
14 v8.2.2.14sia
15 v15.0
15.5 v15.5
16 v16.0

The following table provides the list of Siebel component groups.

Component groups Names
adm Application Deployment Manager
asgnmgmt Assignment Management
commmgmt Communications Management
contctr Content Center
dataqual Data Quality
mobilesync Disconnected Mobile Synchronization
mobilesyncsis Disconnected Mobile Synchronization SIA
dandb Dun and Bradstreet
eai Enterprise Application Integration
fieldsvc Field Service
fcstsvc Forecast Service Management
sync Handheld Synchronization
syncsis Handheld Synchronization SIA
icomp Incentive Compensation
mktgom Marketing Object Manager
mktgsrv Marketing Server
rtsremote MWC Real Time Sync
pimsi PIM Server Integration Management
creditasgn Sales Credit Assignment
saleshiersvc Sales Hierarchy Service
search Search Processing
siebanywhere Siebel Anywhere
callcenter Siebel Call Center
communications Siebel CME
cra Siebel Core Reference Application
eautomotive Siebel eAutomotive
echannel Siebel eChannel
econsumer Siebel eConsumerSector
edocuments Siebel eDocuments
hospitality Siebel eHospitality
erm Siebel Employee Relationship Management
fins Siebel Financial Services
htim Siebel High Tech Industrial Manufacturing
sisme Siebel Industry Marketing
iss Siebel ISS
lifesciences Siebel Life Sciences
loyalty Siebel Loyalty
loyaltyengine Siebel Loyalty Engine
publicsector Siebel Public Sector
remote Siebel Remote
rti Siebel RTI
sales Siebel Sales
ucm Siebel Universal Customer Master
siebel Web Tools Siebel Web Tools
taskui Task UI
workflow Workflow Management
xmlpreport XMLP Report

The following table provides the Input Payload details.

Parameter Value Mandatory Purpose Description
requester_email Yes Email Id of the requester Array of user email ID
current_siebel_version Yes Siebel version of the Customer Repository Accepted Siebel version
component_groups No Component groups to be enabled on the upgrade application Comma separated values
base_language Yes

Mandatory parameter. Base language of the Customer Siebel Application

Supported languages : 22 languages

 Single language entry (Example: enu)
other_languages No Currently not supported This is a required entry and should be left blank until notified on the support

execution_type

 Yes Indicates the process which is to be run

Values expected is one of the below

Assess, Dev or Prod
degree_of_parallelism Yes Degree of parallelism during the calendar upgrades This should be positive numeric value.
webtmpl_file_url No OOS Bucket PAR URL for the zipped file containing custom webtemplates(<filename>.zip) Files to be zipped directly inside the zip file without any enclosing directory(zip <filename>.zip file1 file2 file3... )
js_file_url No OOS Bucket PAR URL for the zipped file containing custom js files(<filename>.zip) Files to be zipped directly inside the zip file without any enclosing directory(zip <filename>.zip file1 file2 file3... )
css_file_url No OOS Bucket PAR URL for the zipped file containing custom css files(<filename>.zip) Files to be zipped directly inside the zip file without any enclosing directory(zip <filename>.zip file1 file2 file3... )
prod_file_url Yes (for Production upgrade) OOS Bucket PAR URL for the zipped file containing custrep.dat and 10 schema_x.ddl files Files to be zipped directly inside the zip file without any enclosing directory(zip <filename>.zip file1 file2 file3... ) This zip file PAR URL is available on successful completion of dev upgrade.
dump_file_url Yes (for Database upgrade) OOS Bucket PAR URL for the Database Dump File (no zipping) dump_file_url or repo_file_url is mandatory(zipped/tar files not allowed)
schema_owner Yes (for Database Upgrade) DBSchema owner for the database dump Source database schema owner
tablespace Yes (for Database Upgrade) Tablespace name for the database dump Source database tablespace
index_tablespace No Index tablespace name for the database dump Source database index tablespace
repo_file_url Yes (for Repository Upgrade) OOS Bucket PAR URL for the CustomerRepository dat file (no zipping) dump_file_url or repo_file_url is mandatory(zipped/tar files not allowed)

Payload Format and Sample Input Payload

Input Payload Format

{
    "current_siebel_version": "",
    "requester_email": ["user1@example.com","user2@example.com","user3@example.com"],
    "base_language":"",
    "other_languages":"",
    "component_groups":"",
    "upt_file_url":"",
    "custom_files":{
        "webtmpl_file_url":"",
        "js_file_url":"",
        "css_file_url":"",
        "keyfilebin_url":""
    },
    "db_dump": {
         "dump_file_url" : "",
         "schema_owner":"",
         "tablespace":"",
         "index_tablespace":""
    },
    "customer_repository": {
        "repo_file_url" : ""
    }
}

Sample Input Payload —Dev Upgrade

{
    "current_siebel_version": "v8.1.1.14sia",
    "requester_email": ["user1@example.com","user2@example.com","user3@example.com"],
    "base_language":"enu",
    "other_languages":"",
    "component_groups":"fins",
    "upt_file_url":"https://objectstorage.XXXXXXXXXXXXXX/UpgradeFactory/o/UPTCSV.zip",
     "custom_files":{
        "webtmpl_file_url":"https://objectstorage.XXXXXXXXXXXXXX/UpgradeFactory/o/WT.zip",
        "js_file_url":"https://objectstorage.ap-mumbai-1.oraclecloud.com/p/XXXXXXXXX/o/JS.zip",
        "css_file_url":"https://objectstorage.ap-mumbai-1.oraclecloud.com/p/XXXXXXXXXX/o/CSS.zip",
        "keyfilebin_url":""
    },
    "db_dump": {
         "dump_file_url" : "",
         "schema_owner":"",
         "tablespace":"",
         "index_tablespace":""
    },
    "customer_repository": {      
         "repo_file_url" : "https://objectstorage.us-ashburn-1.oraclecloud.com/p/XXXXXXXXXXXX/o/Repository_81114.dat"
 
    }
}

To trigger the upgrade with the payload follow the steps:

  1. Prepare the payload as per the pre-defined payload format.
  2. Open any preferred REST API client.
  3. Paste the payload in the input area of the application and select POST method.
  4. Enter the REST API URI- http://<PUBLIC-IP>:<Port>/scm/api/v1.0/upgradefactory.
  5. Post the request by clicking Send (in case of Boomerang).
  6. You will be prompted for authentication credentials.
  7. Enter these default credentials to proceed with the request;
    • USERNAME - admin
    • PASSWORD - get a token from the SCM instance by signing in with an SSH key. Go to the folder /home/opc/config and view the api_creds.ini file.

    Make a note of the basic_auth_password.

    Default Credentials

    USERNAME - admin

    PASSWORD - Token from the previous step.

  8. Wait for the response, which contains all the steps you need as part of the upgrade.
  9. You will receive an email for subscription confirmation from Oracle Cloud Infrastructure Notifications Service.
  10. Click the Confirm subscription hyperlink to enable the email notifications for upgrade execution.

The following table lists the steps that are executed as part of the Upgrade Factory process:

Step Details Action
01_env_provisioning Environment provisioning and Siebel setup using the Repository/dump file provided. Automated
02_assessment_report_generation Pre-upgrade Repository Analyzer execution and Assessment Report generation. Automated
03_upgrep_irm_process Trigger Siebel Upgrade Process - UPGREP followed by IRM Process. Automated
04_launch_webtool_for_conflict_resolution Prepares the environment to enable Web Tools launch for conflict resolution. Automated
05_conflict_resolution Waits for user to launch Web Tools and complete the conflict resolution. Launch Web Tools and complete conflict resolution
06_fullpublish Triggers fullpublish post conflict resolution Automated
07_upgphys_process Resumes Upgrade process with full publish followed by UPGPHYS process to complete the Siebel Upgrade. Automated

Status Check and Actions

Checking the Execution Status

After the upgrade factory process starts, it takes a couple of hours to set up the environment and execute the Repository Analyzer. If you subscribe to notification you will receive an email on completion of every step. If you want to know the status of the execution, you can trigger a GET request on the same URI to know the current status (REST API URI Format: http://<PUBLIC_IP>:<Port>/scm/api/v1.0/upgradefactory).

Here is what you see:

  • The Status is marked as completed on successful execution with a start time and end time.
  • The current running status is marked as in-progress with a start time.
  • Important URLs are listed at the bottom of the payload.
  • If the upgrade status shows failed, it means there is an issue with the execution.

Sample Output Payload

{
  "data": {
    "stages": {
      "01_env_provisioning": {
        "comment": "",
        "end_time": "Mon, 05 Jun 2023 07:28:41 +0000",
        "start_time": "Mon, 05 Jun 2023 06:55:32 +0000",
        "status": "completed"
      },
      "02_assessment_report_generation": {
        "comment": "",
        "end_time": "Mon, 05 Jun 2023 09:50:31 +0000",
        "start_time": "Mon, 05 Jun 2023 07:28:52 +0000",
        "status": "completed"
      },
      "03_upgrep_irm_process": {
        "comment": "",
        "end_time": "Mon, 05 Jun 2023 13:44:30 +0000",
        "start_time": "Mon, 05 Jun 2023 09:50:37 +0000",
        "status": "completed"
      },
      "04_launch_webtool_for_conflict_resolution": {
        "comment": "",
        "end_time": "Mon, 05 Jun 2023 13:54:31 +0000",
        "start_time": "Mon, 05 Jun 2023 13:45:14 +0000",
        "status": "completed"
      },
      "05_conflict_resolution": {
        "comment": "Please launch Siebel Web Tools and complete the conflict resolution to proceed further.",
        "end_time": "Mon, 05 Jun 2023 15:53:37 +0000",
        "start_time": "Mon, 05 Jun 2023 13:54:35 +0000",
        "status": "completed"
      },
      "06_fullpublish": {
        "comment": "Upgrade is successfully completed. Please launch the application URLs and validate.",
        "end_time": "Mon, 12 Jun 2023 10:15:15 +0000",
        "start_time": "Mon, 12 Jun 2023 10:01:12 +0000",
        "status": "completed"
      },
      "07_upgphys_process": {
        "comment": "Upgrade is successfully completed. Please launch the application URLs and validate.",
        "end_time": "Mon, 12 Jun 2023 10:15:15 +0000",
        "start_time": "Mon, 12 Jun 2023 10:01:12 +0000",
        "status": "completed"
      },
      "upgrade_status": "completed",
      "urls": {
        "check_status_url": "http://<PUBLIC_IP>:<Port>/scm/api/v1.0/upgradefactory",
        "final_outputs": "https://ocibucket.xxx.com/o/FinalOutputFiles230605072746.zip",
        "repo_analyzer_assessment_report": "https://ocibucket.xxx.com/o/RepositoryAnalyzerReport230605072746.zip",
        "siebel_fins_enu": "https://<PUBLIC_IP>:<Port>/siebel/app/fins/enu",
        "siebel_smc_url": "https://<PUBLIC_IP>:<Port>/siebel/smc",
        "siebel_webtool_url": "https://<PUBLIC_IP>:<Port>/siebel/app/webtools/enu",
        "upgrade_factory_logs": "https://ocibucket.xxx.com/o/UpgradeFactoryLogs230605072746.zip"
      }
    },
    "message": "Upgrade is already running.",
    "status": "success"
  }
}

Pre-upgrade Assessment Report (RepAnalyzer Reports)

Here is what you see in the pre-upgrade assessment report:

The assessment report and summary dashboard are uploaded to OCI bucket and the pre-assessment Report URL is shared in the status check response.

Here is what you can do next:

  1. Download the report from any browser.
  2. Unzip the ReportData.txtand RepAnalyzer Dashboard from the downloaded file.
  3. Open the UpgradeAssessementReport.htmlfile inside the RepAnalyzer Dashboard directory.
  4. The summary shows a count of conflicts that are critical, needs attention and informational for UI, business, and data entities, in the form of this table:
    Classification Definition
    Info No action required from the customer
    Attention Customer has to verify and resolve, but not a show stopper
    Critical Need action from customer. It’s can be a show stopper
  5. Click Conflict Count to navigate to the detailed page.
  6. The tree structure on the left provides the categorization of UI, Business and Data layer.
  7. Only critical conflicts are displayed in the table.
  8. Schema page will have all the Schema level change details
  9. RepCrawler report (all unreferenced objects list) is added as part of the assessment report.
  10. Duplicate workflow and task list is captured as part of the assessment report.

Development Upgrade

  1. Execution type in the input payload is passed as “dev” for development upgrade execution.
  2. Development upgrade performs a series of activities on the database or Repository provided (upgrep and IRM), and then launches Web Tools for conflict resolution.
  3. Process is paused for conflict resolution by the user and resumes once the conflict resolution is completed on Web Tools.
  4. Process proceeds with fullpublish and upgphys to complete the upgrade activity.
  5. An output files downloadable URL which downloads dev output files zipped after development upgrade. There are 10 schema_x.ddl and one custrep.dat file which are required for test and production upgrades.

Production Upgrade

  1. Execution type in the input payload is passed as “prod” for production upgrade execution.
  2. Downloadable URL for Output files zip from the development upgrade is provided as input for t upgrade.
  3. Production upgrade utilizes 11 files from the development upgrade and performs the production upgrep process to upgrade the schema and Repository in the production database.

Add Ingress Rules on OCI to Enable Access to Server

All the connections to the host server ports are secured using Ingress rules configuration on Oracle cloud infrastructure (OCI). If you are unable to access any of the required ports like 443 for the Siebel application and 1521 port for the database connect, it might be due to missing ingress configuration.

Here is how you can configure ingress rules:

  1. Identify your sub compartment name under the root compartment which you selected when you created the SCM stack.

    Compartment name format : <resource_prefix_name> -siebel-cm

    resource_prefix_name is the resource prefix to name the OCI resources. For example, if resource_prefix_name = UpgradeFactory then the compartment name is UpgradeFactory-siebel-cm.

  2. Go to OCI console > Compute > Instances and select the Compartment ID (resource prefix name + -siebel-cm) and click Instance Name.
  3. Drill down to the Name hyperlink for the instance having your Public IP, and then drill down further on the Subnet hyperlink.
  4. Select security-list-for-cm.
  5. Add ingress rules for required ports:
    • Source CIDR - this is the IP address of the source machine which would need access to the server. To get the IPv4 address of the machine, use this link: https://whatismyipaddress.com/. Source CIDR is <youripaddress>/32
    • Destination port range - 443
      Note: Port 443 for Siebel application access including Web Tools, 1521 port for Siebel DB access.
  6. Click Add Ingress Rules.

Resolve Conflicts using Web Tools

The Upgrade conflict resolution screen is now enabled on Siebel Web Tools. Once the upgrade factory process completes the 04_launch_webtool_for_conflict_resolution step, Status check response provides you a Web Tools URL, which is also sent to you by email. At this point, the upgrade factory process is paused for user action. Make sure the ingress rule is added for your system IPAddress and port 443. (Web Tools URL is hosted with port 443).

Here is how you can resolve conflicts using Web Tools:

  1. Launch Web Tools using the URL available in the payload response.
  2. Enter the credentials shared on Web Tools.
  3. Navigate to Tools > Upgrade conflicts.
  4. You can choose to override using the override flag or select options using the Resolution dropdown.
  5. Select multiple records on the screen and, or, click Change records to update the records.
  6. Click Accept recommendations to update the recommendations on all records.
  7. Click Conflict Resolution Complete on the top applet and accept the confirmation message.
  8. On Confirmation, Siebel Web Tools is logged out and the upgrade factory process will resume in sometime.

Complete the Upgrade

Here is what happens when the upgrade factory process resumes:

  • Once the conflict resolution is marked as completed, UPGREP is triggered.
  • Upgrade is complete once the UPGPHYS is completed.
  • The application URLs are available at the bottom of the response.
  • You can access the final output files using the URLs in the response.
  • The zipped file contains the Repository export and schema ddl.
  • Execution is now complete and the upgraded application is available.