Coursedog maintains and releases occasional package upgrades to its standard PeopleSoft integration that institutions are recommended to install, in order to have the latest functionality, reliability enhancements, and general improvements.

This guide assumes the reader is an ITS administrator familiar with PeopleSoft Application Designer. The overall package upgrade process is similar to the Coursedog Peoplesoft Installation Guide, though for clients which already have the Coursedog packages installed, much quicker. There is no need to reset any Coursedog credentials or reconfigure any security and application settings, or any downtime expected. It is simply an in-place patch.

Package Upgrade Steps

Package upgrades include all previously delivered objects even if they have not changed. This ensures that you are brought completely up to date even if your institution missed an upgrade version.

Executing The Upgrade

1. Place the latest Coursedog package COURSEDOG_PEOPLESOFT_PACKAGES on a drive where PeopleTools Application Designer can access it.

   <aside> 💡

   NOTE: You should not re-import the COURSEDOG_PEOPLESOFT_NODE project, as this may reset any credentials or security grants you have granted Coursedog. This only needs to be installed once, and is covered by the initial install.

   </aside>

2. Open up Application Designer:

   • Tools → Copy Project →From File

     • If asked about replacing existing project, choose “Replace from File”

     

     • Make sure to “Select All” and check “Compile PeopleCode after Import”

     

3. Build and install the upgraded package

   1. NOTE: Without this step, the upgrade will not take effect
   • Application Designer: Build → Project. Make sure to check all “Build Options” and “Execute and build script”

   

4. Within SQLDeveloper, open up and run the SCRIPTS/C_READ_CONFIG.SQL and C_READ_CONFIG_CUSTOMIZATIONS.SQL (if present) to ensure we have the latest READ access permissions

   1. Similarly, within SQLDeveloper open up and run the SCRIPTS/C_WRITE_CONFIG.SQL and C_WRITE_CONFIG.CUSTOMIZATIONS.SQL (if present) to ensure we have the latest component interface access permissions
      • If you see C_WRITE_CONFIG.DAT rather than C_WRITE_CONFIG.SQL, expand this and follow these instructions
      • NOTE: If your PeopleSoft instance runs on MSSQL and not OracleDB, please run the .MSSQL scripts instead!

5. The upgrade is complete! Sometimes a package version may contain additional installation follow up instructions in its UPGRADE-NOTES.md

Confirming The Installation / What To Send Coursedog

Once all steps have been executed, there should not be anything else you need to do. However, it is helpful to confirm internally and with Coursedog the following information after an upgrade.

In particular, confirming the Web Services associated with our Coursedog credentials still exist are especially important:

• [ ] Screenshots of the CD_COURSEDOG Node Configuration

  • This may be found within (PeopleTools → Integration Broker → Integration Setup → Node Definitions) and searching for CD_COURSEDOG, or whatever the installed node setup in Configure Security and Data Access is named

  • This Node Password if it was not previously**.** Please make sure to communicate what the node password is to Coursedog, so we can update our systems.*

  • Make sure to include both the “Node Definitions” and “Routings” pages

    

    

• [ ] The Permission List Associated with this node definition (PeopleTools → Security → Permissions and Roles → Permission Lists) and searching for CD_COURSEDOG_NODE and sending a screenshots of

  • the Web Services “View Definition” window. Make sure everything says “Full Access”.
  • the Component Interfaces tab
    • Click through each of these and make sure they are all listed as “Full Access”

  

• [ ] The name of the "Default Local Node" in the target database. Oracle delivers "PSFT_CS" as the default, but this can be configured differently at each institution.

  • This may be found within (PeopleTools → Integration Broker → Integration Setup → Node Definitions) and returning “All Nodes”. Find the node name that has the “Default Local Node” set to “Y”.

• [ ] The External URL of the Test/Staging Campus Solutions Integration Broker

  • This is the URL Coursedog will hit when testing the staging integration, which should be completely separate the actual production PeopleSoft instance, if you’re following Coursedog’s recommendation. You can generally send a screenshot of PeopleTools → Integration Broker → Configuration → Gateways

    <aside> 💡

    This usually looks like https://[ib-host-name-in-external-dns]/PSIGW/HttpListeningConnector

    </aside>

• [ ] The External URL of the Production Campus Solutions Integration Broker

  • This is the URL Coursedog will hit when testing the production integration. You can generally send a screenshot of PeopleTools → Integration Broker → Configuration → Gateways

    <aside> 💡

    This usually looks like https://[ib-host-name-in-external-dns]/PSIGW/HttpListeningConnector

    </aside>

• [ ] The identifier of the Academic Institution(s) to integrate data for.

  • This is the Academic Institution that Coursedog will fetch data for. Usually it is just one, though multiple institutions are supported; this depends on what decisions were previously agreed upon by the institution when deciding to integrate with Coursedog.
  • You can generally send a screenshot of Set Up SACR → Foundation Tables → Academic Structure → Academic Institution Table, along with the “Academic Institution” identifier you want to integrate with Coursedog (e.g. “PSFRA” below)