DegreeWorks%20Technical%20Overview

1
DegreeWorksTechnicalOverview
2
PC Tools
3
Scribe
SureCode
Transit
4
PC Tool Architecture
Scribe
DegreeWorks Server
DAP08 Sockets Listener
DAP10 Application Server
SureCode
Transit
5
PC Tools Configuration

• .INI File
• Resides in \DegreeWorks\config.ini

Socket Config HostTitle1 InstitutionName
Production HostName1server.institutionName.edu Ho
stPort17701 HostTitle2InstitutionName Test
HostName2server.institutionName.edu HostPort2
7702
6
PC Tools Processes

• daprestart - Stops/starts dap processes
• dap08 DegreeWorks sockets listener server
• dap10 DegreeWorks server
• dapshow - Shows status of dap processes

7
Web Interface
8
Web Interface

9
Web Architecture
Web Browser
HTTP Web Server
DegreeWorks Server
WEB08 Sockets Listener
WEB09 Controller
CGI
Web Browser
Web Browser
WEB04 Scripter
DAP09 Application Server
UTL79 Search Server
10
Web Performance

• Specify number of web processes to run in
  /common/WEB09M03
• SERVERUTL79
• SERVERWEB04
• SERVERDAP09
• Load-test to determine best setting for your
  environment
• Perform a webrestart to trigger change

11
Web Processes

• webrestart - stops/starts web processes
• web08 Web sockets listener server
• web09 Web controller server
• web04 Web scripter
• utl79 Search server
• dap09 DegreeWorks application server
• webshow Shows status of web processes

12
Web Audit Generation

• On Demand
• Select Process New on Web
• Batch
• Create PDF worksheets
• Create printed output
• Create XML audits

13
Web Audit Generation

• Parallel Audit Configuration - DAP22
• Run simultaneous Batch Audit (DAP22)
• Set the DGWCPUCOUNT variable in dwenv.config to
  indicate number of CPUs on the server

14
Web Audit Generation

• On Demand Transit or Command Line
• Scheduled cron or at

15
Web Audit Generation

• Dynamic Refresh on Audit
• Banner data is refreshed when running an audit
• UCX-CFG020 REFRESH
• Timeout Setting
• Flag for each service
• Last Audit and Last Refresh timestamps updated

16
Web Localization

• Achieved by
• UCX Configuration
• User Authorization
• Web Customization
• CSS
• HTML
• XML/XSLT
• Images
• JavaScript
• Reference DGW_Technical_Guide document

17
Web Localization

• UCX Configuration
• DegreeWorks Configuration (UCX-CFG020 WEB)
• DegreeWorks Configuration (UCX-CFG020 WHATIF)
• DegreeWorks Configuration (UCX-CFG020 PLANNER)
• DegreeWorks Configuration (UCX-CFG020 SEARCH)
• Perform a webrestart to trigger change

18
Web Localization

• Reserved Words UCX-SYS001 Configuration -
  Literals
• Catalog Year Concentration
• College Credits
• Degree Discipline
• ID Level
• Major Minor
• Program School
• Status and more
• Some have been defaulted to match Banner
  terminology

19
Web Localization

• Literals - Student Context Area

20
Web Localization

• Literals What If

21
Web Localization

• Banner Related Literals
• Sort in SureCode by Note 1 column

22
Web Localization

• Web Related Literals
• Sort in SureCode by Note 2 column

23
Web Localization

• User Authorization
• common/SHPCFG add/remove feature access
• SDREFRES Key
• Perform a shpparse and webrestart to trigger
  change

24
Web Localization

• SHP Scripts
• Some web pages are housed as SHP scripts
• Standard scripts in app/shpscripts
• Localized scripts in local/shpscripts
• SHP scripts contain special operators
• Get an audit put it here
• Show only if user has permission
• Change content based on UCXD20 flags
• Perform a webrestart to trigger change

25
Web Localization

• XSL/XML
• DGW_Report.xsl
• Student View, Registrar Report, Graduation
  Checklist
• AuditSEP.xsl
• Planner Worksheet
• DGW_Registration.xsl
• Registration Checklist
• AuditExceptions.xsl
• Exception Worksheet

26
Web Localization

• XSL/XML continued
• AuditHD.xsl
• Diagnostics Audit please dont change
• AuditTranscript.xsl
• Class History
• RADData.xsl
• Student Data Report no need to change
• AuditDisclaimer.xml

27
Web Localization

• Web Customization
• Cascading Stylesheets
• DGW_Style.css
• Other files
• SD_HeaderFrame.html
• Images
• JavaScript rarely changed

28
Print/XML Localization

• Batch Audits
• Create PDF worksheets
• Create printed output
• Create XML audits

29
Print/XML Localization

• FOP (http//xml.apache.org/fop)
• Use stylesheet to define output layout
• Same stylesheet for PDF and printed output
• local/xsl/fopaudits.xsl
• admin/pdfreports
• admin/xmltrees
• Audit Report Formats UCX-RPT036 specifies name of
  xsl

30
Security
31
Security

• DegreeWorks comes with its own security database
  called SHPDB.
• In SHPDB, each user may have a shp_user_mst
  record that contains ID, Password, and access to
  services, defined in the user class.
• The shp_user_mst is created by the extract
• What is your portal? - Luminis? Self-service?
  Other?

32

• Multiple paths to Authentication
• DegreeWorks Native Authentication
• Self Service Banner Single Sign-On
• Luminis Single Sign-On
• Other Web Portal

33

• Luminis Single Sign-On
• From Luminis to DegreeWorks as Bookmark Channel
• Implemented using Generic Connector Framework
• Authentication by Proxy
• Luminis has the credentials and logs in
• DegreeWorks credentials are initially passed to
  Luminis through a mechanism during setup of new
  users
• Passwords are created in shp-user-mst
• Script unloads passwords to a file
• File of passwords is loaded into LDAP

34

• Self Service Banner Single Sign-On
• From SSB to DegreeWorks
• Trusted Relationship
• Validation of SSB Web Session ID
• User Role is passed to DegreeWorks
• Student ID passed to DegreeWorks
• Password in shp-user-mst is ignored
• Session ID is validated

35

• Authentication is Persistent for a session
• Once Authenticated, a Passport is stored in SHPDB
• IP Address is stored in SHPDB and will be matched
  later
• The Passport is used as a locater, not the Access
  ID

36

• DegreeWorks Native Authentication
• SHPDB Access ID and Access Code
  (UserID/Password)
• DegreeWorks Shepherd Security Database
• Encrypted Access Code (NIST hash) set by
  configuration
• Access Code is 64 bytes in DW 4.0.0
• Encryption is one-way cannot be decrypted
• Secured on the Webserver by HTTPS/SSL

37

• Changing DegreeWorks Password
• An administrator user may use the Admin tab in
  DegreeWorks to access the Change Password service
  to change a users password
• The changepassword script may also be used to
  change the password on the shp_user_mst from the
  command line
• For Banner Sites Only
• The Banner extract programs generate default
  passwords for each student, advisor and staff
  member processed. The password will be loaded
  with one of two forms
• (1) Password generated from custom SQL 
• (2) 10-byte random password

38

• A Change Password configuration flag exists in
  the UCX-CFG020 WEBPARAMS record
• If this flag is set to N then the
  shp_access_code on the shp_user_mst will not be
  changed by the Banner extracts, only added when
  the student, advisor or staff record is
  originally created

39
Security

• User Security
• Logon Authentication
• Checks User ID/Password against the shp_user_mst
  profile
• If Password matches User ID, user is granted
  access
• If Password does not match User ID, access is
  denied
• Service Authorization
• Grants access to services for which user has keys
• Denies access to services for which user does not
  have keys
• Service Software Feature
• Services require specific Key to unlock
  service for use

40
Security

• User Assigned
• User Class
• User Classes Assigned
• Groups
• Keys (services)
• Groups Assigned Services
• Keys (services)

41

• Services
• Each component of business functionality is a
  service
• Services may be broad (an entire web page or
  more) or narrow (a button which does something
  useful)
• Services are locked and keys are needed to access
  them

42

• Keys and Keyrings
• Each User has a Keyring with one or more keys
• Keyrings are stored in SHPDB
• Keys give access to Services
• When Users are authenticated, they acquire keys
  that are assigned via common/SHPCFG
• Groups
• A User Class will typically have a Group of Keys
  assigned
• Groups are stored in SHPDB
• A User will inherit the Group Keys from their
  User Class, which will be combined with other
  keys they may have

43
Security

• common/SHPCFG add/remove keys
• -- DegreeWorks keys for students
• if (DGWUSERCLASS "STU") then
• addgroup SRNSTU
• addkey SDSEPMOD modify the plan
• remkey SDPLNAUD
• -- DegreeWorks keys for advisors
• if (DGWUSERCLASS "ADV") then
• addgroup SRNADV
• -- DegreeWorks keys for advisors
• -- Allows to use exceptions
• If (DGWUSERCLASS ADVX)
• addgroup SRNADV
• -- DegreeWorks keys for administrators
• if (DGWUSERCLASS "REG") then
• addgroup SRNREG
• addkey SDREFRES Refesh button
• webrestart needed

44

• In Summary
• The Users Keyring is built at Authentication
• Keys are assigned via common/SHPCFG
• Keys may be added or removed
• The Users Keyring controls what Services are
  allowed
• Every Service has a lock, with a corresponding
  Key

45

• Database Configured Encryption
• DegreeWorks has tested with Oracle encryption
  enabled
• sqlnet.ora file controls this encryption
  configuration
• You may turn on Oracle encryption if desired

46
System Management
47
System Management

• Schedule nightly batch jobs
• PC Refresh (ucx12job)
• Updates PC Tools work files
• Extract students (bannerextract student)
• Updates DegreeWorks with all Banner student data
  changes
• Clean out log file directories (rmoldfiles)
• Start services (daprestart, webrestart)

48
System Management

• Logs
• Located in .../dgwspool or ../logdebug
  directories
• Email notification
• dwenv.config search for EMAIL
• configure email address lists used by
  DegreeWorks
• for job completion notifications
• export DAP16_EMAIL_ADDRESS
• export RAD11_EMAIL_ADDRESS
• export DAP21_EMAIL_ADDRESS
• export DAP22_EMAIL_ADDRESS
• export RAD30_EMAIL_ADDRESS
• Clean log directories with rmoldfiles
• /dw/app/scripts/rmoldfiles /dw/admin/dgwspool 15

49
System Management

• Log Format
• Action files
• ProcessNameA.act where is the
  ProcessName job number
• Log files
• ProcessNamexxxxL.log where is the
  ProcessName job number
• Example for RAD30
• rad30 A.act
• rad30 L.log

50
System Management

• Scripts (see DGW Technical Guide for complete
  list)
• dapblockunload, dapblockload
• daphits, dapreset
• rmoldfiles
• Review DGW Banner Considerations document

51
System Management

• Troubleshooting
• Use Student Data Report
• Use Diagnostics Report
• Clear web browser cache
• Try webrestart and daprestart
• Verify PC Refresh (ucx12job) is running nightly
• View dgwspool log files
• Use debugon / debugoff
• View logdebug/web.log
• View logdebug/dap10.log and dap08.log
• Send logdebug/.xml files to SunGard for analysis

52
System Management

• Processing Software Updates
• Release notes describe fixes and enhancements
• Subscribe to listserv to receive notification of
  patches
• Patches are inclusive (ex P03 includes P01 and
  P02)
• Current software is at level DW4.0.0
• Next release is DW4.0.1 scheduled for 2009

53
System Management

• Maintenance Schedule
• Daily
• Restart dap and web processes (webrestart/dapresta
  rt)
• Check daily Act and/or Log files
• Run PC Refresh (ucx12job)
• Database backup
• As needed tasks
• Process DegreeWorks software updates/patches
• Add DegreeWorks users
• Transfer blocks, UCX records between Test and
  Production
• Oracle Maintenance