3 Quick Deployment

Use the shell script TSAMSetup.sh to deploy Oracle TSAM Plus Manager from scratch. This script creates Oracle database users, sets up the required database schema, creates a WebLogic Server domain, and deploys the TSAM Plus Manager application to it.

Before running TSAMSetup.sh, you must fill in the required values in the template configuration file TSAMSetup.cfg.

Table 3-1 TSAMSetup.cfg Parameters

Parameter	Required / Conditional	Description
TSAM_HOME	Required	TSAM Plus Manager installation home directory. Defaults to the parent directory of the running script when TSAM_HOME is not already set.
TSAM_USER_ADMIN_PASSWD	Required	Password for the TSAM Plus Manager application administrator user.
TSAM_EAR_LOCATION	Required	Path to the TSAM Plus Manager Enterprise Archive file to deploy. Defaults to ${TSAM_HOME}/deploy/tsam_22c.ear.
TSAM_ENABLE_AI	Required	Controls whether the TSAM Plus Manager AI feature is enabled. Set to Y to enable AI-related settings; set to N to disable.
DB_CONNSTR	Required	DB_CONNSTR must be host:port/service_name or a complete (DESCRIPTION=...) descriptor. Do not use a TNS alias in the TSAMSetup.cfg wrapper path, and do not include jdbc:oracle:thin:@; the wrapper adds it.
DB_IS_ADB	Required	Flag indicating whether the database is Oracle Autonomous Database (ADB). Use Y for ADB; use N for non-ADB.
DB_ENABLE_PARTITION	Required	Controls whether database partitioning is enabled for TSAM schema objects.
DB_USER_ADMIN	Required	For non-ADB, the account must authenticate to the target database AS SYSDBA, normally as SYS. For ADB, use the predefined ADMIN account through a normal connection.
DB_USER_ADMIN_PASSWD	Required	Password for DB_USER_ADMIN.
DB_USER_TABLESPACE	Required	Default tablespace for newly created DB_USER_TSAM and optional DB_USER_TSAMAI users. However, it is required when TSAM_ENABLE_AI=Y
DB_USER_DROP_IFEXIST	Optional (default: N)	Controls whether existing TSAM-related database users are dropped during setup if they already exist. Y or -dropUser runs DROP USER ... CASCADE for the primary user and, when AI is enabled, the AI user. With N, existing users are not reused and provisioning fails.
DB_USER_TSAM	Required	Primary TSAM database schema username.
DB_USER_TSAM_PASSWD	Required	Password for DB_USER_TSAM.
DB_USER_TSAMAI	Optional	AI-enabled database schema username used when the TSAM AI feature is enabled.
DB_USER_TSAMAI_PASSWD	Required when TSAM_ENABLE_AI=Y	Password for DB_USER_TSAMAI.
WLS_HOME	Required	WebLogic Server home directory. Defaults to the bundled wls directory under TSAM_HOME when WLS_HOME is not already set.
WLS_DOMAIN_LOCATION	Required	The location of the new WebLogic domain to be created. Defaults to user_projects/domains/tsamdomain under WLS_HOME when WLS_DOMAIN_LOCATION is not already set.
WLS_USER_ADMIN	Required	WebLogic domain administrator username.
WLS_USER_ADMIN_PASSWD	Required	Password for WLS_USER_ADMIN.
WLS_PORT	Required	Port number on which WebLogic Server listens for incoming connections.
WLS_DATASERVER_PORT	Required	Port number for the TSAM DataServer channel used by LMS.
WLS_ADMIN_PORT	Required	Port number on which WebLogic Server listens for domain administrative operations.
WLS_TLS_KEYSTORE	Required	Path to the TLS keystore JKS file used by WebLogic/TSAM. Refer to Generate TLS Keystores for all WLS_TLS_* related parameters.
WLS_TLS_KEYSTORE_PASSWD	Required	Password for the WebLogic TLS keystore.
WLS_TLS_TRUSTSTORE	Required	Path to the TLS truststore JKS file used by WebLogic/TSAM.
WLS_TLS_TRUSTSTORE_PASSWD	Required	Password for the WebLogic TLS truststore.
WLS_TLS_PRIVATEKEY_ALIAS	Required	Alias of the private key entry in the TLS keystore.
WLS_TLS_PRIVATEKEY_PASSWD	Required	Password for the TLS private key.
AI_OCI_CRED_USER	Required when any selected AI provider is oci.	OCI user OCID.
AI_OCI_CRED_TENANCY	Required when any selected AI provider is oci.	OCI tenancy OCID.
AI_OCI_CRED_PRIVATEKEY	Required when any selected AI provider is oci.	Path to an existing readable OCI API private key file.
AI_OCI_CRED_FINGERPRINT	Required when any selected AI provider is oci.	Fingerprint for the OCI API key.
AI_OCI_COMPARTMENT_ID	Required when any selected AI provider is oci.	OCI compartment OCID used by OCI Generative AI.
AI_VECTORINDEX_SOURCE_MODE	Required when TSAM_ENABLE_AI=Y.	Document source mode for vector index input. CLOUD uses the product-owned built-in documentation source. This is the default mode. Operators do not configure document-source URLs in TSAMSetup.cfg. LOCAL uses Oracle DIRECTORY-backed sources on the database host. LOCAL is supported only when DB_IS_ADB=N.
AI_MAIN_PROVIDER	Required when TSAM_ENABLE_AI=Y	LLM provider for the main TSAM AI agent.
AI_MAIN_MODEL	Required when TSAM_ENABLE_AI=Y	Main agent LLM model. Should be reasoning-capable because it handles the most complicated tasks.
AI_MAIN_REGION	Optional	OCI region for the main agent LLM deployment.
AI_MAIN_MAX_TOKENS	Optional	Maximum token limit configured for the main agent LLM.
AI_METRICS_PROVIDER	Optional	LLM provider for metric-query functionality.
AI_METRICS_MODEL	Optional	LLM model used for metric-query functionality.
AI_METRICS_REGION	Optional	OCI region for the metric-query LLM deployment.
AI_METRICS_MAX_TOKENS	Optional	Maximum token limit configured for the metric query LLM deployment
AI_USERDOC_PROVIDER	Optional	LLM provider for user-document-based question answering.
AI_USERDOC_MODEL	Optional	LLM model used for user-document-based question answering.
AI_USERDOC_REGION	Optional	OCI region for the user-document QA LLM deployment.
AI_USERDOC_MAX_TOKENS	Optional	Maximum token limit configured for the user document QA LLM deployment.
AI_CONSOLEDOC_MODEL	Optional	LLM model used for console-document-based question answering.
AI_CONSOLEDOC_PROVIDER	Optional	LLM provider for console-document-based question answering.
AI_CONSOLEDOC_REGION	Optional	OCI region for the console-document QA LLM deployment.
AI_CONSOLEDOC_MAX_TOKENS	Optional	Maximum token limit configured for the console document QALLM deployment.
AI_FOLLOWUPDOC_PROVIDER	Optional	LLM provider for follow-up question generation.
AI_FOLLOWUPDOC_MODEL	Optional	LLM model used for follow-up question generation. Can be a more cost-effective worker model because it handles simpler tasks.
AI_FOLLOWUPDOC_REGION	Optional	OCI region for the follow-up generation LLM deployment.
AI_FOLLOWUPDOC_MAX_TOKENS	Optional	Maximum token limit configured for the follow-up generation LLM deployment.
AI_OPENAI_CREDENTIAL_USERNAME	Required when any selected AI provider is openai	OpenAI credential username.
AI_OPENAI_API_KEY	Required when any selected AI provider is openai	OpenAI API key.
AI_AZURE_CREDENTIAL_USERNAME	Required when any selected AI provider is azure.	Azure credential username.
AI_AZURE_API_KEY	Required when any selected AI provider is azure.	Azure API key.
AI_AZURE_RESOURCE_NAME	Required when any selected AI provider is azure	Azure resource name.
AI_AZURE_EMBEDDING_DEPLOYMENT_NAME	Required when any selected AI provider is azure	Optional Azure embedding deployment name. It is rendered only when explicitly set.

Note:

TSAM Plus supports the several AI providers. The provider can be configured independently for the main agent, and the metrics, user-document, console-document, and follow-up workloads.

Default Value:

An unset worker provider (AI_*_PROVIDER) inherits AI_MAIN_PROVIDER. A worker inherits the main model or Azure deployment, and the OCI region where applicable, only when it uses the same provider as the main agent. For a mixed-provider configuration, explicitly configure the worker's provider-specific model or Azure deployment and, for OCI, its region. Configure credentials and database network access for every provider used by any workload.

The AI_MAX_TOKENS settings are independent for each profile and do not inherit from AI_MAIN_MAX_TOKENS, if not set, the default value will be used.