Configure API Portal with an Oracle Database
To customize the API Portal with Oracle 11g or Oracle 12c database you need the following components:
An operating Oracle database.
The ojdbc6.jar driver. You can download this driver from the Oracle Web Site to a directory of your choice.
SQL scripts and all additional files. These scripts can be downloaded from the
ARIS Download Center.
The SQL scripts creates a database and necessary database objects required by the API Portal components.
To configure API Portal with an Oracle Database
1. Back up data from API Portal.
a. Log on to API Portal as an Administrator.
b. Click 
in the right top corner of the API Portal window to display the menu options. c. Click Administration > Manage data.
d. Select Backup.
e. Select the relevant options and click Backup.
A success message appears when the backup process is completed. The backup file with an extension .acb is created and saved in the downloads section. You can move the file and save it in another location of your choice.
2. Open API Portal Cloud Controller and run the following commands.
stopall
deconfigure postgres_s
start zoo_s
3. To configure envset.bat, go to the directory where the script files are downloaded from ARIS Download centre. Scripts are present in the folder, download_root_folder\ARIS.xxx_Add-ons\Add-ons\DatabaseScripts\Design&ConnectServer\oracle
You can find the following files in this directory:
prepare_database.bat
cip_create_schema_for_tenant.bat
cip_update_schema_for_tenant.bat
envset.bat
4. Open the envset.bat file, modify the following fields, and save the file:
SET CIP_ORA_BIN_PATH=
Path where sqlplus.exe can be found (for example C:\app\<username>\product\11.2.0\<dbname>\BIN)
SET TARGET_HOST=
DB Server NameSET TARGET_PORT=
PortSET TARGET_SERVICE_NAME=
Name of the databaseSET CIP_INSTALL_USER=
User NameSET CIP_INSTALL_PWD=
Password5. Run the envset.bat file.
6. To create database schema for the tenants default and master, run the following commands in a command line.
cip_create_schema_for_tenant.bat CIP_MASTER cip_create_schema_for_tenant.bat CIP_DEFAULT Note: | You can use dbvisualizer to ensure that the schemas are created. |
7. Add the JDBC drivers to API Portal classpath.
a. Start API Portal Cloud Controller.
b. Run the following command:
enhance apiportalbundle_s with commonsClasspath
local file "ojdbc6.jar location"
8. Register the external service database.
a. In API Portal Cloud Controller, run the following commands:
register external service db url="jdbc:oracle:thin:@servername:
port:servicename"
driverClassName=oracle.jdbc.OracleDriver jmxEnabled=true maxActive=100
maxIdle=15 logAbandoned=true rollbackOnReturn=true maxWait=10000
removeAbandoned=false defaultAutoCommit=false
username=User Name password=Pasword
host=servername
An external service identifier is returned once the above command is executed, for example, it returns the service id as db0000000001.
b. Run the following command to assign the service to the default and master tenants:
assign tenant default to service db0000000001
com.aris.cip.db.schema=default schema
assign tenant master to service db0000000001
com.aris.cip.db.schema=master schema
9. In API Portal Cloud Controller, run the following command to start all the runnables:
startall
10. Restore the backed up data.
a. Log on to API Portal as an Administrator.
b. Click in the right top corner of the API Portal window to display the menu options. c. Click Administration > Manage data.
d. Select Restore.
e. Click Upload and select the relevant backup file to be uploaded.
f. Select the relevant options and click Restore.
A success message appears when the restore process is completed.
If you want to create a new tenant you can do the following:
Stop all runnables excerpt zoo_m
Run the follwoing commands:
cip_create_schema_for_tenant.bat CIP_
tenantNameassign tenant default to service db0000000001 com.aris.cip.db.schema=CIP_
tenantNameCreate the new tenant.
