Creating external database schema for webMethods API Portal

webMethods API Portal tutorial

API Portal is a multi-tenant-enabled application.The different tenants share the infrastructure of their installation, but have completely separated content.

In general, a dedicated schema needs to be created for each tenant. Since as we mentioned above each API Portal installation has at minimum not one but two tenants ("default" and "master"), you need to create at least two schemas, plus additional schemas for each additional tenant you want use on the installation.

SQL scripts and all additional files. All scripts and files can be downloaded from the ARIS Download Center (https://aris.softwareag.com/DownloadCenter). To download the SQL scripts register(https://aris.softwareag.com/DCRegisterUser) yourself with ARIS download center.

Version Matrix

API Portal is internally based on ARIS infrastructure. The SQL scripts are published to aris download center using ARIS specific version numbers. Below table summarizes the portal version and its corresponding ARIS version.

API Portal ARIS
10.1 ARIS 10.0 Service Release 2 Database Scripts
10.2 ARIS 10.0 Service Release 4 Database Scripts
10.3 ARIS 10.0 Service Release 6 Database Scripts
10.4 ARIS 10.0 Service Release 8 Database Scripts
10.5 ARIS 10.0 Service Release 10 Database Scripts

Oracle

  • Edit the envset.bat file and adjust the following lines replacing the highlighted parameters with the settings appropriate for your environment.
REM The path to where sqlplus.exe can be found.
SET CIP_ORA_BIN_PATH=<enter the path>
REM hostname, port and service name
SET TARGET_HOST=localhost
SET TARGET_PORT=1521
SET TARGET_SERVICE_NAME=ARIS
  • Edit the following lines to change the highlighted credentials of the application user
REM credentials of the user that is used by the application.
SET CIP_APP_USER=ARIS10
SET CIP_APP_PWD=*ARIS!1dm9n#
REM password of the tenant schemas.
SET CIP_TENANT_SCHEMA_PWD=*ARIS!1dm9n#yy
  • With the next two lines you specify the DBA user you intend to use to create the application user and this DBA user’s password
REM credentials of the Oracle user that will be used to create the application schema.
REM Note that this user must be endowed with DBA privileges such as user SYSTEM.
SET CIP_INSTALL_USER=system
SET CIP_INSTALL_PWD=manager
  • If your data tablespace name is different from ARISDATA respectively TEMP for temp tablespace, you will also need to modify these highlighted parameters accordingly
REM tablespace name of the tablespace in which the data of the application schema should be stored.
SET CIP_TS_DATA=ARISDATA
REM name of the temporary tablespace.
SET CIP_TS_TEMP=TEMP
  • Save the envset.bat file.
  • Run the script cip_create_app_user.bat
  • Create an empty schema for each tenant. Two schemes are mandatory. One for the master tenant and one for the default tenant. The names, for example, aris_master and aris_default can be modified.

MSSQL

  • Edit the envset.bat file to specify the connection data of the Microsoft SQL server instance. To specify the connection data of the Microsoft SQL instance, modify the highlighted parameters.

@ECHO OFF
REM
REM You may edit this section for customizing purposes.
REM
REM If you use named instances then append a "\" and the name of your instance
SET MSSQL_SAG_MSSQL_SERVER_NAME=localhost
REM The login name that is used to execute this script
SET MSSQL_SAG_MSSQL_LOGIN_NAME=localhost\username
REM name of database that will be created by the script.
SET MSSQL_SAG_DATABASE_NAME=ARIS9DB
REM folder in which the database files should be stored.
SET MSSQL_SAG_FILEGROUP_FILE_DIR=F:\msqldata\ARIS9DB
REM credentials of the login that is used by the application.
SET MSSQL_SAG_APP_USER=ARIS9
SET MSSQL_SAG_APP_PWD=*ARIS!1dm9n#

REM schema names for the default and master tenants
SET MSSQL_SAG_TENANT_DEFAULT=ARIS_DEFAULT
SET MSSQL_SAG_TENANT_MASTER=ARIS_MASTER

...

  • Execute the inst.bat file. This will create the database including the two mandatory tenants and the application user. If you need additional tenants, please use the create_schema_for_tenant.bat file. 

image.jpg