Configure API-Portal with Microsoft® SQL Server 2012 or Microsoft® SQL Server 2014
To customize the API-Portal with Microsoft® SQL Server 2012 or Microsoft® SQL Server 2014 you need the following components:
An operating Microsoft
® SQL Server 2012 or Microsoft
® SQL Server 2014 database.
The Microsoft
® JDBC Driver sqljdbc4.jar. You can download this driver from the Microsoft 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.
1. Go to the directory Software AG Installation Directory\API_Portal\Add-ons\DatabaseScripts\Design&ConnectServer\mssql.
2. Configure envset.bat
a. Log on remotely onto the system where the database is installed and copy the database scripts to that system.
In the Design&ConnectServer directory you can find the following files:
create_schema_for_tenant.bat envset.bat fix_collation_for_tenant.bat inst.bat b. Edit the following lines in the envset.bat file:
SET MSSQL_SAG_MSSQL_SERVER_NAME=DB Server Name
SET MSSQL_SAG_MSSQL_LOGIN_NAME=DB User Name
SET MSSQL_SAG_DATABASE_NAME=Name of the database
SET MSSQL_SAG_FILEGROUP_FILE_DIR=Location to store the file groups
3. Run the database scripts. Before running the database scripts ensure that the Microsoft SQL Server client (sqlcmd) is available in the command prompt. Execute the inst.bat file. If you need additional tenants please use the create_schema_for_tenant.bat file.
4. Add the JDBC drivers to API-Portal classpath.
a. Start API-Portal Cloud Controller.
b. Stop all runnables except zoo_m.
c. In ACC, type enhance apiportalbundle_m with commonsClasspath local file "sqljdbc4.jar location"
5. Register the external service database.
a. In ACC, type register external service db url="jdbc:sqlserver://servername:port;DatabaseName=databasename" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" username="username" password="password" maxIdle=15 maxActive=300 maxWait=10000 removeAbandoned=false removeAbandonedTimeout=600 logAbandoned=true defaultAutoCommit=false rollbackOnReturn=true host=servername jmxEnabled=true
An external service identifier will be returned once the above command is executed, for example it returns the service id as db0000000000.
b. Execute the following command from ACC console to assign the service to the tenant default: assign tenant default to service db0000000000 com.aris.cip.db.schema=CIP_DEFAULT assign tenant master to service db0000000000 com.aris.cip.db.schema=CIP_MASTER
6. Start all runnables.
You configured API-Portal with a Microsoft® SQL Server 2012 or Microsoft® SQL Server 2014 database.
