CAST AIP 8.3.x Documentation
Page tree
Skip to end of metadata
Go to start of metadata

Database/Schema Installation

This option is the starting point for all new CAST AIP schema installation operations. If you want to:

  • create a new Combined Installation (Analysis, Dashboard and Management Service in one go)
  • create a new Analysis Service
  • create a new Dashboard Service
  • create a new Management Service
  • create a new Measurement Service (CAST Storage Service only)

...then this is the option you require. You can either use an existing database/schema for your CAST AIP database/schema or create a new database/schema on the host server.

Please note that in order to carry out database/schema installation operations, the username you are using to connect to the selected server must have sufficient privileges (you can change the way you connect to the server in the Open Profile Connection dialog box).

To proceed with a new installation:

  1. Select Database/Schema Installation > Database/Schema Installation from the menu bar.
  2. The CAST Base Installation dialog box will then be displayed:

    This dialog box enables you to choose what type of installation operation you want to carry out with CAST Server Manager. Choose the configuration you require and click the Next button An explanation of each option is shown below:

    Left column options Right column options What is installed? When should I choose this option?
    Initial platform base(s) installation Application Analytics platform installation All four CAST AIP schemas are installed automatically with the following suffixes:
    • Management Service (_MNGT)
    • Analysis Service (_LOCAL)
    • Dashboard Service (_CENTRAL)
    • Measurement Service (_MEASURE)
    		 Choose this option if you are installing CAST AIP from scratch and require access to all functionality (and have appropriate licensing to do so).

    Note this option is ONLY available if you are using the CAST Storage Service as your chosen storage host. This is because the Measurement Service can only be installed on a CAST Storage Service.
    Additional Analysis platform Three CAST AIP schemas are installed automatically with the following suffixes:
    • Management Service (_MNGT)
    • Analysis Service (_LOCAL)
    • Dashboard Service (_CENTRAL)
    		 Choose this option if you are not licensed or do not intend to use the CAST Health Dashboard.
    CAST-MS only Only the Management Service schema is installed. You are free to choose the name of the schema. Choose this option only if you require an additional Management Service, i.e. for situations where you are distributing the CAST AIP schemas across multiple host CAST Storage Services/RDBMS.
    Additional Knowledge Base

    Select this option if you want to install a CAST Analysis Service (Knowledge Base) that will be used to store results of a source code analysis.

    Additional Central Base

    Select this option if you want to install a Dashboard Service (Central) for your CAST Engineering Dashboard.

    Additional Measurement Base

    Select this option if you want to install a Measurement Service for your CAST Health Dashboard.

    		 N/A One additional CAST AIP schema is installed: the type depends on the option you have selected. Choose these options only if you require additional Analysis, Dashboard or Measurement Services, i.e. for situations where you are distributing the CAST AIP schemas across multiple host CAST Storage Services/RDBMS, or where you are migrating from a previous version that did not include the specific schema.

    Note that the Additional Analysis platform option is ONLY available if you are using the CAST Storage Service as your chosen storage host. This is because the Measurement Service can only be installed on a CAST Storage Service.
  3. The CAST Schema/Database Creation dialog box will then be displayed. This will differ according to the selections made above:
    Displayed for:

    - all ADDITIONAL options - Initial platform base(s) installation > CAST-MS only

    		 Displayed ONLY for:

    - Initial platform base(s) installation > Application Analytics platform installation
    - Initial platform base(s) installation > Additional Analysis platform

    This dialog box enables you to choose how you want to install the items:

    New Schema/Database User (schema) Name / Schema Name / Database Name Enter the name you want to give the schema/database (for Oracle, this is the schema user name).

    If you choose a name that already exists in the system catalog on the target server, then Server Manager will prompt you.

    Notes

    • For all server types please note the following CAST requirements:

      - The name must be in upper case - the following characters are authorized: 0-9, A-Z and _ (underscore)
      - The name must NOT start with a number
    • RDBMS specific naming rules also apply - please see the on-line Help for your specific RDBMS for more information.
    User Password (Oracle only) Enter a password for the user associated to the schema you want to create.

    Make sure you remember this as it may be required to carry out other operations.
    Existing Schema/Database User (schema) Name / Schema Name / Database Name Enter the name of an existing schema/database (for Oracle, this is the schema user name).

    Alternatively, use the Browse button to view a list of schemas/databases that already exist on the server.

    Notes

    • This option will not be available when using the following options (new schemas/databases must be created):
      • Initial platform base(s) installation > Application Analytics platform installation
      • Initial platform base(s) installation > Additional Analysis platform

    This dialog box will be displayed when you click the Browse button in the CAST Schema/Database Creation dialog box. It lists all existing databases/schemas on the server you are connected to. Select the database/schema you want to use for the installation operation and click OK.

    Options
    • Limit display to 20 rows > displays the first 20 database/schemas
    • Name like > enter a search to help narrow down the number of returned databases/schemas - clicking Reload will apply the filter to the list.
    Prefix for new Schema/Database Prefix Enter a prefix that will be used to define the names of the new databases/schemas for the CAST AIP databases/schemas.

    For example, choosing TEST will result in an installation as follows:

    • TEST_MNGT
    • TEST_LOCAL
    • TEST_CENTRAL
    • TEST_MEASURE

    Notes

    • For all server types please note the following CAST requirements:

      - The name must be in upper case - the following characters are authorized: 0-9, A-Z and _ (underscore)
    • RDBMS specific naming rules also apply - please see the on-line Help for your specific RDBMS for more information.
    Password (apply to all) - Oracle only Enter a password for the user associated to the schemas you want to create.

    Make sure you remember this as it may be required to carry out other operations.

    Notes

    • During the installation process of the three schemas, CAST Server Manager will prompt you for the password - as such please do not leave the installation unattended.
  4. At this point you will be prompted to enter various configuration options for your new or existing database/schema - this includes the creation of tablespaces (Oracle), log files and other parameters required by CAST.

    Please note, however, that if you use the Combined Install options, it is not possible to define separate tablespaces/data spaces for each installed item. Instead, one tablespace/data space will be used for all three CAST AIP schemas. If you require separate tablespace/data space for EACH CAST AIP schema, please install each individually.

    Select the most appropriate server environment below:

CAST Storage Service

For the CAST Storage Service, the Database Creation dialog box enables you to choose the Data and Temporary Tablespace for your schemas. You can also, optionally, choose to store Tables and Indexes in separate Tablespace.

If you are planning to use user defined tablespace rather than default system tablespaces, this must be created in pgAdmin or by using scripts before using CAST Server Manager.

New Schema

Option "Use different data space for Indexes and Tables" NOT selected

By default, CAST Server Manager allows you to choose the location for your Data Tablespace and the Temporary Tablespace:

Data Tablespace Name

Select an existing Data Tablespace for tables and indexes. By default this is set to the pg_default tablespace, but this can be changed by selecting a new Tablespace from the dropdown list. The system tablespace pg_global along with any user defined tablespaces are offered in the drop down list.

  • If you want to use dedicated Data Tablespace just for CAST components - this must be created prior to using CAST Server Manager.
Temporary Tablespace Name

Select an existing Temporary Tablespace for temporary information. By default this is set to the TEMP tablespace, but this can be changed by selecting a new Tablespace from the dropdown list.

  • If you want to use dedicated Data Tablespace just for CAST components - this must be created prior to using CAST Server Manager.

Option "Use different data space for Indexes and Tables" selected

If you prefer to store the schema's Tables and Indexes in separate Tablespaces (as oppose to in one general Data Tablespace), you can select the option Use different data space for Indexes and Tables. This will display additional fields entitled Table Tablespace Name and Index Tablespace Name along with the default Temporary Tablespace Name field.

Table Tablespace Name Select an existing Data Tablespace for tables. By default this is set to the pg_default tablespace, but this can be changed by selecting a new Tablespace from the dropdown list. The system tablespace pg_global along with any user defined tablespaces are offered in the drop down list.
  • If you want to use dedicated Data Tablespace just for CAST components - this must be created prior to using CAST Server Manager.
Index Tablespace Name Select an existing Index Tablespace for indexes. By default this is set to the pg_default tablespace, but this can be changed by selecting a new Tablespace from the dropdown list. The system tablespace pg_global along with any user defined tablespaces are offered in the drop down list.
  • If you want to use dedicated Data Tablespace just for CAST components - this must be created prior to using CAST Server Manager.
Temporary Tablespace Name Select an existing Temporary Tablespace for temporary information. By default this is set to the pg_default tablespace, but this can be changed by selecting a new Tablespace from the dropdown list. The system tablespace pg_global along with any user defined tablespaces are offered in the drop down list.
  • If you want to use dedicated Data Tablespace just for CAST components - this must be created prior to using CAST Server Manager.

Microsoft SQL-Server

For Microsoft SQL-Server, the Database Creation dialog box enables you to define the names and locations of your Primary and Log Files. You can also, optionally, choose to store Tables and Indexes in separate files away from the Primary File.

New Database

Use different data space for Tables and Indexes not selected.

By default, CAST Server Manager will offer to create one Primary File in which to store all objects associated with the new database and one log file for trace requirements.

  • Primary File & Log File
    Logical File Name Enter a name for the Primary File and Log File. By default this is set to CAST_PRIMARY and CAST_LOG, but these names can be changed by manually entering new names.
    • This name is used to reference the file in any T-SQL statements after the database is created.
    • The name must be unique in the database and conform to the rules for identifiers.
    • The name can be a character or a regular identifier.
    Operating System File Path This is the default path that CAST Server Manager will use for the creation of the corresponding file. You can change this by either entering a new path and filename manually, or using the Browse ".." button to explore the contents of the disks on the machine hosting the server you are connected to.
    • The file path must specify a directory on a Microsoft SQL-Server instance.
    • The default path and file names displayed in this field are derived using information taken from the Windows registry on the machine hosting the RDBMS. For security reasons, this information may not always be available or accessible. In this case, no file name will be proposed and it will not be possible to use the Browse button to find a path. You may also see error messages in the log file regarding access to the registry (e.g.: "RegQueryValueEx()" and "The directory does not exist"). These errors are not fatal and the creation of the database will still be possible via manual entry of the path and filename.
    • Note that CAST Server Manager does NOT use the properties "Default Data Directory" or "Default Log Directory" (that can be set on the Microsoft SQL-Server in Enterprise Manager) to create the default path for data and log files.
    File Size (MB) By default the file size for the Primary File is set to 400MB (CAST_PRIMARY) and 200MB (CAST_LOG), with the option Unlimited to allow for automatic file growth. You can change these values by manually entering new sizes.
Use different data space for Tables and Indexes selected.

If you choose to store the database's system Tables and Indexes in separate files away from the Primary File, you can select the option Use different data space for Tables and Indexes. This will display two further fields entitled Filegroup for Table and Filegroup for Index along with the default Primary File and Log File fields. The Primary File and Log File fields are identical to those described above.

  • Filegroup for Table & Filegroup for Index
    Filegroup Name Enter a filegroup name that will be used to store the database Tables. By default this is set to CAST_TABLE and CAST_INDEX, but these names can be changed by manually entering new names.
    • This name is used to reference the file in any T-SQL statements after the database is created.
    • The name must be unique in the database and conform to the rules for identifiers.
    • The name can be a character or a regular identifier.
    Logical File Name Enter a name for the Primary File and Log File. By default this is set to CAST_TABLE and CAST_INDEX, but these names can be changed by manually entering new names.
    • This name is used to reference the file in any T-SQL statements after the database is created.
    • The name must be unique in the database and conform to the rules for identifiers.
    • The name can be a character or a regular identifier.
    Operating System File Path This is the default path that CAST Server Manager will use for the creation of the corresponding file. You can change this by either entering a new path and filename manually, or using the Browse ".." button to explore the contents of the disks on the machine hosting the server you are connected to.
    • The file path must specify a directory on a Microsoft SQL-Server instance.
    • The default path and file names displayed in this field are derived using information taken from the Windows registry on the machine hosting the RDBMS. For security reasons, this information may not always be available or accessible. In this case, no file name will be proposed and it will not be possible to use the Browse button to find a path. You may also see error messages in the log file regarding access to the registry (e.g.: "RegQueryValueEx()" and "The directory does not exist"). These errors are not fatal and the creation of the database will still be possible via manual entry of the path and filename.
    • Please note that CAST Server Manager does NOT use the property "Default Data Directory" or "Default Log Directory" that can be set on the Microsoft SQL-Server in Enterprise Manager to create the default path for data and log files.
    File Size (MB) By default the file size is set to 400MB, with the option Unlimited to allow for automatic file growth. You can change these values by manually entering new sizes.
Existing Database

Use different data space for Tables and Indexes not selected.

When you have chosen to carry out the installation procedure in an existing database on the server (this database needs to be manually created on the server prior to using CAST Server Manager), and the Use different data space for Tables and Indexes option is not selected, then there is no possibility to change where the CAST installation components will be stored. Instead, the Database Creation dialog box displays (in read-only) where the components will be installed.

Please note that:

  • The name of the existing database must conform to the following CAST requirements:
    • The name must be in upper case
    • The following characters are authorized: 0-9, A-Z and _ (underscore)
  • The following database options must be set to the values listed below:
    • sp_dboption HJK, 'trunc', true
    • sp_dboption HJK, 'autoclose', false
    • sp_dboption HJK, 'select into/bulkcopy', true

Use different data space for Tables and Indexes selected.

When you have chosen to carry out the installation procedure in an existing database on the server (this database needs to be manually created on the server prior to using CAST Server Manager), and the Use different data space for Tables and Indexes option is selected, then CAST Server Manager will give you the opportunity to choose where you want to install the Tables and Indexes Filegroups (these Filegroups need to be manually created on the server prior to using CAST Server Manager). Other items will be installed to the existing PRIMARY Filegroup. Use the drop down list to select a different Filegroup for the Tables and Indexes.

Please note that:

  • If there are no specific Table and Index Filegroups created on the server, then CAST Server Manager will display <No Selection Available>.
  • The name of the existing database must conform to the following CAST requirements:
    • The name must be in upper case
    • The following characters are authorized: 0-9, A-Z and _ (underscore)
  • The following database options must be set to the values listed below:
    • sp_dboption HJK, 'trunc', true
    • sp_dboption HJK, 'autoclose', false
    • sp_dboption HJK, 'select into/bulkcopy', true
  • The Filegroup for the Tables must be set to DEFAULT. You can modify this either in Enterprise Manager or by using the following query:
    • alter database <DATABASE_NAME> modify filegroup <TABLE_FILEGROUP_NAME> DEFAULT

Oracle

For Oracle, the Database Creation dialog box enables you to define the names and locations of your schema's Data and Temporary Tablespace. You can also, optionally, choose to store Tables and Indexes in separate Tablespace.

Notes

  • See http://doc.castsoftware.com for more information about sizing and creating Tablespace.
  • Please see the Appendix for more information about the privileges granted to the user created during the installation of a new schema.
New Schema

Use different data space for Indexes and Tables not selected.

By default, CAST Server Manager allows you to choose the location for your Data Tablespace and the Temporary Tablespace.

Data Tablespace Name

Select an existing Data Tablespace for tables and indexes. By default this is set to the CWMLITE tablespace, but this can be changed by selecting a new Tablespace from the dropdown list.

  • It is not possible to select Temporary or SYSTEM tablespace for use with Data.
  • CAST recommends creating dedicated Data Tablespace just for CAST components - this must be created prior to using CAST Server Manager.
Temporary Tablespace Name

Select an existing Temporary Tablespace for temporary information. By default this is set to the TEMP tablespace, but this can be changed by selecting a new Tablespace from the dropdown list.

  • It is only possible to select Temporary Tablespace in the drop down list. As a result, if you want to create dedicated Temporary Tablespace just for CAST, then make sure it is configured as Temporary.

Use different data space for Indexes and Tables selected.

If you choose to store the schema's Tables and Indexes in separate Tablespaces (as oppose to in one general Data Tablespace), you can select the option Use different data space for Indexes and Tables. This will display additional fields entitled Table Tablespace Name and Index Tablespace Name along with the default Temporary Tablespace Name field.

Table Tablespace Name

Select an existing Table Tablespace for tables. By default this is set to the CWMLITE tablespace, but this can be changed by selecting a new Tablespace from the dropdown list.

  • It is not possible to select Temporary or SYSTEM tablespace for use with Tables.
  • This dedicated Tablespace must be created prior to using CAST Server Manager.
Index Tablespace Name

Select an existing Index Tablespace for indexes. By default this is set to the CWMLITE tablespace, but this can be changed by selecting a new Tablespace from the dropdown list.

  • It is not possible to select Temporary or SYSTEM tablespace for use with Indexes.
  • This dedicated Tablespace must be created prior to using CAST Server Manager.
Temporary Tablespace Name

Select an existing Temporary Tablespace for temporary information. By default this is set to the TEMP tablespace, but this can be changed by selecting a new Tablespace from the dropdown list.

  • It is only possible to select Temporary Tablespace in the drop down list. As a result, if you want to create dedicated Temporary Tablespace just for CAST, then make sure it is configured as Temporary.
Existing Schema

Use different data space for Indexes and Tables not selected.

When you have chosen to carry out the installation procedure in an existing schema on the server (this schema needs to be manually created on the server prior to using CAST Server Manager), and the Use different data space for Indexes and Tables option is not selected, then there is no possibility to change where the CAST installation components will be stored - they will be stored by default in the existing schema's default data Tablespace and temporary Tablespace. Instead, the Database Creation dialog box displays (in read-only) where the components will be installed.

Please note that:

  • The name of the existing database must conform to the following CAST requirements:
    • The name must be in upper case
    • The following characters are authorized: 0-9, A-Z and _ (underscore)

Use different data space for Indexes and Tables selected.

When you have chosen to carry out the installation procedure in an existing schema on the server (this schema needs to be manually created on the server prior to using CAST Server Manager), and the Use different data space for Indexes and Tables option is selected, then CAST Server Manager will give you the opportunity to choose where you want to install the Index Tablespace (this Tablespace needs to be manually created on the server prior to using CAST Server Manager). It will not be possible to choose where to install the Table Tablespace, because CAST Server Manager will detect the default Tablespace of the user you are using to connect to the server with and use this - this will be displayed in read-only mode. Use the drop down list to select a different Tablespace for the Indexes.

Please note that:

  • The name of the existing database must conform to the following CAST requirements:
    • The name must be in upper case
    • The following characters are authorized: 0-9, A-Z and _ (underscore)
What happens next?

The database/schema creation and component installation process will then start for all options:

  1. A dialog box displaying a summary of the proposed installation will then be displayed:
  2. Click Proceed to start the component installation.
  3. A dialog box will inform you of installation progress:
  4. When all previous operations have been successfully completed, the Server Browser will display the installed components next to your new database/schema in the "Installed Product" heading:

Notes

  • You can also use the icon located on the toolbar to proceed with the a database/schema installation.
See Also

Privileges | Application Interface

CAST Website

  • No labels