PeopleSoft Simple Web Services - Installation Documentation

This document will guide you through installing the SWS product.

General Notes

Most organizations have a migration flow starting in a dev environment that flows to production. Every organization does this slightly differently. For the purposes of this document we will assume that you have a development flow that looks like the following.

  1. Development
  2. Test
  3. Production

We recommend starting in a development environment first. Then follow your normal production migration procedure to push this to your production systems.

Download and Unzip the Software

  • You should have received a download link that contains the installation files in ZIP format.
  • Unzip the file in a location that is accessible to a developer that has Application Designer Access.

Import Project from File

When you first are importing into your development environment, you will import the delivered project from a file. For subsequent databases like test and production, you should use the standard PeopleSoft migration using “Project Copy to Database”.

  • Login to your development instance using application designer.
  • Import the project from file.
    • Inspect the upgrade windows to insure there were no errors or warnings.

Import Security Roles

This is technically an optional step to import our delivered security roles. If your organizations has a strict security standards you can create your own sets of permission and roles that adhere to your organizations security standards. This detail can generally be worked out when you migrate beyond development into your test and production environments. It is recommended for development that you installed the CHG roles to gain a working understanding of the product. The product user documentation (see related documents) has detail on the security requirements if you want to use your own security roles and permission lists.

Note: You will need to change the path in this script to match you environment

set LOG C:\temp\CHG_SWS_ROLE_IMPORT.LOG;
set INPUT C:\temp\CHG_SWS_ROLES.DAT;

IMPORT PSROLEDEFN;
IMPORT PSROLEDEFNLANG;
IMPORT PSROLECANGRANT;
IMPORT PSROLECLASS;
  • Ensure the script runs with no errors. The script output should resemble this:
Started:  Sun Dec  8 16:41:36 2019
Data Mover Release: 8.57.09
Database: CS92U015 (ENG)
Indexing export file C:\Users\chris_r_malek\Downloads\CHG_SWS_ROLES.DAT
Input file: C:\Users\chris_r_malek\Downloads\CHG_SWS_ROLES.DAT (ENG)
Commit done at end of record
Importing  PSROLEDEFN 
 Import  PSROLEDEFN  2
Input file: C:\Users\chris_r_malek\Downloads\CHG_SWS_ROLES.DAT (ENG)
Importing  PSROLEDEFNLANG 
 Import  PSROLEDEFNLANG  0
Input file: C:\Users\chris_r_malek\Downloads\CHG_SWS_ROLES.DAT (ENG)
Importing  PSROLECANGRANT 
 Import  PSROLECANGRANT  0
Input file: C:\Users\chris_r_malek\Downloads\CHG_SWS_ROLES.DAT (ENG)
Importing  PSROLECLASS 
 Import  PSROLECLASS  3
Ended: Sun Dec  8 16:41:36 2019
Successful completion
Script Completed.
  • Since we imported security with DMS, you will need to run the “Portal Security Sync” process.
    • PeopleTools - Portal - Portal Security Sync

Import Setup Data

The product comes with some configuration data to give some examples of working web services. These are mostly queries on basic PeopleTools tables that will exist in any PeopleSoft Application (Finance, Campus, HCM, etc). You are not required to import these configurations in your system. However, It is recommended for development that you installed the CHG roles to gain a working understanding of the product.

Note: You will need to change the path in this script to match you environment

SET LOG C:\temp\SAMPLE_DATA_IMPORT.LOG;
SET INPUT C:\temp\CHG_SWS_SAMPLE_DATA.DAT;
IMPORT C_SWS_CONF_PAR;
IMPORT C_SWS_CONF_PL;
IMPORT C_SWS_CONF_TBL;
IMPORT C_SWS_OUT_FLDS;

Grant Users Access

Now you need to grant Admin and API users access to the setup pages and API. Please see the Security Setup Section in the User Documentation

List of SWS Installed Objects

Below are the list of objects that will be imported.

Object Type Object Name
Record C_SWS_CONF_PAR
Record C_SWS_CONF_PL
Record C_SWS_CONF_TBL
Record C_SWS_OUT_FLDS
Record C_SWS_WORK
Field CHG_CACHE_MINUTES
Field CHG_DELETE_CONFIRM
Field CHG_DE_INCL_META
Field CHG_DE_OUT_FLDNAME
Field CHG_DE_PATH
Field CHG_ENCODING
Field CHG_MAX_LENGTH
Field CHG_PARAM_DFLT_VAL
Field CHG_PARM_NAME
Field CHG_PARM_SEQNO
Field CHG_PARM_TYPE
Field CHG_ROW_LIMIT
Translate CHG_ENCODING CSV 1901-01-01
Translate CHG_ENCODING JSON 1901-01-01
Translate CHG_ENCODING XML 1901-01-01
Translate CHG_PARM_TYPE H 1901-01-01
Page CHG_SWS_CONF_TBL
Page CHG_SWS_TEST
Menu CHG_TOOLS
Component CHG_SWS_CONF_TBL GBL
Record PeopleCode C_SWS_WORK SETUP FieldFormula
Role CHG_SWS_ADMIN
Role CHG_SWS_USER
Message Definition CHG_EXPORTER_PARAMS
Message Definition CHG_GENERIC
Message Definition CHG_SWS_PARAMS
Message Definition IB_REST_STUB
Page PeopleCode CHG_SWS_TEST Activate
Component PeopleCode CHG_SWS_CONF_TBL GBL PostBuild
Component PeopleCode CHG_SWS_CONF_TBL GBL PreBuild
Component PeopleCode CHG_SWS_CONF_TBL GBL SavePostChange
Component PeopleCode CHG_SWS_CONF_TBL GBL SavePreChange
Component Record PeopleCode CHG_SWS_CONF_TBL GBL C_SWS_CONF_PAR RowInit
Component Record PeopleCode CHG_SWS_CONF_TBL GBL C_SWS_CONF_TBL SearchInit
Component Record Field PeopleCode CHG_SWS_CONF_TBL GBL C_SWS_CONF_PAR CHG_PARM_TYPE FieldChange
Component Record Field PeopleCode CHG_SWS_CONF_TBL GBL C_SWS_CONF_TBL CHG_DE_PATH FieldChange
Component Record Field PeopleCode CHG_SWS_CONF_TBL GBL C_SWS_WORK COPY_PB FieldChange
Component Record Field PeopleCode CHG_SWS_CONF_TBL GBL C_SWS_WORK DELETE_PB FieldChange
HTML Catalog CHG_SWS_HTTP 4
Permission List CHG_SWS_ADMIN
Permission List CHG_SWS_USER
Portal Registry Structure EMPLOYEE C CHG_SWS_CONF_TBL
Portal Registry Structure EMPLOYEE F CHG_CUSTOM
URL Definitions CHG_SWS_DOCS
Application Package CHG_CONSTANTS CHG_CONSTANTS .
Application Package CHG_ENCODING_TOOLS CHG_ENCODING_TOOLS .
Application Package CHG_HTTP CHG_HTTP .
Application Package CHG_IB CHG_IB .
Application Package CHG_SWS CHG_SWS .
Application Package PeopleCode CHG_CONSTANTS http
Application Package PeopleCode CHG_ENCODING_TOOLS XMLToPsoft
Application Package PeopleCode CHG_ENCODING_TOOLS constants
Application Package PeopleCode CHG_ENCODING_TOOLS helper
Application Package PeopleCode CHG_ENCODING_TOOLS psoftToJSON
Application Package PeopleCode CHG_ENCODING_TOOLS psoftToXML
Application Package PeopleCode CHG_HTTP URLParser
Application Package PeopleCode CHG_IB IBRequest
Application Package PeopleCode CHG_IB IBResponse
Application Package PeopleCode CHG_SWS SQLRunner
Application Package PeopleCode CHG_SWS SWSOnRequestHandler
Application Package PeopleCode CHG_SWS constants
Service CHG_SWS
Service Operation CHG_SWS_GET
Service Operation Handler CHG_SWS_GET REQUESTHDLR
Service Operation Version CHG_SWS_GET v1
Service Operation Routing ~GENERATED~12273628 1900-01-01
Logical Schema CHG_SWS PARAMS V1
XML Schema CHG_SWS PARAMS V1 XML
Document Schema CHG_SWS PARAMS V1
Json Schema CHG_SWS PARAMS V1 JSON
Html Schema CHG_SWS PARAMS V1 HTML