Created by James Hurrell, last modified on Feb 18, 2020
This documentation is not maintained. Please refer to doc.castsoftware.com/technologies to find the latest updates.

On this page:

Target audience:

CAST Administrators

Summary: This page explains how to install the extension on your workstation

Prerequisites

  • This section assumes that a complete installation of CAST AIP as described in the CAST AIP install documentation has already been actioned.
  • You must also ensure that your CAST AIP installation is compatible with the extension - AIP compatibility is listed in PeopleSoft 5.0 - Release Notes.

Notes

The process of downloading and installing this extensions differs depending on the format that the extension is published in (archive or NuGet format). Historically CAST provided extensions in archive format (a ZIP file or similar), however, starting with CAST AIP 7.3.x, CAST is transitioning to delivery in NuGet format via the CAST Extension Downloader. While this transition phase continues, some releases of an extension may only be available as an archive file (typically older releases) and some may only be available in NuGet format via the CAST Extension Downloader (typically newer releases). In addition, some may be available in both formats.

The latest release status of this extension can be seen when downloading it from the CAST Extend server.

Step 1: Obtain the extension

If your extension is provided as an archive file

You can download the extension as an archive file direct from CAST.

If your extension is provided as a Nuget file

If your extension is provided in NuGet format, it can be downloaded using a tool called the CAST Extension Downloader. For users of CAST AIP 7.3.x the CAST Extension Downloader is not provided as part of the setup. Instead it is available as a separate download from our FTP server. Please unzip the archive file and copy the contents into your CAST AIP installation folder and double click the ExtensionDownloader.exe file to launch the application.


The CAST Extension Downloader connects automatically to a special content delivery server hosted by CAST.

  • First you need to locate the extension you want to download.
  • In the menu shown below, ensure that the following two options are selected:
    • the Latest versions only option (CAST recommends this option to filter out previous releases of extensions)
    • the Long term support only option (CAST recommends this option to filter out pre-release or BETA releases)


  • Now click the Available option on the left hand side of the application - this option will display all extensions which you have not already downloaded:


  • All extensions matching the selected filtering options will now be displayed. Scroll through to find the extension your require - selecting an extension in the list will display information about it in the right hand panel, highlighted in red below:


  • Ensure you take note of the required Dependencies as highlighted above - dependencies listed will be downloaded at the same time as the extension you have chosen (for example, the AngularJS extension requires the HTML5/JavaScript and WBSLinker extensions, the most recent versions of which will be downloaded at the same time).
  • Click the Download button to start the download of the extension:


  • Extensions are downloaded to the following location on your local machine:
8.x.x
%PROGRAMDATA%\CAST\CAST\Extensions

7.3.x
<CAST_installation_folder>\CustomPlugins


Step 2: Copy files and manage index.xml

If your extension is provided as an archive file

  • Extract the content (using the feature "Extract To" or similar) of the supplied archive file into an existing drive such as C:\ or D:\. The following subfolders will be created. Please ensure that you complete the actions listed in the Required Action column:
Subfolder
Contents
Required Action
Notes
ToBeCopiedInCProgramDataOrAllUsersFolder

Contains the following configuration folders:

  • Configuration folder
  • InstallScripts folder
These two folders must be copied into the following Windows folder:
  • Windows Vista, Windows 7, Server 2008:  %ALLUSERSPROFILE%\CAST\CAST\<version>
  • previous versions of Windows: %ALLUSERSPROFILE%\Application Data\CAST\CAST\<version>

 

When installing the extension from scratch

If you are installing the extension from scratch, i.e. it has not been installed on the target workstation before, please take into account the following:

  • You may be prompted to merge the two folders with identical folders in the target location - you should do so.
  • If the following files exist already in the target location, please perform a merge rather than overwrite the existing files:
    • InstallScripts\Common\local_custom.pck
    • InstallScripts\Common\central_custom.pck

When installing the extension as a Service Pack

If you are installing the extension as a Service Pack, i.e. a previous release has already been installed on the target workstation, please take into account the following:

  • You will be prompted to merge the two folders with identical folders in the target location - you should do so. When prompted whether you want to overwrite or replace existing files of the same name, please do so.
ToBeInstalledInSCDFPlugins

Contains the CAST Delivery Manager Tool plugins:

  • dmtcastpeoplesoftdb2extractor-1.0.dmtplugin
  • dmtcastpeoplesoftextractor-1.0.dmtplugin
  • dmtcastpeoplesoftoracleextractor-1.0.dmtplugin
  • dmtcastpeoplesofttechno-1.0.dmtplugin
  • index for PeopleSoft customs.xml

The index for PeopleSoft customs.xml file must be copied to the following location:

<Delivery_folder>\plugins

.dmtplugin files must first be extracted (using a third party extractor such as 7zip) and then the extracted files/folders must be copied into the same folder (<Delivery_folder>\plugins). So, to take the dmtcastpeoplesoftextractor-1.0.dmtplugin as an example:

  • Extract the file with 7zip or similar
  • This will give you these results:

  • Copy the second dmtcastpeoplesoftextractor-1.0 folder (and the .mda file contained within it) into the <Delivery_folder>\plugins folder:

 

Note that:

  • The Delivery folder is used by the CAST AIC Portal and the CAST Management Studio.

  • You only need to deploy one of the following plugins depending on the database in which the PeopleSoft source code is stored:

    • DB2: dmtcastpeoplesoftdb2extractor-1.0.dmtplugin
    • Oracle: dmtcastpeoplesoftoracleextractor-1.0.dmtplugin

Rename the file

  • Rename the file from "index for PeopleSoft customs.xml" to "index.xml"
  • If you already have an index.xml file in the <Delivery_folder>\plugins folder, then you will need to merge the contents of "index for PeopleSoft customs.xml" with the existing index.xml file: all four <entry> tags "index for PeopleSoft customs.xml" should be copied across to the existing index.xml file.

Enable or disable Oracle/DB2

  • If you are extracting PeopleSoft source code from an Oracle Server, then you do not need to do anything. By default the dmtcastpeoplesoftoracleextractor: is active.
  • If you are extracting PeopleSoft source code from a DB2 Server then you need to:
    • Place the <entry key="plugin.active.dmtcastpeoplesoftoracleextractor-1.0.0">true</entry> line in comment by adding <!-- and --> around it.
    • Remove the comments from the line <entry key="plugin.active.dmtcastpeoplesoftdb2extractor-1.0.0">true</entry>
  • Save the index.xml.
<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> 
<properties> 
<entry key="plugin.active.dmtcastpeoplesofttechno-1.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftextractor-1.0">true</entry> 
<entry key="plugin.active.dmtcastpeoplesoftoracleextractor-1.0">true</entry> 
<!--<entry key="plugin.active.dmtcastpeoplesoftdb2extractor-1.0">true</entry>--> 
</properties>

If your extension is provided as a Nuget file

For users of CAST AIP 8.x.x

There is nothing to do in this step.

For users of CAST AIP 7.3.x

  • The extension will have been downloaded to <CAST_installation_folder>\CustomPlugins (7.3.x). Browse to this location and locate the folder of the extension you downloaded.
  • In the folder you will find various sub-folders and files.
  • Please ensure that you complete the actions listed
FolderDescriptionRequired Action
  • com.castsoftware.peoplesoft/TOOLS/Plugins

 

Contains the CAST Delivery Manager Tool plugins (as folders) and the root index.xml file:

  • dmtcastpeoplesoftdb2extractor
  • dmtcastpeoplesoftextractor
  • dmtcastpeoplesoftoracleextractor
  • dmtcastpeoplesofttechno
  • index.xml

plugin folders

Copy/paste the four folders into the <Delivery_folder>\plugins folder.

index.xml

If an index.xml file EXISTS in the <Delivery_folder>\plugins folder:

  • Edit the file with a text editor and add in the the following lines within the existing <properties> tags:
<entry key="plugin.active.dmtcastpeoplesofttechno-1.0.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftextractor-1.0.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftoracleextractor-1.0.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftdb2extractor-1.0.0">true</entry>
Please ensure that the part after "active." matches the name of the plugin folders delivered in the extension, which have been copied into the <Delivery_folder>\plugins folder.
  • Finally, save the index.xml.

If an index.xml file DOES NOT EXIST in the <Delivery_folder>\plugins folder:

  • Copy/paste the index.xml file provided in the extension into the <Delivery_folder>\plugins folder.
  • Edit the file with a text editor and add in the the following lines within the existing <properties> tags:
<entry key="plugin.active.dmtcastpeoplesofttechno-1.0.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftextractor-1.0.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftoracleextractor-1.0.0">true</entry>
<entry key="plugin.active.dmtcastpeoplesoftdb2extractor-1.0.0">true</entry>
  • Finally, save the index.xml.

Step 3: CAST AIP database installation

Note that this step is valid regardless of the format in which your extension is delivered (archive or NuGet)

CAST recommends creating two "triplets" of CAST AIP databases to use specifically with your PeopleSoft analysis - one for the Project and one for the Vanilla. I.e. create two Analysis Platforms with three CAST databases each, via the "combined installation" option:

  • Management Base
  • Analysis Service
  • Dashboard Service

Here are some indicative schema sizes for a large PeopleSoft analysis (3.4 GB of source code):

Schema

Data

Index

Total

Management Schema

163 MB

-

163 MB

Dashboard Schema

1.5 GB

1.5 GB

3 GB

Project Analysis Database

7 GB

7 GB

14 GB

Vanilla Analysis Database

5 GB

6 GB

11 GB

Project

Use the "combined installation" to create the three CAST databases.

  • Run CAST Server Manager (ServMan.exe) and choose the "Schema Installation/Schema Installation… option on the toolbar.
  • In the wizard, choose Initial platform base(s) installation > Additional Analysis platform

  • In CAST AIP 8.x.x you will be prompted to choose the PeopleSoft extension to install (this screen will not be visible in CAST AIP 7.3.x but the extension will be installed automatically):

  • Set the database prefix (PSOFT5 for our example), and password (if asked), then continue the wizard process:

  • CAST Server Manager will install three CAST databases named as follows:
    • PSOFT5_LOCAL (CAST Project Analysis Service)
    • PSOFT5_CENTRAL (CAST Dashboard Service)
    • PSOFT5_MNGT (for the CAST Management Service)
  • The extension will be installed at the same time.

Vanilla

As with the installation of the CAST schemas for the Project, use the "combined installation" to create the three CAST databases.

  • Run CAST Server Manager (ServMan.exe) and choose the "Schema Installation/Schema Installation… option on the toolbar.
  • In the wizard, choose Initial platform base(s) installation > Additional Analysis platform
  • In CAST AIP 8.x.x you will be prompted to choose the PeopleSoft extension to install (this screen will not be visible in CAST AIP 7.3.x but the extension will be installed automatically)
  • Set the database prefix (PSOFT5_V for our example), and password (if asked), then continue the wizard process.

  • CAST Server Manager will install three CAST databases named as follows:
    • PSOFT5_V_LOCAL (CAST Project Analysis Service)
    • PSOFT5_V_CENTRAL (CAST Dashboard Service)
    • PSOFT5_V_MNGT (for the CAST Management).
  • The extension will be installed at the same time.