Supplemental Data Engine

Presented by: Andy KearneyKimberly Saving-Sherman

SunGard Higher EducationG i S it 2011

Georgia Summit 2011 1

Georgia Summit 2011

Introduction - Supplemental Data Engine - Functional

• Supplemental Data Engine (‘SDE’) is a simple way to add data fields to Banner forms in Banner 8.0 without customization

• Today’s session will cover the terminology used for SDE and provide a step by step overview for setup and use of p p y p pSDE

2Georgia Summit 2011

Agenda - Supplemental Data Engine - Functional

• Overview • What is Supplemental Data Engine?• Why Use Supplemental Data Engine?• Supplemental Data Engine Terminology

• Set Up of Supplemental Data Engine• Add tables to GTVSDTB• Define Discriminators• Define Attributes• Generate DDL

• Use of Supplemental Data Engine• Add Supplemental Data• Where did the data actually go?• Attributes view• View raw data• Maintenance of Orphaned Records

3

• Question and Answer Session

Georgia Summit 2011

Overview of SDE

Georgia Summit 2011 4

Supplemental Data Engine – What is SDE?

Supplemental Data Engine is a simple way to add data fields to Banner forms in Banner 8.0 without customization

All d t t b t d th t i t t f i ti B D t M d l• Allows data to be stored that is not part of existing Banner Data Model

• New data is related to existing tables without altering the underlying database model

• New table stores all supplemental valuespp

• Provides upgrade independent additions and alterations

• Users can enter supplemental data from most forms that uses a database table where supplemental data rules have been defined (not views or BANSECR owned tables)

5

BANSECR owned tables)

Georgia Summit 2011

Why Use Supplemental Data Engine?

Supplemental Data Engine is the Solution to these Challenges:

• A student has four names but the Banner table will only allow threeA student has four names, but the Banner table will only allow three names to be stored.

• The institution wants to store multiple translations of a courseThe institution wants to store multiple translations of a course description, but the Banner table only allows one value to be entered for a course description.

• The institution wants to store comments on an address type but the form does not have a comment field.

• The institution wants to provide the name and contact information to• The institution wants to provide the name and contact information to users who may have questions on rules set up in Banner

• And many others…

6

y

Georgia Summit 2011

SDE Terminology - Supplemental Data Window

The user interface that is used to display, insert, update and delete Supplemental Data

7Georgia Summit 2011

SDE Terminology – Lightbulb Icon

Grey - SDE has not been enabled

Bright without rays SDE enabledBright without rays – SDE enabled but no data entered

Bright with rays – SDE enabled and data is present

8Georgia Summit 2011

SDE Terminology - Discriminator Codes and Methods

• Discriminator Codes are not necessary if only one row is permitted to be entered for a Supplemental Data Item

• Discriminator Codes may be used when defining Supplemental Data Attributes (not required)

Di i i t C d h i t d M th d• Discriminator Codes have associated Methods (Index, Select or User Defined)

• Methods control how the SDE window will behave when users areMethods control how the SDE window will behave when users are entering Supplemental Data

• Discriminator Codes determine the number of rows allowed to be t d f S l t l D t Itentered for a Supplemental Data Item

• Discriminator Codes may determine the prompt text displayed to users on the Supplemental Data Window (if %DISC% is used)

9

users on the Supplemental Data Window (if %DISC% is used)

Georgia Summit 2011

10Georgia Summit 2011

SDE Terminology - Supplemental Data Attributes GOASDMD

• Metadata (Data about Data)

• Determine Characteristics of Supplemental Data Values• Determine Characteristics of Supplemental Data Values

• Define How Supplemental Data Fields appear to user in SDE WindowSDE Window

• Define How Supplemental Data Values are stored in the tablestables

• Copy Attributes of Supplemental Data Items from one table to another

• Generate DDL for use in Self Service and Reports

11

• Apply DDL to database

Georgia Summit 2011

12Georgia Summit 2011

The Tables

• The are a few new tables:GOBSDCT stores views to be generatedGOBSDDC stores DiscriminatorsGOBSDDC stores DiscriminatorsGOBSDTB stores the SDE enabled Banner table namesGORSDAM stores Metadata (rules for data being extended)GORSDAV t th d t lGORSDAV stores the data valueGORSDDV stores user defined Discriminator values

13Georgia Summit 2011

GOBSDTB (SDE enabled Banner Tables)

GOBSDTB_TABLE_NAME NOT NULL VARCHAR2(30) -Primary KeyGOBSDTB_OWNER NOT NULL VARCHAR2(30) -Banner Table OwnerGOBSDTB ACTIVITY DATE NOT NULL DATE_ _GOBSDTB_USER_ID NOT NULL VARCHAR2(30)GOBSDTB_PK_DYNSQL VARCHAR2(2000) -Primary Key Dynamic SQLGOBSDTB_DATA_ORIGIN VARCHAR2(30)GOBSDTB_CREATE_SOURCE VARCHAR2(30)

14Georgia Summit 2011

GORSDAM (stores Metadata)

GORSDAM_TABLE_NAME NOT NULL VARCHAR2(30) -Primary KeyGORSDAM_ATTR_NAME NOT NULL VARCHAR2(30) -Primary KeyGORSDAM ATTR TYPE NOT NULL VARCHAR2(1) -S=Substitute, A=Add Attribute_ _GORSDAM_ATTR_ORDER NOT NULL NUMBER(3) -Display order of AttributesGORSDAM_ATTR_REQD_IND NOT NULL VARCHAR2(1) -Y/NGORSDAM_ATTR_DATA_TYPE NOT NULL VARCHAR2(30) -VARCHAR2,DATE,NUMBERGORSDAM_ATTR_PROMPT NOT NULL VARCHAR2(50) -Prompt to show on FormGORSDAM ACTIVITY DATE NOT NULL DATEGORSDAM_ACTIVITY_DATE NOT NULL DATEGORSDAM_USER_ID NOT NULL VARCHAR2(30)GORSDAM_ATTR_DATA_LEN NUMBER(8) -Size of the AttributeGORSDAM_ATTR_DATA_SCALE NUMBER(2) -Number of decimal placesGORSDAM_ATTR_INFO VARCHAR2(1024) -Default hint or help TextGORSDAM_ATTR_BASE_COL VARCHAR2(30) -BASE Column Substituted forGORSDAM_SDDC_CODE VARCHAR2(10) -Associated DiscriminatorGORSDAM_DATA_ORIGIN VARCHAR2(30)GORSDAM_CREATE_SOURCE VARCHAR2(30)

15Georgia Summit 2011

GORSDAV (stores the data value)

GORSDAV_TABLE_NAME NOT NULL VARCHAR2(30) -Primary KeyGORSDAV_ATTR_NAME NOT NULL VARCHAR2(30) -Primary KeyGORSDAV DISC NOT NULL VARCHAR2(64) -Primary Key_ y yGORSDAV_PK_PARENTTAB NOT NULL VARCHAR2(512) -Primary Key and

PK of the row in Parent TableGORSDAV_VALUE NOT NULL SYS.ANYDATA -Attribute data valueGORSDAV_ACTIVITY_DATE NOT NULL DATEGORSDAV USER ID NOT NULL VARCHAR2(30)GORSDAV_USER_ID NOT NULL VARCHAR2(30)GORSDAV_DATA_ORIGIN VARCHAR2(30)GORSDAV_CREATE_SOURCE VARCHAR2(30)

16Georgia Summit 2011

GORSDAV (stores the data value)

GORSDAV_TABLE_NAME NOT NULL VARCHAR2(30) -Primary KeyGORSDAV_ATTR_NAME NOT NULL VARCHAR2(30) -Primary KeyGORSDAV DISC NOT NULL VARCHAR2(64) -Primary Key_ y yGORSDAV_PK_PARENTTAB NOT NULL VARCHAR2(512) -Primary Key and

PK of the row in Parent TableGORSDAV_VALUE NOT NULL SYS.ANYDATA -Attribute data valueGORSDAV_ACTIVITY_DATE NOT NULL DATEGORSDAV USER ID NOT NULL VARCHAR2(30)GORSDAV_USER_ID NOT NULL VARCHAR2(30)GORSDAV_DATA_ORIGIN VARCHAR2(30)GORSDAV_CREATE_SOURCE VARCHAR2(30)

17Georgia Summit 2011

ANYDATA Type

• GORSDAV_VALUE is of type SYS.ANYDATA

• A column of this type• A column of this typeContains an instance of a given typeContains a description of the type (is self-describing)

• Specific to the initial release of SDE, ANYDATA may contain:contain:

VARCHAR2DATENUMERIC

18Georgia Summit 2011

Set Up of Supplemental Data Engine

Georgia Summit 2011 19

Step 1 - Identify Table on GTVSDTB

• GTVSDTB is the validation form which identifies all Tables which may have Supplemental DataTables which may have Supplemental Data

• Supplemental Data may not be added to any table until it is identified on this form

• Primary Key is shown for Table entered; if Table does• Primary Key is shown for Table entered; if Table does not have a primary key one can be entered

20Georgia Summit 2011

• Screen print

21Georgia Summit 2011

Step 1 – Add Table to GTVSDTB

Identify a form where you wish to add supplemental data

22Georgia Summit 2011

Step 1 – Add Table to GTVSDTB

• Determine what table is behind the field you’d like to add Supplemental Data to by putting your cursor in the field and choosing Help>Help (Item Properties)g ( )

23Georgia Summit 2011

Step 1 – Add Table to GTVSDTB

• Open GTVSDTB and query for your table• If it does not yet exist on GTVSDTB add it by doing a

record insert, typing in (or searching for) the table namerecord insert, typing in (or searching for) the table name and tabbing out of the table name

• The Description and Primary Key field will default inS h d it GTVSDTB• Save your changes and exit GTVSDTB

24Georgia Summit 2011

Step 2 – Define Discriminators (GOADISC)Step 2 Define Discriminators (GOADISC)

Enter a Discriminator Code (if needed)• Code will be used later when attributes are defined• Code will be used later when attributes are defined

Choose a Discriminator Method• Index• Select • User DefinedUser Defined

25Georgia Summit 2011

Step 2 – Define Discriminators (GOADISC)

Discriminator Methods - IndexSetup• Code - Unique and DescriptiveCode Unique and Descriptive • Description• Method - ‘Index’• Validation - maximum number of entries for an Attribute

(blank indicates no maximum)

Use• Use %DISC% in Prompt on GOASDMD to include

i t l b i S l t l D t Wi dincremental numbers in Supplemental Data Window (i.e. Comment 1, Comment 2, Comment 3)

26Georgia Summit 2011

Step 2 – Discriminator Method - Index

27Georgia Summit 2011

Step 2 – Define Discriminators (GOADISC)

Discriminator Method - SelectSetup• Code - Unique and DescriptiveCode Unique and Descriptive • Description• Method - ‘Select’

Validation• Validation Enter a valid SELECT statementEnter a valid table name and select the Edit buttonL fi ld t d l t Edit b tt f i dLeave field empty and select Edit button for wizard

Use%DISC% i P t GOASDMD ill di l th d i ti%DISC% in Prompt on GOASDMD will display the description values from the Select Statement (i.e. Comment in English, Comment in Spanish, Comment in Dutch)

28Georgia Summit 2011

Step 2 – Discriminator Method - Select

29Georgia Summit 2011

Step 2 – Discriminator Method - Select

30Georgia Summit 2011

Step 2 – Define Discriminators (GOADISC)

Discriminator Methods – User DefinedSetup

C d U i d D i ti• Code - Unique and Descriptive • Description• Method - ‘User Defined’• Validation

Select the Edit button or Next Block to Values Enter desired valuesEnter desired values

Use• %DISC% in Prompt on GOASDMD will display the description

user defined values (i e Contact Name Contact Email Contactuser defined values (i.e. Contact Name, Contact Email, Contact Phone Number)

31Georgia Summit 2011

Step 2 – Discriminator Methods – User Defined

32Georgia Summit 2011

Step 3 – Define Supplemental Data Attributes (GOASDMD)

Att ib tAttributes• Define how Supplemental Data is stored in the tables

Define how Supplemental Data Items will appear in• Define how Supplemental Data Items will appear in the Supplemental Data Window

Maintenance• Copy Attributes to Another Tablepy• Generate DDL and apply to database to create views

33Georgia Summit 2011

Step 3 – Define Supplemental Data Attributes (GOASDMD)Define how Supplemental Data is stored in theDefine how Supplemental Data is stored in the

tables• Sequence (also affects Supplemental Data Window)• Identifier• Add or Substitute data in a view• Data Type (Varchar2, Date or Number)Data Type (Varchar2, Date or Number)• Length (default 4000 varchar2, 22 number)• Precision (decimal places)

Base Column to Substitute (if Substitute is chosen)• Base Column to Substitute (if Substitute is chosen)

34Georgia Summit 2011

Step 3 – Define Supplemental Data Attributes (GOASDMD)

Define how Supplemental Data Items will appear in the Supplemental Data Window

P t• Prompt • Data Required Indicator• Hint Text• Discriminator• Discriminator

35Georgia Summit 2011

Example of multiple attributes for a table

36Georgia Summit 2011

Example of user defined discriminators

37Georgia Summit 2011

Results of multiple attributes for a table and their order

38Georgia Summit 2011

Step 3 – Define Supplemental Data Attributes (GOASDMD)

Maintenance• Copy Attributes to Another Table• Generate DDL and apply to database to create viewspp y

39Georgia Summit 2011

Step 3 – Define Supplemental Data AttributesA GOASDMD t t bl i th t bl• Access GOASDMD, type your table name in the table name field in the keyblock

• Next Block and complete, at least, the ‘Identifier’ and ‘Prompt’ fields

• Experiment with a variety of combinations of Data Action, Data Type, Length, Precision, Base Column,Action, Data Type, Length, Precision, Base Column, Prompt, Required Indicator, Hint Text and Discriminator

40Georgia Summit 2011

Step 4 - Generate DDL

• Access GOASDMD and type your table name in the keyblock

• Navigate to the ‘Generate DDL’ Tab

• Click the ‘Generate’ button, then click the ‘apply’ button

41Georgia Summit 2011

Use of Supplemental Data Engine

Georgia Summit 2011 42

Add Supplemental Data

• Open the form and navigate to the field where you wish to add Supplemental Data – notice that the SDE light bulb icon is now enabled

43Georgia Summit 2011

Add Supplemental Data• Click the lightbulb to open the SDE window enter a• Click the lightbulb to open the SDE window, enter a

comment and save – notice the lightbulb now has ‘rays’ indicating that data exists for this field.

44Georgia Summit 2011

Where did the data actually go? – Generate DDL

45Georgia Summit 2011

Where did the data actually go? – Apply DDL

46Georgia Summit 2011

Attributes View• Script generated by option on form GOASDMD• Script generated by option on form GOASDMD

Position cursor in ‘Generated DDL’ and press EDIT

47Georgia Summit 2011

Description of new view

48Georgia Summit 2011

View data from new view

49Georgia Summit 2011

View raw data

50Georgia Summit 2011

View raw data using SYS.ANYDATA methods

51Georgia Summit 2011

Maintenance of Orphaned Records

• If parent records are removed, any Supplemental Data associated with them remains in the database if trigger did not get properly appliedg y

• Run SDE Inquiry and Delete (GUSMDID) in Audit mode to review records

• Run SDE Inquiry and Delete (GUSMDID) in Update mode to remove orphaned recordsto e o e o p a ed eco ds

52Georgia Summit 2011

SDE Inquiry and Delete (GUSMDID)

53Georgia Summit 2011

SDE Inquiry and Delete (GUSMDID)

54Georgia Summit 2011

Summary

• Supplemental Data Engine (‘SDE’) is a simple way to add data fields to Banner forms in Banner 8.0 without customization

55Georgia Summit 2011

Questions & Answers

56Georgia Summit 2011

Thank You!

Andy KearneyA d K @ dhAndy.Kearney@sungardhe.com

Kimberly Saving-ShermanKimberly Saving-ShermanKimberly.Saving-Sherman@sungardhe.com

SunGard, the SunGard logo, Banner, Campus Pipeline, Luminis, PowerCAMPUS, Matrix, and Plus are trademarks or registered trademarks of SunGard Data Systems Inc or its subsidiaries in the U S and other countries Third party names and marks

57

trademarks of SunGard Data Systems Inc. or its subsidiaries in the U.S. and other countries. Third-party names and marks referenced herein are trademarks or registered trademarks of their respective owners.

© 2011 SunGard. All rights reserved.

Georgia Summit 2011