Installing PAI Advanced on the WebUI Server
Installing PAI Advanced on the WebUI Server with Linux
1. Sign in to the WebUI Server as the administrative user.
2. Open a command tool and run the following command to set the environment variables:
. <SERVIGISTICS_HOME>/Servigistics/bin/profile
3. Run the following commands to create directories for installing the software:
◦ mkdir $SERVIGISTICS_HOME/PAI
◦ mkdir $SERVIGISTICS_HOME/PAI/dist
◦ mkdir $SERVIGISTICS_HOME/PAI/DBUpgrader
◦ mkdir $SERVIGISTICS_HOME/PAI/Jar
◦ mkdir $SERVIGISTICS_HOME/PAI/Reports
◦ mkdir $SERVIGISTICS_HOME/PAI/Reports/Foundation
◦ mkdir $SERVIGISTICS_HOME/PAI/Reports/Advanced
◦ mkdir $SERVIGISTICS_HOME/PAI/Scripts
◦ mkdir $SERVIGISTICS_HOME/PAI/Scripts/PAI
◦ mkdir $SERVIGISTICS_HOME/PAI/Scripts/SPO
4. Run the following command to extract the contents of the distribution file:
unzip $SERVIGISTICS_HOME/PAI/dist/svg-snowflake-analytics-dist-<version>.zip -d$SERVIGISTICS_HOME/PAI/dist
5. Run the following command to copy the Snowflake analytics jar:
cp $SERVIGISTICS_HOME/PAI/dist/svg-snowflake-analytics.jar $SERVIGISTICS_HOME/PAI/Jar
6. Run the following commands to extract the PAI Advanced reports:
◦ unzip $SERVIGISTICS_HOME/PAI/dist/svg-foundation-reports.zip -d$SERVIGISTICS_HOME/PAI/Reports/Foundation
◦ unzip $SERVIGISTICS_HOME/PAI/dist/svg-advanced-reports.zip -d$SERVIGISTICS_HOME/PAI/Reports/Advanced
7. Run the following commands if the Servigistics dbupgrader is located on this server. If the Servigistics dbupgrader is located on a different server than the WebUI server, these files also need to be copied or extracted to the server where dbupgrader resides:
◦ cp $SERVIGISTICS_HOME/PAI/dist/dbupgraderPAI.sh $SERVIGISTICS_HOME/PAI/DBUpgrader
◦ cp $SERVIGISTICS_HOME/PAI/dist/DBUpgraderPAI_log4j.xml $SERVIGISTICS_HOME/PAI/DBUpgrader
◦ cp $SERVIGISTICS_HOME/PAI/dist/db-upgrader-runnable.jar $SERVIGISTICS_HOME/PAI/Jar
◦ unzip $SERVIGISTICS_HOME/PAI/dist/svg-snowflake-analytics-sql.zip -d$SERVIGISTICS_HOME/PAI/Scripts/PAI
◦ unzip $SERVIGISTICS_HOME/PAI/dist/svg-snowflake-analytics-spo-sql.zip -d$SERVIGISTICS_HOME/PAI/Scripts/SPO
8. Encrypt the password for the PAI Schema. [view instructions]
 |
Copy the encrypted password to a notepad for easy copy/paste to replace the value of the .<Encrypted PAI Schema Password> property and servigistics.analytics.sf.dbpassword property.
|
9. Set the following properties in $SERVIGISTICS_HOME/Servigistics/DBUpgrader/DBUpgrader.properties:
|
|
If the Servigistics dbupgrader is not installed on the WebUI server, this step needs to be done on the server where the Servigistics dbupgrader resides.
|
◦ servigistics.analytics.sf.dburl=jdbc:snowflake://<account>.<region>.snowflakecomputing.com
◦ servigistics.analytics.sf.dbusername=<dbusername>
◦ servigistics.analytics.sf.dbpassword=<encrypted dbpassword>
◦ servigistics.analytics.sf.dbdriver=net.snowflake.client.jdbc.SnowflakeDriver
◦ servigistics.analytics.sf.dbtype=snowflake
◦ servigistics.analytics.sf.warehouse=<warehouse>
◦ servigistics.analytics.sf.database=<database>
◦ servigistics.analytics.sf.schema=<schema>
◦ servigistics.analytics.sf.useencryptedpass=true
◦ servigistics.analytics.sf.csvFileSplitRowCount=<maximum row count>
10. Set the following properties in $SERVIGISTICS_HOME/Servigistics/WebUI/WebUI.properties:
|
Property Name
|
Value
|
Tip
|
|---|---|---|
|
servigistics.analytics.jarurl
|
Path to svg-snowflake-analytics-<version>.jar on the server in the format:
file:<jar path>
|
file:C:/SPO12.1.1.2/PAI/Jar/svg-snowflake-analytics.jar
|
|
servigistics.analytics.sf.dburl
|
URL of database containing the schema for the analytics data
|
jdbc:snowflake://<account>.<region>.snowflakecomputing.com
|
|
servigistics.analytics.sf.dbusername
|
Username for the analytics schema having read/write permission
|
The Snowflake username
|
|
servigistics.analytics.sf.dbpassword
|
Encrypted password
|
Enter the encrypted password generated in step 8
|
|
servigistics.analytics.sf.dbdriver
|
Snowflake JDBC Driver
|
net.snowflake.client.jdbc.SnowflakeDriver
|
|
servigistics.analytics.sf.dbtype
|
snowflake
|
|
|
servigistics.analytics.sf.warehouse
|
Snowflake warehouse for compute resources
|
Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.database
|
Snowflake database where your schema resides
|
Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.schema
|
Snowflake schema where your database tables reside
|
Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.internalStageName
|
Snowflake stage where CSV files are stored
|
Destination on the Snowflake platform where CSV files are uploaded. Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.csvpath
|
AutoPilot server accessible file path to write the exported CSV files
|
There must be enough available space to store all Servigistics exported data for one entire Analytics run. If there are multiple AutoPilot servers this parameter needs to specify a shared drive with read/write permissions.
|
|
servigistics.analytics.fillrate.horizonDays
|
30
|
Defines the number of days in the past to calculate fill rate
|
|
servigistics.analytics.pi.demandmiss.calc.horizonslices
|
Default is 12
|
Determines the horizon for past period for Unplanned Missed calculation.
|
|
servigistics.analytics.pi.demandmiss.retainslices
|
Default is 6
|
Determines the number of periods in months to retain to be used for Unplanned Missed calculation.
|
|
servigistics.analytics.sf.csvFileSplitRowCount
|
Not less than 10,000. The recommended value is 500,000
|
The value that specifies the maximum number of rows to be written to a CSV file when creating files containing data to load into Snowflake. Multiple CSV files are created if the number of rows exceeds the value specified. This improves performance in Snowflake when files are larger than 1 GB in size.
|
11. Run the following commands to apply the database patches.
|
|
If the Servigistics dbupgrader is located on a different server than the WebUI server, the files in this step need to be copied to the server where dbupgrader resides.
|
a. Run the following to apply patches to the Servigistics schema for Oracle:
$SERVIGISTICS_HOME/Servigistics/DBUpgrader/dbupgrader.sh -p $SERVIGISTICS_HOME/PAI/Scripts/SPO/oracle/upgrades
b. Run the following to apply patches to the Servigistics schema for MSSQL:
$SERVIGISTICS_HOME/Servigistics/DBUpgrader/dbupgrader.sh -p $SERVIGISTICS_HOME/PAI/Scripts/SPO/mssql/upgrades
c. If installing PAI for the first time, run the following to create tables in the PAI schema:
$SERVIGISTICS_HOME/PAI/DBUpgrader/dbupgraderPAI.sh -s $SERVIGISTICS_HOME/PAI/Scripts/PAI/snowflake/full/FullDB.sql
d. If upgrading PAI, run the following to apply patches to the PAI schema:
$SERVIGISTICS_HOME/PAI/DBUpgrader/dbupgraderPAI.sh -p $SERVIGISTICS_HOME/PAI/Scripts/PAI/snowflake/upgrades
12. Proceed with the next step, Installing PAI Advanced on the AutoPilot Server with Linux
Installing PAI Advanced on the WebUI Server with Windows
1. Sign in to the WebUI Server as the administrative user.
2. Open a command tool.
3. Navigate to the <SERVIGISTICS_HOME>\Servigistics\bin directory and run the following command to set the environment variables:
env.bat
4. Run the following commands to create directories for installing the software:
◦ mkdir %SERVIGISTICS_HOME%\PAI
◦ mkdir %SERVIGISTICS_HOME%\PAI\dist
◦ mkdir %SERVIGISTICS_HOME%\PAI\DBUpgrader
◦ mkdir %SERVIGISTICS_HOME%\PAI\Jar
◦ mkdir %SERVIGISTICS_HOME%\PAI\Reports
◦ mkdir %SERVIGISTICS_HOME%\PAI\Reports\Foundation
◦ mkdir %SERVIGISTICS_HOME%\PAI\Reports\Advanced
◦ mkdir %SERVIGISTICS_HOME%\PAI\Scripts
◦ mkdir %SERVIGISTICS_HOME%\PAI\Scripts\PAI
◦ mkdir %SERVIGISTICS_HOME%\PAI\Scripts\SPO
5. Run the following command to extract the contents of the distribution file:
7z x %SERVIGISTICS_HOME%\PAI\dist\svg-snowflake-analytics-dist-<version>.zip -o%SERVIGISTICS_HOME%\PAI\dist
6. Run the following command to copy Snowflake analytics jar:
copy %SERVIGISTICS_HOME%\PAI\dist\svg-snowflake-analytics.jar %SERVIGISTICS_HOME%\PAI\Jar
7. Run the following commands, or use the built-in Windows extract program, to extract the PAI Advanced reports:
◦ 7z x %SERVIGISTICS_HOME%\PAI\dist\svg-foundation-reports.zip -o%SERVIGISTICS_HOME%\PAI\Reports\Foundation
◦ 7z x %SERVIGISTICS_HOME%\PAI\dist\svg-advanced-reports.zip -o%SERVIGISTICS_HOME%\PAI\Reports\Advanced
8. Run the following commands if the Servigistics dbupgrader is located on this server. If the Servigistics dbupgrader is located on a a different server than the WebUI server, these files need to be copied or extracted to the server where dbupgrader resides.
◦ copy %SERVIGISTICS_HOME%\PAI\dist\dbupgraderPAI.bat %SERVIGISTICS_HOME%\PAI\DBUpgrader
◦ copy %SERVIGISTICS_HOME%\PAI\dist\DBUpgraderPAI_log4j.xml %SERVIGISTICS_HOME%\PAI\DBUpgrader
◦ copy %SERVIGISTICS_HOME%\PAI\dist\db-upgrader-runnable.jar %SERVIGISTICS_HOME%\PAI\Jar
◦ 7z x %SERVIGISTICS_HOME%\PAI\dist\svg-snowflake-analytics-sql.zip -o%SERVIGISTICS_HOME%\PAI\Scripts\PAI
◦ 7z x %SERVIGISTICS_HOME%\PAI\dist\svg-snowflake-analytics-spo-sql.zip -o%SERVIGISTICS_HOME%\PAI\Scripts\SPO
9. Encrypt the password for the PAI Schema. [view instructions]
|
|
Copy the encrypted password to a notepad for easy copy/paste to replace the value of the .<Encrypted PAI Schema Password> property and servigistics.analytics.dbpassword property.
|
10. Set the following properties in %SERVIGISTICS_HOME%\Servigistics\DBUpgrader\DBUpgrader.properties:
|
|
If the Servigistics dbupgrader is not installed on the WebUI server, this step needs to be done on the server where the Servigistics dbupgrader resides.
|
◦ servigistics.analytics.sf.dburl=jdbc:snowflake://<account>.<region>.snowflakecomputing.com
◦ servigistics.analytics.sf.dbusername=<dbusername>
◦ servigistics.analytics.sf.dbpassword=<encrypted dbpassword>
◦ servigistics.analytics.sf.dbdriver=net.snowflake.client.jdbc.SnowflakeDriver
◦ servigistics.analytics.sf.dbtype=snowflake
◦ servigistics.analytics.sf.warehouse=<warehouse>
◦ servigistics.analytics.sf.database=<database>
◦ servigistics.analytics.sf.schema=<schema>
◦ servigistics.analytics.sf.useencryptedpass=true
◦ servigistics.analytics.sf.csvFileSplitRowCount=<maximum row count>
11. Set the following properties in %SERVIGISTICS_HOME%\Servigistics\WebUI\WebUI.properties:
|
Property Name
|
Value
|
Tip
|
|---|---|---|
|
servigistics.analytics.jarurl
|
Path to svg-snowflake-analytics-<version>.jar on the server in the format:
file:<jar path>
|
file:C:\SPO12.1.1.2\PAI\Jar\svg-snowflake-analytics.jar
|
|
servigistics.analytics.sf.dburl
|
URL of database containing the schema for the analytics data
|
jdbc:snowflake://<account>.<region>.snowflakecomputing.com
|
|
servigistics.analytics.sf.dbusername
|
Username for the analytics schema having read/write permission
|
The Snowflake user
|
|
servigistics.analytics.sf.dbpassword
|
Encrypted password
|
Enter the encrypted password generated in step 9
|
|
servigistics.analytics.sf.dbdriver
|
Snowflake JDBC Driver
|
net.snowflake.client.jdbc.SnowflakeDriver
|
|
servigistics.analytics.sf.dbtype
|
snowflake
|
|
|
servigistics.analytics.sf.warehouse
|
Snowflake warehouse for compute resources
|
Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.database
|
Snowflake database where your schema resides
|
Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.schema
|
Snowflake schema where your database tables reside
|
Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.internalStageName
|
Snowflake stage where CSV files are stored
|
Destination on the Snowflake platform where CSV files are uploaded. Created in the Creating the Snowflake Resources step
|
|
servigistics.analytics.sf.csvpath
|
AutoPilot server accessible file path to write the exported CSV files
|
There must be enough available space to store all Servigistics exported data for one entire Analytics run. If there are multiple AutoPilot servers this parameter needs to specify a shared drive with read/write permissions.
|
|
servigistics.analytics.fillrate.horizonDays
|
30
|
Defines the number of days in the past to calculate fill rate
|
|
servigistics.analytics.pi.demandmiss.calc.horizonslices
|
Default is 12
|
Determines the horizon for past period for Unplanned Missed calculation.
|
|
servigistics.analytics.pi.demandmiss.retainslices
|
Default is 6
|
Determines the number of periods in months to retain to be used for Unplanned Missed calculation.
|
|
servigistics.analytics.sf.csvFileSplitRowCount
|
Not less than 10,000. The recommended value is 500,000
|
The value that specifies the maximum number of rows to be written to a CSV file when creating files containing data to load into Snowflake. Multiple CSV files are created if the number of rows exceeds the value specified. This improves performance in Snowflake when files are larger than 1 GB in size.
|
12. Run the following commands to apply the database patches.
|
|
If the Servigistics dbupgrader is located on a different server than the WebUI server, the files in this step need to be copied to the server where dbupgrader resides.
|
a. Run the following to apply patches to the Servigistics schema for Oracle:
%SERVIGISTICS_HOME%\Servigistics\DBUpgrader\dbupgrader.bat -p %SERVIGISTICS_HOME%\PAI\Scripts\SPO\oracle\upgrades
b. Run the following to apply patches to the Servigistics schema for MSSQL:
%SERVIGISTICS_HOME%\Servigistics\DBUpgrader\dbupgrader.bat -p %SERVIGISTICS_HOME%\PAI\Scripts\SPO\mssql\upgrades
c. If installing PAI for the first time, run the following to create tables in the PAI schema:
%SERVIGISTICS_HOME%\PAI\DBUpgrader\dbupgraderPAI.bat -s %SERVIGISTICS_HOME%\PAI\Scripts\PAI\snowflake\full\FullDB.sql
d. If upgrading PAI, run the following to apply patches to the PAI schema:
%SERVIGISTICS_HOME%\PAI\DBUpgrader\dbupgraderPAI.bat -p %SERVIGISTICS_HOME%\PAI\Scripts\PAI\snowflake\upgrades
13. Proceed with the next step, Installing PAI Advanced on the AutoPilot Server with Windows