PeopleSoft 5.2 - Onboarding with CAST Imaging Console

Prerequisites

Step 1 - Repository extraction

The Vanilla and Project repositories must be extracted to .castextraction files using the CAST Database Extractor (which can be downloaded from https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.extractor.sqldatabase&version=latest) . A tailor made batch file provided in the PeopleSoft extension is available for running the offline extraction with the CAST Database Extractor - this should be used and can be found in the following location in the extension:

com.castsoftware.peoplesoft.<version>\TOOLS\OfflineExtraction\PeopleSoft-Extract-CLI.bat

This batch file will need modification BEFORE you run it - this is so that it can be tailored to the RDBMS on which your PeopleSoft repositories are hosted and which you want to extract - see the sections below.

Configure PeopleSoft-Extract-CLI.bat

Find the following sections in the batch file and modify them to match your environment:

RDBMS access parameters

Find the section rem Database parameters = Access to the database hosting the PeopleSoft repository:

PeopleSoft repository access parameters

Find the section rem PeopleSoft parameters = Access to the PeopleSoft repository:

Run the batch file

When you run the batch file on each PeopleSoft repository, the resulting output should be one .castextraction file for each repository, for example:

• PeopleSoftExtract_Vanilla.castextraction
• PeopleSoftExtract_Project.castextraction

These files need to be delivered to CAST Console - see below.

Batch file logging

The batch file will generate logs inside the folder defined in the parameter “ROOT_FOLDER”, as follows:

• a sub-folder “01_Results” that contains the extraction file (PeopleSoftExtract_Project.castextraction or PeopleSoftExtract_Vanilla.castextraction)
• a sub-folder “log” that contains the extraction log file (ExtractorLog_Project.log or ExtractorLog_Vanilla.log) and the execution file (Project.log or Vanilla.log)

The execution log file gives you the status of the execution:

Potential errors:

Step 2 - .PeoplesoftProject file configuration

Note that this file must be named with the exact same prefix as used for the Project repository .castextraction file, for example if you name the file PeopleSoftExtract_Project.PeoplesoftProject, the .castextraction file must be named PeopleSoftExtract_Project.castextraction.

The Project repository requires a .PeoplesoftProject configuration file that defines specific information required during the analysis:

• The name of the Vanilla Analysis schema (highly recommended) or the Vanilla Application name as defined in CAST Console
• Definition of PeopleSoft specific rule contextual parameters

Below is a template .PeoplesoftProject file - items in square brackets need to be manually defined:

<!-- The opening <PeoplesoftProjectConfig> element can define the [analysis_schema_name_in_console] (recommended) or the [application_name_in_console]. Whichever you choose, ensure that you use the correct attribute as shown below: -->

<PeoplesoftProjectConfig vanillaName="[analysis_schema_name_in_console]">
...
</PeoplesoftProjectConfig>

or

<PeoplesoftProjectConfig vanillaApplication="[application_name_in_console]">
...
</PeoplesoftProjectConfig>

<!-- In between the opening <PeoplesoftProjectConfig> element you should define the following: -->

<PeoplesoftProjectConfig ... >
    <PeopleSoftApplication name="[peoplesoft_app_name]" vanillaName="[app_name_in_vanilla]"/>
    <QualityRule id="[rule_id]">
        <Parameter name="[parameter_name]" value="[parameter_value]"/>
    </QualityRule>
    <QualityRuleGroup name="companyPrefix" active="[true_or_false]">
        <QualityRule id="[rule_id]" active="[true_or_false]">
            <Parameter name="[parameter_name]" value="[parameter_value]"/>
        </QualityRule>
    </QualityRuleGroup>
</PeoplesoftProjectConfig>

<PeoplesoftProjectConfig>

This opening tag is required and defines the Vanilla application as created in CAST Console. CAST highly recommends that you input the Analysis schema name where possible as this ensures that Peoplesoft extension does not need to perform a lookup based on the Application name, but you can use the Application name instead if necessary. Both are highlighted in the screenshot below and can be found in the CAST Console Admin Center.

Using the highlighted items shown in the example screenshot above, you can define either of the following:

<PeoplesoftProjectConfig vanillaName="peoplesoft_project_local">
...
</PeoplesoftProjectConfig>

or

<PeoplesoftProjectConfig vanillaApplication="PeopleSoft_Project">
...
</PeoplesoftProjectConfig>

<QualityRule> and <Parameter>

This section allows you to define the contextual parameters for specific PeopleSoft rules that will be triggered during the analysis, specifically to adapt them to your own environment. Use the tables below to create the entries you need. Note that if you DO NOT define an entry for a rule in the .project file, then the rule WILL be triggered during the analysis, but will use the default parameter values provided in the Assessment Model.

Multiple values, char: as they are related to naming convention, they must be adapted to the project:

Multiple values, char: as they are related to naming convention, they must be adapted to the project

Single value, numerical: As a first approach, you can stick to the default values

In the following example, we have changed two contextual parameters for the rule 1600184 (PeopleSoft: Avoid PeopleCode Event with High Cyclomatic), and one parameter value for the rule 1600384 (PeopleSoft: Naming convention on Language Record Table):

<QualityRule id="1600184">
    <Parameter name="PeopleSoft: Max CC in Event" values=" -999"/>
</QualityRule>
<QualityRule id="1600384">
    <Parameter name="Suffix PeopleSoft Language Record Table " value="Joe, William, Jack, Averell"/>
</QualityRule>

Step 3 - configure source code

You now need to configure the source code to deliver in CAST Console. There are two ways to deliver the source code, either in a ZIP file, or via a Source Folder Location :

Step 4 - create Version, deliver source code and run analysis/snapshot

For each Application (Vanilla and Project) that you have created in CAST Console, you need to now deliver the source code configured in Step 3 and run the analysis/snapshot. In CAST Console, the process can be done in small steps, or in one go.

It is very important that you run the analysis and snapshot for the Vanilla application BEFORE you run the analysis and snapshot for the Project application.

Step 5 - check results

When the snapshot has been completed for both repositories, CAST highly recommends that you check the results. For the analysis step, the following is an example of the messages that you could expect:

• PSOFT-000 Start
• PSOFT-001 Update metrics
• PSOFT-101 Error executing xxx
• PSOFT-002 Additional links
• PSOFT-102 Error executing xxx
• PSOFT-003 Discrimination data
• PSOFT-103 Error executing xxx
• PSOFT-100 Variable PSOFT_VANILLA_SCHEMA is not defined
• PSOFT-004 Import data from Vanilla schema: xxx
• PSOFT-104 Error while importing data from the Vanilla schema
• PSOFT-005 Discrimination computation
• PSOFT-105 Error executing xxx
• PSOFT-006 End