Setting up the Spotfire database (Oracle)

If you are running Oracle Database, follow these steps to set up the Spotfire database before you run the Spotfire Server installer.

Before you begin

You have downloaded the Spotfire Server installation kit from the TIBCO eDelivery web site; for instructions, see Downloading installation software.
The following settings must be configured on the Oracle Database server:
- User name and password authentication.
  Note: It is also possible to set up Spotfire Server to authenticate with an Oracle Database instance using Kerberos; for instructions, see Using Kerberos to log in to the Spotfire database. In this case, you must run the database preparation scripts manually; see Running database preparation scripts manually.
- National Language Support (NLS) to match the language of the data you will bring into Spotfire.
  Note: If the database server NLS cannot be set to match the language of your data, Oracle provides other methods of setting NLS to a specific database or user. For more information, consult your database administrator or see the Oracle database documentation.
You must also have access to the Oracle Database. You may need assistance from your database administrator to copy the install directory to the database and to provide the database details for the script.
Note: The command-line database tools (for example, sqlplus) must be in the system path.

Procedure

Copy the <installation files dir>/scripts/oracle_install directory to a location where you can edit it.
Open the oracle_install directory, and then, in a text editor, open the create_databases script that corresponds to your platform:
- Windows: create_databases.bat
- Linux: create_databases.sh
- Windows (Oracle Database running on Amazon RDS): create_databases_rds.bat
- Linux (Oracle Database running on Amazon RDS): create_databases_rds.sh

In the section under "Set these variables to reflect the local environment", edit the create_databases script by providing the appropriate database server details.

Table 1. Definitions of the variables in create_databases
Variable	Description
ROOTFOLDER	Location where the tablespaces will be created. It must be a directory that is writable for the Oracle instance, usually `oracle install dir`/oradata/`SID` or `oracle install dir`/oradata/`PDBNAME`. Note: Do not add a slash or backslash after the <SID>. Note: This variable is not applicable for the Amazon RDS create_databases scripts.
CONNECTIDENTIFIER	Oracle TNS name/SID of the database/service name, for example ORCL or //localhost/pdborcl.example.com.
ADMINNAME	Name of a user with Oracle Database administrator privileges for the database identified in the CONNECTIDENTIFIER, for example "system".
ADMINPASSWORD	Password of the ADMINNAME user.
SERVERDB_USER	Name of the user that will be created to set up the Spotfire database.
SERVERDB_PASSWORD	Password for SERVERDB_USER.
SERVER_DATA_TABLESPACE	Name of the tablespace that will be created. The default value works for most systems.
SERVER_TEMP_TABLESPACE	Name of the temporary tablespace that will be created. The default value works for most systems. Note: Conflicting tablespaces can occur if you are creating the Spotfire tablespaces on a database server that is already hosting an Analytics Server or a previous version of Spotfire Server. Make sure that you do not select any names for the new tablespaces and users that conflict with the already hosted tablespaces and users.

Example

This is an example of what the file section might look like after modification:

rem Set these variables to reflect the local environment:
rem Where should the data be stored on the database server:
set ROOTFOLDER=C:\oracle\app\orcl
rem A connect identifier to the container database or the pluggable database
rem for a pluggable database a service name like //localhost/pdborcl.example.com
rem could be the SID for Oracle 11 or earlier, TNSNAME etc,
rem see the documentation for sqlplus
set CONNECTIDENTIFIER=//localhost/pdborcl.example.com
rem a username and password for an administrator in this (pluggable) database
set ADMINNAME=system
set ADMINPASSWORD=admin123
rem Username and password for the Spotfire instance this user will be created,
rem remember that the password is written here in cleartext,
rem you might want to delete this sensitive info once the script is run
set SERVERDB_USER=spotfire_db
set SERVERDB_PASSWORD=spotfire_db123
rem The spotfire tablespaces, alter if you want to run multiple instances in the same database
set SERVER_DATA_TABLESPACE=SPOTFIRE_DATA
set SERVER_TEMP_TABLESPACE=SPOTFIRE_TEMP

Save the file and close the text editor.
Open a command line and go to the directory where you placed the scripts.
Type create_databases.bat (Windows) or create_databases.sh (Linux) and press Enter.
If the parameters are correct, text that is similar to the following text appears in the command-line interface:

Note: The log.txt file is created in the same directory as the create_databases file. Examine this file to verify that no errors occurred, and retain the log for future reference.

Note: Because the scripts contain sensitive information, it is good practice to remove them after your Spotfire environment has been installed.

What to do next

Install Spotfire Server