Chapter 1:Developing An Application
In this chapter, you will learn how to create and modify PeopleSoft definitions using the Application Designer.
Chapter ObjectivesThis chapter teaches you how to:
Create a Project
Define a Field Definition
Create a Record Definition
Build SQL Tables
Create a Page Definition
Create a Component Definition
Chapter ContentsThis chapter contains the following lessons:
Lesson 1: Creating a Project.....................................................................2
Lesson 2: Creating a Field Definition.........................................................6
Lesson 3: Creating a Record Definition...................................................10
Lesson 4: Building an SQL Tables..........................................................13
Exercise 4-1: Create an SQL Table.........................................................18
Lesson 5: Creating a Page Definition......................................................20
Exercise 5-1: Creating a Page Definition.................................................31
Lesson 6: Creating a Component Definition............................................32
04/28/23 1-1
Chapter 1: Developing An Application Developing An Application
Lesson 1:Creating a Project
The Project Window of the Application Designer is a graphical representation of the definitions within PeopleSoft. While creating a project is not a required step in development, it is useful in organizing definitions as you configure and develop in the application.
Using projects will help:
Organize related definitions
Show definition relationships
Manage developer’s work
Simplify upgrade task
1-2 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Project Window
Definition Workspace
Output Window
Developing An Application Chapter 1: Developing An Application
Project SettingsBefore beginning to save PeopleSoft object definitions into a project, it is a good idea to check the following settings.
From the Application Designer Menu click Tools Options(These settings only need to be done once in App Designer)
From the Application Designer Menu File Project Properties
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-3and Arizona State University
To keep from missing
definitions during migrations, it is
best to have objects
automatically insert upon
changes.
Adding a description
and comments to the project
greatly help during upgrades
in determining customizations
to bring forward.
To automatically load your last project at
startup of App Designer
Chapter 1: Developing An Application Developing An Application
Practice – Creating a project
Access the application designer.
To create a new project:1. Click File.
2. Click New3. Click Project
4. Click
The project window should look like this.
1-4 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Developing An Application Chapter 1: Developing An Application
5. Click File6. Click Project Properties
Add descriptions and comments
7. Click
8. Click File9. Click Save Project As
10. Type in Project Name (ASU_JGS_PROJ)
11. Click
Project Window should reflect the new project name.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-5and Arizona State University
Project names should be preceded with
ASU_ to make them easily identified during an upgrade
process
Chapter 1: Developing An Application Developing An Application
Lesson 2:Creating a Field Definition
Field definitions represent a column in a table or view. These are stand alone development definitions that can be used in multiple record definitions. A change to a field definition will be effected in any record definition it participates.
This is a partial example of the Personal Data table:
Personal Data Table
EMPLID COUNTRY_NM_FORMAT NAME NAME INITIALS
NAME PREFIX
SA0001 USA Prince,Nathan NP Mr
SA0002 USA Norman,Bruce BN
SA0003 USA Kuhn,Tricia G TK Miss
SA0004 USA Rocha,Juan JR Mr
This is a partial example of the Address table:
Address table
EMPLID ADDRESS_TYPE ADDRESS1
SA0001 HOME 1359 First St.
SA0001 WORK 1207 Monroe
SA0003 HOME 1153 Randolph
SA0004 HOME 1269 Moundview
Type of attributes to a field definition include:
Data Type
1-6 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Change to EMPLID field definition would change it for both tables
Developing An Application Chapter 1: Developing An Application
Field Name
Field Length
Long Name
Short Name
Formatting
Translate Values A PeopleSoft supplied translate table is used as a prompt table on certain fields that don’t need individual tables for prompt values. Normally, a change to the values is requested and then made by a developer. Values from the translate table should be used if the following criteria is met on a field:
Field type is character
Field length is 1 to 4 characters
The set of values is static and not maintained by the users
No other fields relate to this field
A fields prompt values are not Y/N
If a field does not display these characteristics and needs a prompt validation, a separate prompt table should be constructed. To see a field’s translate values, make the field definition active, choose File, Definition Properties, Translate Values tab.
Example of the Translate table
Field: ACADEMIC_LOAD
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-7and Arizona State University
Chapter 1: Developing An Application Developing An Application
Practice – Creating a field definition
Access the application designer.
To create a new field definition:1. Click File.
2. Click New3. Click Field
1-8 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
ACADEMIC_LOAD holds only 6 distinct values (F,H,L,N,P,T) but it is able to display the translate descriptions of the Long or Short names.
Developing An Application Chapter 1: Developing An Application
4. Click
A new character field opens in the workspace area.
5. Fill in the Field attributes
Enter the Field Description.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-9and Arizona State University
CharacterLong Character
NumberSigned Number
DateTime
DateTimeEtc.
UpperCaseMixedCase
NameSSNEtc.
Multiple labels allow the field to be used
on more than one page and have differing labels.
Check which label is default.
Enter a Field Description by:
Definition Properties Button
Or File/Definition Properties
Or Right Click in the Definition Window
Chapter 1: Developing An Application Developing An Application
6. Click
7. Click File8. Click Save
Type Field Definition Name
9. Click
Changing an existing field definition does not change the underlying SQL table in the database until after the build process.
1-10 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Field definition names
should be preceded with ASU_ to make
them easily identified during an upgrade
process
Developing An Application Chapter 1: Developing An Application
Lesson 3:Creating a Record Definition
Field definitions are grouped together to create a record definition. The record definition is a representation of how the underlying SQL database table will be built in the database and how it processes.
On the toolbar there are four buttons that will change the view of the record definition.
Button Type Description
Field DisplayName Length, Format, Short
Name, Long Name
Use DisplayKey related
attributes, default values
Edits Display Edit Options
PeopleCode Display Fields with PeopleCode
Practice – Creating a Record Definition
Access the application designer.
To create a new record definition:1. Click File2. Click New3. Click Record
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-11and Arizona State University
Chapter 1: Developing An Application Developing An Application
4. Click
The object workspace appears so that you can build a list of fields in a record definition.
5. Select tab and choose Record Type
6. Insert Fields into the Record Definition
1-12 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
SQL Table is the default
selection and the only one that
creates a database structure capable of housing application
data.
Insert field definition by Insert/Field
Or drag and drop field in project
Or drag and drop field from record
definition in project
All table names are created in
the database with a prefix PS_
Entering a Non-Standard SQL Table Name overrides that.
However, due to upgrade issues, it
should be used with caution.
Developing An Application Chapter 1: Developing An Application
7. Click File8. Click Save
Type Record Definition Name
9. Click
Creating or changing a record definition does not affect the underlying SQL table in the database until after the build process.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-13and Arizona State University
Record definition names
should be preceded with ASU_ to make
them easily identified during an upgrade
process
Chapter 1: Developing An Application Developing An Application
Lesson 4:Build SQL Tables
Field and record definitions are simply blueprints on how a table is to be built in the database. Until the build process is run for the record definition there is no physical database table in which to house the application data.
The build process also has the ability to alter the table structure in the database should a change to an existing field or record definition occur. This allows changes to an existing database table without losing the data that is in the table.
1-14 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Build Current Project
Or
Build Current Object
Developing An Application Chapter 1: Developing An Application
Build Settings
The scope of the build is reflected in the scrolling window. This has the entire scope of the records in a project, whereas building only the current object in the definition window would have simply one record.
To check build settings:
Click
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-15and Arizona State University
Chapter 1: Developing An Application Developing An Application
1-16 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Always check this setting before creating
tables. If set to recreate and the table exist
DATA WILL BE LOST!
Drop
and/or Truncate could result in lost
data.
Developing An Application Chapter 1: Developing An Application
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-17and Arizona State University
Chapter 1: Developing An Application Developing An Application
Practice – Building an SQL Table
Open a Record Definition in Application Designer.
To Build an SQL Table:1. Click Build or Build Button2. Click Current Definitions
3. Check Create Tables & Create Indexes & Create Views
4. Click
5. Check Output Window for Errors
6. Verify Record was created.
1-18 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Normally, you’d want to Build script file
with the commands to build the table to let the database
administrator create the table in the database.
Developing An Application Chapter 1: Developing An Application
Exercise 4-1: Create an SQL TableIn this exercise, you will create an SQL Table.
InstructionsCreate an SQL table that tracks an employee’s car license plate to a valid lot number. An employee can be eligible to park their car in more than one lot.
There are four lots
1. North Lot
2. South Lot
3. East Lot
4. West Lot
Within each lot is different level of parking:
Standard
Handicapped
Valet
Include the following fields:
EMPLID
XXX_LIC_PLATE
XXX_LOT_NBR
XXX_PARK_LEVEL
Save the table as XXX_ASU_PARKING.
Give any new field and/or record definitions a description
Save all object changes to a project as ASU_XXX_PARK
Build the SQL Table
Verify the database table
Hints What fields are going to make the record unique?
Use existing fields where appropriate.
License Plates can be a combination of numbers and letters
In order to save database space the Lot number field should only take up one character but be able to display the character name.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-19and Arizona State University
XXX=user initials
Chapter 1: Developing An Application Developing An Application
Start a new project and save before beginning object modifications. Make sure to check settings so objects automatically save into your project.
1-20 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Developing An Application Chapter 1: Developing An Application
Lesson 5:Creating A Page Definition
The page interfaces between the user and the application database. It is used to make the application data accessible for viewing and maintaining.
Level-Based ControlsThe page design is a level-based construct in order to display parent-child relationship between the database records.
A page can display up to 4 nested levels – Level 0, Level 1, Level 2, and Level 3.
Level 0Level 0 contains the primary keys to the underlying record of the page is normally display only with data the users entered on the search page.
Level 1-3The subsequent scrollable level is related to the previous scroll level and related by their key values. These scroll levels will be displayed by one of the following page controls:
Grid
Scroll Area
Scroll Bar
Page Definition ToolbarThe page definition toolbar is used to act upon the definition of the page itself. The following buttons will work when there is an active page in the work area.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-21and Arizona State University
Level 0
(Parent)
Level 1
(Child)
Chapter 1: Developing An Application Developing An Application
Button Type Alternative Description
Page Properties Alt+Enter Page Description, Page Type, Page Size, etc.
Hide/Display Project Workspace
View, Project Workspace Or
Alt+0Hides Project Workspace
Select Group Edit, Select Group Or Ctrl+P Select a group of page items
Default OrderingLayout, Default
Ordering Reorder all page controls based on page location
Test Page Layout, Test Mode Or Ctrl-T Test tab order of page design
Browser Button Layout, View in Browser How the page looks in the browser
Toggle Inspector View, Show Page Control Inspector Hide/unhide Floating definition window
Auto Size Size subpage or secondary page around page controls
Toggle Grid View, Show Grid Or Ctrl-G Display/hide the page grid
Left Label Button Layout, Left Label Position Or Ctrl-D
Position label for currently selected page control to the left of control item.
Various Alignment Buttons Align select page fields
Show Help View Page Definition help
Page ControlsPage controls can be added from the toolbar buttons, Insert menu item, or alternate keystroke when page is active in window.
Button Type Alternate Keystroke Description
Frame F Draws a frame around page controls
Group Box B Draws a group box with a header
Horizontal Rule
N Draws a line on a page
Static Text X Add static text
Grid Tab Seperator
AAdd a tab into a grid structure
Check BoxC
Check box (used with fields with finite values)
Drop Down List Box
DDrop Down List box (used on fields with translate values)
1-22 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Developing An Application Chapter 1: Developing An Application
Button Type Alternate Keystroke Description
Edit Box E Edit box (used for entering/displaying record fields)
HTML Box H Adds a box to put HTML Code
Image I Add an Image
Long Edit Box L Allows entering of longer record fields
Push Button/ Hyperlink
P Adds a push button/hyperlink (gives ability to put PeopleCode for processing on a page)
Radio Button R Adds a Radio button (used for fields with finite values)
Tree T Adds a tree structure
Grid G Adds a scrollable area in grid form to establish a new level record
Scroll Area S Adds a scrollable area with a frame to establish a new level record
Scroll Bar O Adds a scroll bar with no framework to establish a new level record.
Secondary Page
Y Add a secondary page
SubPage U Add a SubPage
Chart Q Add a Chart
Practice – Creating a Page Definition
Access the application designer.
To create a new page definition:1. Click File2. Click New3. Click Page
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-23and Arizona State University
Chapter 1: Developing An Application Developing An Application
4. Click
The object workspace appears with a new page layout to build a page definition.
5. Add Page Controls for Level 0
1-24 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Developing An Application Chapter 1: Developing An Application
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-25and Arizona State University
Add controls such as Edit boxes by drag/drop
record fields in project.
Chapter 1: Developing An Application Developing An Application
1-26 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Add controls such as
Edit boxes by Insert, Edit Boxes
lets you place a dummy name
field.
Double Click on the edit box
brings up the Properties Box
for that page control
Developing An Application Chapter 1: Developing An Application
6. Fill in Edit Box Properties
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-27and Arizona State University
Establish Record and Field Name for the data that should display on page
Other options that determine how the Edit Box will function
Chapter 1: Developing An Application Developing An Application
Add Label to the Edit Box:
7. Click
1-28 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
The Use tab on the properties box has all the options on how the field will function on the page
Generally, any key field on Level 0 will be set to Display Only
since it is populated from the search record.
Developing An Application Chapter 1: Developing An Application
8. Add a scrollable level 1 control
Double Click on the Grid Area will bring up the Grid Properties Box
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-29and Arizona State University
Chapter 1: Developing An Application Developing An Application
9. Add Fields to the Scrollable Level
1-30 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
Determines main table of the scroll area.
Determines Level Number
Determines number of records to initially fill the
scroll area.
Make scroll area active and Insert page control to add a dummy field.
Or
Drag/Drop fields from Project Area
Developing An Application Chapter 1: Developing An Application
10. Click on the Order tab to see the level structure
11. Click or File, SaveType Page Definition Name
12. Click
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-31and Arizona State University
Page definition names
should be preceded with ASU_ to make
them easily identified during an upgrade
process
Chapter 1: Developing An Application Developing An Application
Exercise 5-2: Create A Page DefinitionIn this exercise, you will create a Page Definition.
InstructionsCreate a Page Definition to display the employee’s cars that are eligible to park in the campus parking lots.
Display the following information:
Employee Id
Employee Name
Car License Plate
Parking Lot
Save the Page Definition as XXX_ASU_PARKING.
Display Parking Lot with its character name.
Verify the database table
Hints Use existing fields where appropriate.
License Plates can be a combination of numbers and letters
In order to save database space, the lot number field should only take up one character but be able to display the character name.
1-32 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
XXX=user initials
Developing An Application Chapter 1: Developing An Application
Lesson 6:Creating A Component Definition
The component definition is the representation of a logical business transaction. It will contain related pages that should be processed together. The pages of a component should be designed to share the same search record.
There are two tabs for viewing a component – definition and structure.
Definition TabThe component definition view displays all the page items and component attributes.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-33and Arizona State University
The component definition window will reveal the collection of pages that are associated with the component. Each tab represents a page definition.
Chapter 1: Developing An Application Developing An Application
Structure TabThe component structure shows records and scrolls in a tree representation. It provides information about page levels and component records and their roles. You can double-click the objects in this view to open their definitions.
Practice – Creating a Component Definition
Access the application designer.
To create a new component definition:1. Click File2. Click New3. Click ComponentThe object workspace appears so that you can build a collection of pages in the component definition.
1-34 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University
The component structure window will reveal the structure of the buffer as well as PeopleCode that is associated with records and fields.
indicates there is PeopleCode associated with the record.
Developing An Application Chapter 1: Developing An Application
4. Insert Pages into the Component definition.
04/28/23 Proprietary and Confidential to CedarCrestone, Inc. 1-35and Arizona State University
Pages can also be inserted into the component using the Drag and Drop method using pages involved in the project definition.
Chapter 1: Developing An Application Developing An Application
5. Click File, Save or
Type Component Definition Name
6. Click
1-36 Proprietary and Confidential to CedarCrestone, Inc. 04/28/23and Arizona State University