Downloading and Running the Siebel Lift Utility (Non-Container Mode)
You can use the procedures in this topic to download and run the Siebel Lift utility in non-container mode. This topic is part of Downloading and Running the Siebel Lift Utility.
Downloading the Siebel Lift Utility (for Non-Container Mode)
Use the following procedure to download the Siebel Lift utility for non-container mode.
Prerequisites for running Siebel Lift Utility (for Non-Container Mode):
You must have OpenSSL version 3.0.5 or higher for the encryption/decryption mechanism to work.
To download the Siebel Lift utility (for non-container mode)
-
Obtain the file
siebelliftutility.zip
from SCM, as described at the end of the procedure in Downloading and Installing Siebel Cloud Manager. -
Extract the contents of the ZIP file.
Installing and Configuring Python (for Non-Container Mode)
If you are using non-container mode for downloading and running the Siebel Lift utility, then you must use one of the procedures below to install and configure Python. Do this before you run the Siebel Lift utility.
To install and configure Python on Windows (for non-container mode)
-
On Windows, you download Python from https://www.python.org/downloads.
Next, you will install various Python modules with the required settings by using the appropriate command and the
requirements.txt
file for the Python installation. If you are installing a later version of Python, then make sure to use the compatible versions of the dependent modules. -
Configure proxy settings by entering a command like the following:
export/set https_proxy=https://proxy-name:port
For example:
https_proxy=https://www-proxy-hqdc.us.oracle.com:80
-
Use a command like the following to install Python. The versions defined in the
requirements.txt
settings are compatible with the version of Python you install (Python 3.9.6). Run this command from the folder in which you have extracted the siebelliftutility.zip file.pip install -f third-party-lib/ -r requirements.txt
To install and configure Python on Linux (for non-container mode)
-
On Linux, you use documented commands to install and configure Python 3.8.x or 3.9.x from Software Collection Library(SCL). The versions defined in the
requirements.txt
settings are compatible with the version of Python you install.For Oracle Enterprise Linux 7, use commands like the following to install and configure Python 3.8.x from SCL. In this case, the versions defined in the
requirements.txt
settings are compatible with Python 3.8.x.-
Add proxy to
/etc/yum.conf
for enabling proxy in yum installs, as follows:sudo yum-config-manager --enable ol7_latest ol7_optional_latest sudo yum install -y oracle-softwarecollection-release-el7 sudo yum -y install scl-utils rh-python38
-
To enable and use Python 3.8.x from the SCL, run these commands. Run the
pip install
command from the folder in which you have extracted thesiebelliftutility.zip
file.scl enable rh-python38 bash python --version pip install -f third-party-lib/ -r requirements.txt
For Oracle Enterprise Linux 8, use commands like the following to install and configure Python 3.9.x from SCL. In this case, the versions defined in the
requirements.txt
settings are compatible with Python 3.9.x. For more information, see: -
-
If you will be creating Siebel database artifacts (deployment kits), then validate that you have the necessary version of the Oracle Database client. For more information, see Requirements and Limitations.
-
In the PATH environment variable, include Python, Python scripts, 7-Zip (or other extraction tool), and the Oracle Database home.
-
Verify the setup by running commands like the following on the OCI terminal or command prompt:
python --version 7z oci -v
Note: If any of these commands fail, then check the PATH variable definitions made in Step 3 of this procedure and update them as needed. If you are behind a firewall, then you might also need to modify the HTTP and HTTPS proxy settings for your environment. Set the environment variableshttp_proxy
andhttps_proxy
to suitable proxy servers.
Running the Siebel Lift Utility in Silent Mode (for Non-Container Mode)
Use the following procedure to run the Siebel Lift utility in silent mode.
The response file lift_utility_responsefile_template.resp
is
available in the directory where you extracted the utility. You can modify a copy of
this file according to your requirements.
To run the Siebel Lift utility in silent mode (for non-container mode)
-
Modify the response file as needed.
The response file you specify must contain settings corresponding to those described in the procedure for running the Siebel Lift utility in interactive mode.
-
Enter the following command in a command window or shell:
python siebel_lift_utility.py -f <response_file> -sp <smc_password> -dp <table_owner_password>
In this command, use the arguments to specify a response file, the password for Siebel Management Console (SMC), and the table owner password. The
-sp
and-dp
flags are mandatory where SMC_CONFIGURATION and DATABASE (in the section ARTIFACT_TYPE) are set to YES in the response file.
Running the Siebel Lift Utility in Interactive Mode (for Non-Container Mode)
Use the following procedure to run the Siebel Lift utility in interactive mode.
To run the Siebel Lift utility in interactive mode (for non-container mode)
-
Enter the following command in a command window or shell:
python siebel_lift_utility.py
Follow the instructions and provide the required inputs on each screen. The steps that follow describe the available options.
-
In the welcome screen, select the task you want to perform. You can choose to create deployment kits, upload deployment kits to OCI Object Storage, or both.
-
If you are creating deployment kits, then select the artifact type for creating deployment kits. You can select application tier artifacts, database tier artifacts, or both.
-
If you selected application tier artifacts, then select one or more of the following options, which are mandatory for deployment: SMC configuration profiles, Siebel File System, or custom Web files. You can also select encryption key file or other artifacts (files not included in other options).
-
If you selected SMC configuration profiles as one of the application tier artifact selections, then specify the details to allow introspection of the SMC configuration data.
Specify the SMC host name, the SMC HTTPS port, the application context root name, the authenticated user name, and the authenticated user password. For more information about these options, see Siebel Installation Guide.
-
If you included Siebel File System as one of the application tier artifact selections, then specify the Siebel File System path locations in a single comma-separated value. (This value would correspond to the Siebel File System parameter in the Siebel CRM on-premises environment.)
-
If you selected custom Web files as one of the application tier artifact selections, then specify the locations of these files (custom files, custom images, and custom scripts) in the application container directory for your existing deployment.
-
For Siebel CRM 21.2 or later, specify
SIEBEL_ROOT
/applicationcontainer_external
(on the Siebel Enterprise installation location where you're running Siebel Application Interface) as the parent directory for the three types of files. -
For Siebel CRM 21.1 and earlier, specify
SIEBEL_ROOT
/applicationcontainer
(on the Siebel Application Interface installation location) as the parent directory for the three types of files.
For more information about the Web artifact locations, see Siebel Installation Guide for your Siebel CRM installed version.
-
-
If you selected database tier artifacts in Step 3 of this procedure, then select the database type. (In this release, Oracle Database is the only selection.)
-
Specify the database configuration information by doing one of the following:
- Directly specify information such as the following:
-
Oracle Home location. Specify the installation location of the Oracle Client.
-
Table owner user. Specify the table owner user.
-
Table owner user password. Specify the table owner user password.
-
TNS profile name. Specify the TNS profile name from the tsnnames.ora file.
-
Database directory creation flag. (Optional) Used to map the directory location in the database. If a directory is already created or mapped by the Database Administrator, then specify N. If a directory wasn't already created, then specify Y.
-
Number of parallel transactions. (Optional) Used to increase the performance of this utility. This parameter depends on the CPU configuration: if there are more than one CPU, then you can specify a value greater than 1 (the default is 1). It is recommended to pass the value 16 to make the utility run faster.
-
Database directory name. Used to create the directory name to store the database dump files.
-
Application user extraction flag. (Optional) Used to extract the Siebel users and their access. Specify Y (the default) to extract all Siebel users. Specify N to extract only SADMIN and GUESTUSER.
-
-
Alternatively, you can prepare a database configuration file containing these settings, such as
db_config.ini
, and specify the location of this file.
- Directly specify information such as the following:
-
If you are uploading deployment kits to OCI Object Storage, then specify configuration information for OCI access by doing one of the following:
-
Directly specify information such as OCI region name, OCI tenancy ID, OCI compartment ID, OCI user ID, OCI private key file location, OCI passphrase, OCI fingerprint, and OCI bucket name.
You can find most of these settings from the Profile menu after logging into OCI. If necessary, first create API keys. Then you can download the OCI private key file to a location accessible to the Siebel Lift utility.
-
Alternatively, you can prepare an OCI configuration file containing these settings, such as
oci_config.ini
, and specify the location of this file. Structure the file like the following:# <KEY=VALUE> (Do not change the KEY name. Only update the VALUE.) [OCI_CONFIGURATION_DETAILS] # [NOTE: An Oracle Cloud Infrastructure region. Example: us-example-1] OCI_REGION_NAME= # [NOTE: OCID of the tenancy. Example: ocid1.tenancy.oc1..<unique_ID>] OCI_TENANCY_ID= # [NOTE: OCID of the compartment. Example: ocid1.compartment.oc1..<unique_ID>] OCI_COMPARTMENT_ID= # [NOTE: OCID of the user. Example: ocid1.user.oc1..<unique_ID>] OCI_USER_ID= # [NOTE: Full path and filename of the private key. The key pair must be in PEM format. Example: oci_api_key.pem] OCI_PRIVATE_KEY_FILE_LOCATION= # [NOTE: Passphrase used for the key, if it is encrypted.] OCI_PASSPHRASE= # [NOTE: Fingerprint for the public key that was added to OCI user.] OCI_FINGER_PRINT= # [NOTE: Name of the bucket to be created or already exist inside the compartment of the OCI object store. The deployment kit gets upload under this bucket.] OCI_BUCKET_NAME=
-
-
Complete and exit your Siebel Lift utility session. The deployment kits will be created, uploaded to OCI Object Storage, or both, according to your selections.
When you create deployment kits, an
export.log
file is created, which you can review. Creating Siebel database artifacts creates a very large file named likeEXPORT_01.DMP
.Note: Before you proceed with Siebel CRM deployment steps described in Deploying Siebel CRM on OCI, in order to make sure deployment is successful, make sure that the deployment artifacts have been successfully uploaded. -
Review log files such as
siebel_lift_utility.log
,setup.log
, orcreatedirectory.log
to confirm successful execution or to help you troubleshoot issues you might encounter.Also review Requirements and Limitations and other information about the Siebel Lift utility. For issues in creating database artifacts, review your specified number of parallel transactions or other settings.