resource 25/schedule 25 interfaces - home | uconn health · using this manual 2...

58
Resource25/Schedule25 Interfaces 1 Index Resource 25/Schedule 25 Interfaces Technical Manual

Upload: others

Post on 13-Jul-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 1 Index

Resource 25/Schedule 25 Interfaces

Technical Manual

Page 2: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Copyright (c) 2001 Jenzabar, Inc. All rights reserved. You may print any part or the whole of this documentation to support installations of Jenzabar software.Where the documentation is available in an electronic format such as PDF or online help, you may storecopies with your Jenzabar software. You may also modify the documentation to reflect your institution'susage and standards. Permission to print, store, or modify copies in no way affects ownership of thedocumentation; however, Jenzabar, Inc. assumes no responsibility for any changes you make.

Filename: tmrs25Distribution date: 11/13/1998

Contact us at www.jenzabar.com

Jenzabar CX and QuickMate are trademarks of Jenzabar, Inc.INFORMIX, PERFORM, and ACE are registered trademarks of the IBM CorporationImpromptu, PowerPlay, Scenario, and Cognos are registered trademarks of the Cognos CorporationUNIX is a registered trademark in the USA and other countries, licensed exclusively through X/Open Company LimitedWindows is a registered trademark of the Microsoft CorporationAll other brand and product names are trademarks of their respective companies

Page 3: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

i

JENZABAR, INC.RESOURCE25/SCHEDULE25 INTERFACES TECHNICAL MANUAL

TABLE OF CONTENTS

SECTION 1 – USING THIS MANUAL.......................................................................................................... 1

Overview..................................................................................................................................................... 1Purpose of This Manual.......................................................................................................................... 1Intended Audience.................................................................................................................................. 1How to Use This Manual ........................................................................................................................ 1Structure of This Manual ........................................................................................................................ 1Related Documents and Help ................................................................................................................ 2

Conventions Used in This Manual.............................................................................................................. 2Introduction............................................................................................................................................. 2Style Conventions................................................................................................................................... 2Jenzabar-Specific Terms........................................................................................................................ 3Keystrokes.............................................................................................................................................. 3

SECTION 2 – INTERFACE PROCESSES................................................................................................... 5

Overview..................................................................................................................................................... 5Introduction............................................................................................................................................. 5Purpose of Products ............................................................................................................................... 5Background Knowledge.......................................................................................................................... 5

Process Flow .............................................................................................................................................. 6Process Description................................................................................................................................ 6

Application Relationships ........................................................................................................................... 7Related Jenzabar CX Applications......................................................................................................... 7

Creation of Campus Profile ........................................................................................................................ 7Introduction............................................................................................................................................. 7Departments File (depts.dat) .................................................................................................................. 8Space Categories/Partitions File (part.dat) ............................................................................................ 8Space Records File (rooms.dat)............................................................................................................. 8Physical Features File (phys.dat) ........................................................................................................... 9

Resource25 ................................................................................................................................................ 9Overview of the Resource25 Interface ................................................................................................... 9Event Hierarchy .................................................................................................................................... 10Exporting the Campus Profile............................................................................................................... 10Exporting Meetings - Batch .................................................................................................................. 10Exporting Meetings - Singular .............................................................................................................. 11Importing Room Assignments .............................................................................................................. 11Checking Resource25 Conflicts in Course Entry ................................................................................. 11

Schedule25............................................................................................................................................... 12Overview of the Schedule25 Interface ................................................................................................. 12Exporting the Campus Profile............................................................................................................... 12Exporting Meetings............................................................................................................................... 12Importing Room Assignments .............................................................................................................. 13

SECTION 3 – INTERFACE TABLES AND RECORDS............................................................................. 15

Overview................................................................................................................................................... 15Introduction........................................................................................................................................... 15Alphabetical Organization..................................................................................................................... 15What Is an SQL Table? ........................................................................................................................ 15What Is a Jenzabar CX Table? ............................................................................................................ 15What Is a Jenzabar CX Record?.......................................................................................................... 15

Summary List of Tables and Records Used............................................................................................. 16

Page 4: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

ii

Introduction........................................................................................................................................... 16Impact of Changes to Tables and Records.......................................................................................... 16Common Tables and Records.............................................................................................................. 16Shared Tables and Records................................................................................................................. 16Resource25/Schedule25 Interfaces Tables and Records.................................................................... 16Required Tables and Records.............................................................................................................. 16

Schemas................................................................................................................................................... 17Introduction........................................................................................................................................... 17File Naming Conventions ..................................................................................................................... 17Field Descriptions ................................................................................................................................. 17

Schema File Reports ................................................................................................................................ 17Introduction........................................................................................................................................... 17Report Locations .................................................................................................................................. 17Report Descriptions .............................................................................................................................. 17

Tables and Records ................................................................................................................................. 18Table and Record Information.............................................................................................................. 18

SECTION 4 – RESOURCE25/SCHEDULE25 MACROS AND INCLUDES.............................................. 19

Overview................................................................................................................................................... 19Introduction........................................................................................................................................... 19Relationship Among Macros, Includes, and C Programs .................................................................... 19General Installation Procedures ........................................................................................................... 19

Macros...................................................................................................................................................... 19Introduction........................................................................................................................................... 19Definition and Function......................................................................................................................... 19How to Locate Macros.......................................................................................................................... 21Applocate Program............................................................................................................................... 21Macros that Control Features............................................................................................................... 21

SECTION 5 – COURSE ENTRY ................................................................................................................ 23

Overview................................................................................................................................................... 23Introduction........................................................................................................................................... 23

How Course Entry Interfaces with Resource25/Schedule25 ................................................................... 23Summary .............................................................................................................................................. 23Course Entry Program Parameters ...................................................................................................... 23Conflict Checking.................................................................................................................................. 23Creation of the Resource25 Export File ............................................................................................... 24

SECTION 6 – MENUS, SCREENS, AND SCRIPTS.................................................................................. 25

Overview................................................................................................................................................... 25Introduction........................................................................................................................................... 25Directory Locations............................................................................................................................... 25

Menu Options ........................................................................................................................................... 25Programs, Screens, and Scripts........................................................................................................... 25

Perl Scripts ............................................................................................................................................... 27Introduction........................................................................................................................................... 27Perl Scripts ........................................................................................................................................... 27

SECTION 7 – SETTING UP THE INTERFACES ....................................................................................... 29

Overview................................................................................................................................................... 29Introduction........................................................................................................................................... 29Basic Information.................................................................................................................................. 29

Setting Up the Resource25 Interface ....................................................................................................... 29Introduction........................................................................................................................................... 29Resource25 Checklist........................................................................................................................... 29Step 1 - Creating a Database for Resource25 ..................................................................................... 31

Page 5: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

iii

Step 2 - Creating a UNIX r25 Directory ................................................................................................ 31Step 3 - Mapping the r25 Directory as a PC Network Drive (Optional)................................................ 31Step 4 - Editing Macros ........................................................................................................................ 31Step 5 - Configuring Resource25 ......................................................................................................... 33Step 6 - Setting Up a Data Service for Resource25 Database Access ............................................... 34Step 7 - Exporting Campus Profile Files from Jenzabar CX ................................................................ 34Step 8 - Moving Campus Profile Files to the r25/s25/import Directory ................................................ 35Step 9 - Importing Campus Profile Files into Resource25 ................................................................... 35Step 10 - Adding Room Features and Preferences (Optional) ............................................................ 35Step 11 - Exporting Meetings for a Session from Jenzabar CX........................................................... 35Step 12 - Importing Meeting Events into Resource25.......................................................................... 36Step 13 - Performing Room Assignments in Resource25 (Optional)................................................... 36Step 14 - Publishing Meeting Events for Which Room Assignments Were Made from Resource25.. 36Step 15 - Importing Room Assignments into Jenzabar CX.................................................................. 36Step 16 - Turning on Resource25 Event Conflict Checking and Change Notification in crsent .......... 37Step 17 - Importing Changes into Resource25 .................................................................................... 37

Setting Up the Schedule25 Interface........................................................................................................ 38Introduction........................................................................................................................................... 38Schedule25 Checklist ........................................................................................................................... 38Step 1 - Editing Macros ........................................................................................................................ 38Step 2 - Editing the ctrl.dat File ............................................................................................................ 39Step 3 - Exporting Campus Profile Files from Jenzabar CX ................................................................ 40Step 4 - Exporting Meetings for a Session from Jenzabar CX............................................................. 40Step 5 - Editing Files to Add New Physical Features or Preferences (Optional) ................................. 41Step 6 - Moving Campus Profile Files (Optional) ................................................................................. 41Step 7 - Running the Schedule25 Optimizer........................................................................................ 41Step 8 - Moving sortrm.dat (Optional) .................................................................................................. 41Step 9 - Importing Room Assignments into Jenzabar CX.................................................................... 41

SECTION 8 – USING THE RESOURCE25/SCHEDULE25 INTERFACES SCREENS ............................ 43

Overview................................................................................................................................................... 43Introduction........................................................................................................................................... 43Organization ......................................................................................................................................... 43Screen Differences ............................................................................................................................... 43

Export Campus Profile Files Screen ........................................................................................................ 43Purpose ................................................................................................................................................ 43Access .................................................................................................................................................. 43Example................................................................................................................................................ 44Fields .................................................................................................................................................... 44Commands ........................................................................................................................................... 44

Export Meetings to Resource25 Screen .................................................................................................. 45Purpose ................................................................................................................................................ 45Access .................................................................................................................................................. 45Example................................................................................................................................................ 45Fields .................................................................................................................................................... 46Commands ........................................................................................................................................... 46

Export Meetings to Schedule25 Screen................................................................................................... 46Purpose ................................................................................................................................................ 46Access .................................................................................................................................................. 46Example................................................................................................................................................ 47Fields .................................................................................................................................................... 47Commands ........................................................................................................................................... 47

Import Room Assignments Screen........................................................................................................... 48Purpose ................................................................................................................................................ 48Access .................................................................................................................................................. 48Example................................................................................................................................................ 48

Page 6: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

iv

Fields .................................................................................................................................................... 49Commands ........................................................................................................................................... 49

Import Room Assignments from Resource25 Screen.............................................................................. 49Purpose ................................................................................................................................................ 49Access .................................................................................................................................................. 49Example................................................................................................................................................ 50Fields .................................................................................................................................................... 50Commands ........................................................................................................................................... 50

INDEX ......................................................................................................................................................... 51

Page 7: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 1 Using This Manual

SECTION 1 – USING THIS MANUAL

Overview

Purpose of This Manual

This manual provides technical information required to provide an interface between CX and theResource25 and Schedule25 products provided by Universal Algorithms.

Intended Audience

This manual is for use by those individuals responsible for installing, customizing, andmaintaining the interfaces between CX and the Resource25 and Schedule25 products.

How to Use This Manual

If you are not familiar with the processes and features of the Resource25 and Schedule25interfaces, read this manual for:

• Detailed reference information about how the interfaces work• Procedures for customizing and maintaining the interfaces

If you are familiar with the processes and features of the interfaces and just need specificreference information or a procedure, look through the table of contents or index and refer to thepages you need.

Structure of This Manual

This manual contains both general reference information and procedures for installing,customizing, and maintaining the Resource25 and Schedule25 interfaces. The organization ofthe manual is as follows:

Overview informationSection 1 - Information about using this manualSection 2 - Overview information about the interfaces

Interface reference informationSection 3 - Tables and records used in the interfacesSection 4 - Macros and includesSection 5 - Program used in the interfacesSection 6 - Menus, screens, scripts, and reports

Interface proceduresSection 7 - Procedures to set up the interfaces

Jenzabar CX screens used in the interfacesSection 8 - A reference of the screens, fields, and commands for the interfaces

Reference informationIndex

Page 8: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Using This Manual 2 Resource25/Schedule25 Interfaces

Related Documents and Help

The following resources also are available to assist you in installing, customizing, maintaining,and using the Resource25 and Schedule25 interfaces.

QuickMate online helpQuickMate Installation Guide

TerminologyMaster Glossary

UNIX-based helpHelp command (<Ctrl-w>) in screens and menus

User guidesGetting Started User Guide

Conventions Used in This Manual

Introduction

Jenzabar, Inc. has established a set of conventions to help you use this manual. The list ofconventions presented below is not exhaustive, but it includes the more frequently used stylesand terms.

Style Conventions

Jenzabar CX interface manuals observe the following style conventions.

Boldface typeRepresents text that you type into the system (e.g., Type UNDG), command names (e.g.,Finish), or keys you use to execute a command or function (e.g., <Enter>).

Bulleted listsShow items not ranked or without a sequential performance.

CAUTION:Indicates a caution or warning of a potential risk or condition.

<Enter>

Represents the Enter, Return, Line Feed, or ↵ key on your keyboard.

Italic typeIs used in any of these ways:

• To represent a new or key term• To add emphasis to a word• To cross-reference a section of text• To represent a variable for which you substitute another variable (e.g., substitute

filename with an appropriate filename)

<Key name>Represents a key that you must press.

Note:Indicates a note, tip, hint, or additional information.

Numbered listsShow ranking of items or sequence of performance.

Page 9: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 3 Using This Manual

ParenthesesWhen used around a field name, indicate the field is unlabeled. The field descriptionincludes the location of the field.

Quotation marksRepresent information written in this guide exactly as it appears on the screen.

Example: The message, "Now Running..." appears.

Jenzabar-Specific Terms

Some terms used in this manual may be unfamiliar to you, either because they are terms youhave not used before or because Jenzabar, Inc. has assigned a slightly different meaning to afamiliar term. The following list identifies and explains the most common Jenzabar-specific terms:

ApplicationOne or more software programs that enable you to perform a particular procedure, such asentering student information.

DataSpecific information you enter into fields on a particular data entry screen.

EnterTo type information on a keyboard and execute by any of the following actions:

• Pressing the <Enter> key• Clicking on the OK button• Selecting Finish

F keyAny of the function keys located on your keyboard (e.g., <F1>).

Hot keyThe capitalized and underlined (or highlighted) letter of a command on a menu.

IDThe number assigned to each student or organization associated with your institution (e.g.,12345).

ParameterA variable in the system that is given a constant value for a specific application (e.g., a datecan be a parameter for producing a report).

SelectTo execute a command by any of the following actions:

• Performing the keystrokes• Pressing the hot key• Highlighting the command or option and pressing <Enter>• Clicking on the icon or button with the mouse

SystemThe Jenzabar, Inc. product, CX.

Keystrokes

When you see two keys separated by a dash (e.g., <Ctrl-c>), hold down the first key (<Ctrl>)while pressing the second (<c>).

Page 10: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available
Page 11: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 5 Interface Processes

SECTION 2 – INTERFACE PROCESSES

Overview

Introduction

This section provides information on the purpose and process flow of the Resource25 andSchedule25 interfaces.

Purpose of Products

The primary purpose of the Resource25 and Schedule25 interfaces is to enable an institution touse these scheduling products from Universal Algorithms with CX.

Background Knowledge

The following list describes the necessary background information that you should know toimplement and support the Resource25 and Schedule25 interfaces.

UNIXKnow the following about the UNIX operating system:

• Csh environment and commands• Editor commands (e.g., vi)

INFORMIX-SQLKnow about the following INFORMIX tools:

• SQL database• PERFORM screens• ACE reports

Jenzabar CX database tools and utilitiesKnow how to use the following database tools:

• MAKE processor• Schemas• Macros• Includes• Program screens and windows

Jenzabar CXKnow the following about the CX standard product:

• CX directory structure• The menu processor• The CX database engine• The product update process

QuickMate featuresKnow the following about the CX Graphical Server:

• Client/Server processing• Telnet settings• Keyboard settings• Mouse settings• GUI mode commands

Page 12: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Interface Processes 6 Resource25/Schedule25 Interfaces

C ProgrammingIf you want to modify any CX programs to meet unique needs at your institution, you mustknow how to use the C programming language and have an in-depth knowledge of the CXcode.

PerlIf you want to modify any of the scripts that provide the functionality of the interface(s), youshould have at least a basic understanding of Perl.

Resource25 and Schedule25 interface assumptionsJenzabar, Inc. assumes the following:

• The Resource25 database is set up and configured using this interface, and its profiletables are populated with data from CX.

• The vCalendar files used by Resource25 and the Class Descriptor files used bySchedule25 are ASCII files. Resource25 is a Windows application, and Schedule25 isoffered for both the Windows and UNIX platforms.

• The user is responsible for moving exported files between Windows and UNIX. It isassumed for the use of these interfaces that you implement Samba software to map aUNIX directory as a network drive on the PC.

Process Flow

Process Description

Interfaces between Resource25/Schedule25 and CX involve the following processes.

Resource25 is an event scheduler, which facilitates the configuration of facilities, preferences,and events, and provides room search capability. Resource25 is capable of importing classroomevents from Schedule25 or from CX.

Schedule25 is a classroom utilization optimizer, which inputs facility specifications, departmentpreferences, and class schedules, and calculates the best match of room assignments withclasses.

The interface allows Meeting records (mtg_rec) to be exported from CX to Schedule25. ThenSchedule25 assigns rooms to classes, and these assignments are imported back to CX, updatingthe Meeting records.

Most Resource25 users will continue to assign classrooms to meetings in Course Entry (crsent).Meeting records will be imported into Resource25 primarily so that academic facilities can bescheduled for non-class events without conflicting with classroom assignments. It is possible,however, to locate rooms for meetings using Resource25’s ability to consider feature and facilitypreferences, so the interface also will support importing room assignments from Resource25 intoCX, updating the Meeting records.

The intended interaction between Resource25 and Schedule25 is that Resource25 imports classinformation from CX. Resource25 is used to add facility and department preferences to theimported events and then export the classes in Class Descriptor format to Schedule25 so it canperform its optimization. The resulting room assignments are imported back into Resource25,and Resource25 exports the completed events back to CX.

Page 13: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 7 Interface Processes

Application Relationships

Related Jenzabar CX Applications

The Resource25/Schedule25 interfaces interact with another application in CX. The followinginformation describes the interrelationship.

Course/Class ScheduleUsers of the Resource25 interface assign classrooms using the Course Entry program(crsent) in CX. The Resource25 interface builds upon the Meeting records (mtg_rec) createdin CX and the non-Meeting records in its own database.

Users of the Schedule25 interface use the Meeting records created in crsent (without facilityassignments) to make facility assignments in Schedule25.

Creation of Campus Profile

Introduction

Prior to the use of Resource25 or Schedule25, the campus profile data must be extracted fromthe CX database and stored in a file that is available to Resource25 and Schedule25. BothResource25 and Schedule25 use the same format for this information.

Resource25 will use this data to populate its campus profile tables in its database. Jenzabar, Inc.assumes that you will be implementing Resource25 in coordination with the implementation ofthis interface (i.e., that you will not have Resource25 campus data already in place). If that is notthe case, it is important that you check with Jenzabar, Inc. to determine whether the defined roomand department key is the same as that used by this interface.

The creation of this profile data from the CX data needs to be done only on initial setup forResource25 and Schedule25. The campus profile files used by Resource25 and Schedule25describe departments, facilities, and physical attributes. Four files are created from CX based ondata in CX:

• depts.dat• part.dat• rooms.dat• phys.dat

Once the files are created, if Resource25 is used, an import of the profile is executed to updatethe Resource25 database with facility information. If Schedule25 is used, the files are useddirectly in the room assignment process.

The option that creates the campus profile data will store this data in a file in the directory given inthe macro S25_FILES. The default directory defined in this macro is $TXTPATH/s25.

A script is provided that will create the following files. This script is s25campexp under$CARSPATH/regist/scripts.

Page 14: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Interface Processes 8 Resource25/Schedule25 Interfaces

Departments File (depts.dat)

This file is generated from the dept_table and facil_table. Its contents are:

File layout:

HISTORY 001 N (txt)

HIST 001 K (dept)

1 001 P (Require classroom type C)

9,10 0011 C (*)

3-5 0012 C (*)

1-52 0013 C (*)

ENGLISH 002 N

ENG 002 K

1 0021 C (1 means first preference)

2 0022 C (2 means second preference)

Space Categories/Partitions File (part.dat)

This file is a numbered list of Resource25 Space Categories (called partitions in Schedule25) andis built from the bldg_table’s campus and bldg columns in CX. The rooms.dat and depts.dat filesreference it. The rooms.dat file lists the partition to which each room belongs in the followingformat, and the depts.dat file lists the partition preference for each department when assigningrooms.

CARS,MAIN - MAIN ADMINISTRATION 1

MAIN,AMH - AARON MEMORIAL HALL 2

Space Records File (rooms.dat)

This file is generated from the facil_table.

File layout Explanation

MAIN,AMH,1000 001 N campus, bldg, room

0040 001 S max_occ

2 001 L second entry in part.dat

1,2 001 P PHONE if phone or phone_ext and

*ROOM TYPE:C from ctgry

* Indicates this is a classroom.

Page 15: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 9 Interface Processes

Physical Features File (phys.dat)

This file contains a list of numbered physical attributes that the rooms.dat and depts.dat filesreference. The rooms.dat file lists the attributes that each room possesses, and the depts.dat filelists each department’s feature preferences when assigning rooms.

The CX database does not track physical features for facilities. However, there are phone andphone_ext fields in the facil_table to indicate whether the room has a phone. Also, there is aroom category field (ctgry) in the facil_table that can be used to indicate whether a room is aclassroom, auditorium, or office.

You can edit the S25_FACIL_TYPES macro, set initially to FACIL_TYPE_VALID, to specify a listof the room categories that should be exported (e.g., it may not be desirable to export offices).This macro is used to create a number of “ROOM TYPE” feature records.

File layout Explanation

PHONE 1

ROOM TYPE: C 2 *Classroom

ROOM TYPE: A 3 *Auditorium

ROOM TYPE: O 4 *Office

*C,A,O from S25_FACIL_TYPES macro

Resource25

Overview of the Resource25 Interface

The following information provides an overview of how Resource25 interfaces with CX.

Note: This is only an overview of the process. See Setting Up the Resource25 Interface inthis manual for step-by-step procedures to set up and use the interface.

1. Set up the Resource25 database by running the Export Campus Profile script provided inthe interface product to populate Resource25 with data from CX.

2. Configure the Resource25 event hierarchy. The interface with CX requires that there be aMEETING event type defined in the event hierarchy.

3. Set up macros.

4. The Course Entry program (crsent) in CX initially creates the course schedule for a session.At this point, most of the meetings with their facility assignments are added in crsent.Probably you will choose to turn off Resource25 conflict checking in crsent at this time toexpedite the data entry. (There will be more delay in entering meetings in crsent when itchecks against Resource25 data.) Also, the ability in crsent to notify Resource25 of meetingchanges would be turned off, since the session’s batch transfer to Resource25 has not beenperformed yet.

5. Once a session’s schedule is in place, run the Export Meetings - Batch menu option in CX togenerate the file that will be imported then into Resource25. The file this option creates isput into the request subdirectory under the directory whose location is given in the macroR25_VCAL_FILES. If possible, the user’s UNIX/PC system should be configured so that thisdirectory can be shared between the UNIX/PC systems via the Samba software. Thissimplifies the sharing of files between the two systems.

Page 16: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Interface Processes 10 Resource25/Schedule25 Interfaces

6. When this option creates the transfer file, it also updates the table, r25vcalseq_rec, whichstores transaction sequence numbers.

7. At this point, use Resource25 to import the meeting assignments that are defined in the filejust created. Resource25 will process the file, adding each assignment to its database. Anyfacility assignments given in the file that cannot be loaded into Resource25 due to conflictswill be identified to the Resource25 user, in their To Do list.

8. Ongoing changes to meeting assignments in crsent are handled by crsent creating avCalendar file for each meeting change, addition, and deletion. These files go into the samedirectory location as the batch file mentioned previously. This functionality in crsent isenabled via a parameter to the program and can be enabled or disabled on the CatalogMaintenance menu option. Also, at this time, meeting changes in crsent, as well as thefacility search ability, check for conflicts against Resource25 data.

9. Resource25 then processes on a periodic basis the transactional vCalendar files crsentgenerates for each meeting change, addition, and deletion. If the assignment given in the filecannot be made by Resource25 due to a conflict, that conflict will be identified to theResource25 user, in their To Do list.

10. If Resource25 is used to make ongoing changes to classroom assignments, you can exportthese from Resource25 and then import them into CX using the Import Room Assignmentsmenu option in CX.

Additional information for some of the preceding overview steps follows.

Event Hierarchy

Resource25 requires the construction of an event type relationships hierarchy, which is used forgrouping events and assigning preferences or constraints to each group. For additionalinformation, see Setting Up the Resource25 Interface in the section Setting Up the Interfaces inthis manual.

Exporting the Campus Profile

This option creates the phys.dat, part.dat, depts.dat, and rooms.dat files, which describe thecampus facilities and academic accounts. The files may need to be moved after they are created.They are written to $ENV{CARSPATH}/text/s25.

Exporting Meetings - Batch

This process involves the execution of a Perl script that writes all Meeting records for a session toa file called cis.vcs. This file is in the vCalendar format. The user should perform this processonly once each session after the initial course schedule is completed.

Resource25 has a configuration option under System Definitions | vCalendar | Directories forspecifying a path for each type of vCalendar transaction. You configure the R25_VCAL_FILESmacro to tell CX the root directory for vCalendar files.

You can use Samba to map R25_VCAL_FILES and its subdirectories to a PC network drive.

The r25vcalseq_rec table (schema r25vcalseq) tracks all meetings involved in vCalendartransactions. Each vCalendar transaction contains a sequence number for the referenced eventand tracks the number of times the event has changed. The sequence number is automaticallyincremented and stored.

The execution of the batch transfer option results in an output file in your home directory listingeach meeting that was included in the export.

Page 17: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 11 Interface Processes

Exporting Meetings - Singular

In addition to exporting all meetings for a session, new, changed, or deleted meetings occurringafter the initial export must be communicated to Resource25 so events scheduled withinResource25 that use classroom facilities do not cause conflicts. This is something that is donebehind the scenes according to the setup.

The crsent program creates a vCalendar file whenever there is a change in a meeting’s status.This includes marking a meeting as “canceled” when its section is dropped. The vCalendar filecreated for an individual meeting is named using the mtg_no, with a .vcs extension (e.g.,14052.vcs), and resides in the request subdirectory of the path defined in the macroR25_VCAL_FILES. The crsent program executes the r25vcalexp Perl script whenever a meetingis added or whenever a meeting’s facility, days, or times are changed.

Resource25 polls for new transactions at a frequency specified in minutes, so the crsent programcannot be expected to wait for a response. Depending upon the request, it could be hours oreven days before a response is received if human intervention is required. Therefore, crsentsimply will create the vCalendar files and will not look for a response from Resource25. It is up tothe user to initiate an import from Resource25 when they know the files have been created.

Importing Room Assignments

This process provides the ability to import classroom facility assignments made in Resource25.The process that performs this assumes that the Resource25 export files will be in the publishsubdirectory under the directory given by the R25_VCAL_FILES macro.

The Resource25 user exports room assignments by publishing events in vCalendar format. Theuser can publish individual events from the Event Cabinet or multiple events resulting from anevent search. The search should be limited to the event type specified in the macroR25_EVENT_TYPE (the default is MEETING). The search criteria can include parameters, suchas date range and department. Each event is written to a separate .vcs file in the publishsubdirectory. CX deletes these files when the import process is complete.

The execution of this option results in an output file in your home directory listing each meetingand room assignment included in the import.

Checking Resource25 Conflicts in Course Entry

The crsent program performs its own conflict checking by accessing the Informix databaseResource25 uses to maintain its records. Course Entry will check for conflicts againstResource25 data when a meeting that contains facility assignment information (e.g., campus,building, room, days, times) is added or updated.

Course Entry also performs conflict checking within the “facility search” function when a meetingtime has been specified. When CX generates a list of rooms meeting the search criteria that haveno internal conflicts, it then checks this list against the Resource25 database to look for externalconflicts. The crsent program calls the r25conflict Perl script on each facility that is found withoutan internal conflict. Only those facilities without either an internal or Resource25 conflict willappear on the resulting list of available facilities.

CX will invoke the r25conflict Perl script and examine the script’s output in order to reportconflicts to the user. The script returns a status of 0 if no conflicts exist, 2 if conflicts exist, and 1 ifan error occurs. For example, the following conflicts will be returned for a meeting scheduled forroom “CARS 4000 100” on Tuesdays and Thursdays between 05/01/1997 and 11/01/1997 from1:45 p.m. to 4:05 p.m.:

Example: Soccer Pep Rally (05/06/1997 12:05:00 - 14:00:00)

Alumni Luncheon (09/04/1997 12:00:00 - 14:00:00)

Page 18: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Interface Processes 12 Resource25/Schedule25 Interfaces

Schedule25

Overview of the Schedule25 Interface

The following information provides an overview of how Schedule25 interfaces with CX.

Note: This is only an overview of the process. See Setting Up the Schedule25 Interface inthis manual for step-by-step procedures to set up and use the interface.

1. First, run the Export Campus Profile option in the interface to create the initial profile files.This process stores the resulting files in the directory given in the macro S25_FILES.Schedule25 expects these files to be in its install directory. If you are using the UNIXSchedule25, you have the option of having Schedule25 use the S25_FILES directory as itsinstall directory. However, if you are using the Windows Schedule25, you will need to copythe files from this directory to the Windows Schedule25 install directory.

2. Next, be sure that the Control file required by Schedule25 is properly defined and in theexpected directory (i.e., in the path defined in the S25_FILES macro). A sample Control fileis provided with the interface, but you probably will need to modify some of the settings,such as Minimum Fill Ration and Default Enrollment.

3. Enter the session’s Section and Meeting records using crsent. The times of the meetingswould be defined, but the facilities normally would not be defined. If the facilities already aredefined, Schedule25 also needs to know these pre-assignments.

4. Run the Export Meetings menu option in CX to generate a file to use as input into theSchedule25 scheduler.

5. Execute the scheduler in Schedule25 to assign facilities to the meetings provided in theinput file. This results in an output file in Class Descriptor format.

6. Use the Import Room Assignments menu option in CX to import this output file into CX.

Exporting the Campus Profile

The Export Campus Profile menu option creates the phys.dat, part.dat, depts.dat, and rooms.datfiles, which describe the campus facilities and academic accounts. The files may need to bemoved after they are created. They are written to $ENV{CARSPATH}/text/s25.

Exporting Meetings

The Export Meetings menu option in CX launches a Perl script that writes all Meeting records fora session to a file called datain.dat. This file is in the Class Descriptor format. Executing thisoption also results in an output file stored in your UNIX home directory listing meetings includedin the file.

Note: Schedule25 expects to find the datain.dat file in its installation directory (i.e., in thepath defined in the macro S25_FILES), so you may need to move the file there after itis created.

When Schedule25 is executed, it loads the campus profile files and the datain.dat file, performsits optimization, and then writes all classes for which it was able to assign rooms to a ClassDescriptor file called sortrm.dat. This is the file CX imports to update the Meeting records withroom assignments via the Import Room Assignments menu option in CX.

Note: Before importing datain.dat, Schedule25 looks for a Control file called ctrl.dat, whichcontains settings such as starting columns and widths for fields in the Class Descriptorfile. Jenzabar, Inc. can provide this file, but you probably will need to modify some ofthe settings, such as Minimum Fill Ratio and Default Enrollment.

Page 19: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 13 Interface Processes

Importing Room Assignments

When Schedule25 is executed, it loads the campus profile files and the datain.dat file, performsits optimization, and then writes all classes for which it was able to assign rooms to a ClassDescriptor file called sortrm.dat. This is the file CX imports to update the Meeting records withroom assignments. CX searches the file for records that contain a “5SM” assignment code, whichindicates that the room was assigned by Schedule25.

When you run the Import Room Assignments menu option, the process also will create a *.out filein your home directory listing the meetings that were processed.

Page 20: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available
Page 21: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 15 Interface Tables and Records

SECTION 3 – INTERFACE TABLES AND RECORDS

Overview

Introduction

This section provides reference information about each table and record associated with theResource25/Schedule25 interfaces. It also provides definitions of SQL and CX table and recordterminology and differentiates among common, shared, and product-specific tables and records.

Alphabetical Organization

The tables and records appear in alphabetical order in this section.

What Is an SQL Table?

In a relational SQL database, a table is an organized set of any kind of data, regardless of itspurpose for validation or information maintenance. The basic unit of organization of a table is acolumn, that is, a category of data. A table can have multiple columns and multiple rows of data.

Columns

Rows

ID

391569012345098754591320941783490100840917892955712309

Full Name

Browning, Allan T.Smith, Roxanne N.Dobrowski, George S.Jennings, Christina A.Brown, Garrett L.Cummings, Charles C.

FA96FA96FA96SP97FA96SP97

Sess

What Is a Jenzabar CX Table?

A table in CX contains information that remains static and is denoted with the _table extension.For example, the State table, named st_table, contains the list of the states in the United Statesof America. On the CX menu, you can access most tables in Table Maintenance menus.

What Is a Jenzabar CX Record?

A record in CX is an SQL table containing information that changes on a regular basis and isdenoted with the _rec extension. For example, the Alternate Address record, named aa_rec,contains any other addresses where students can be contacted, such as a summer address. Youaccess records in CX program screens and windows, scroll screens, and PERFORM screens.SQL makes no distinction between tables and records; all sets of data are tables.

Page 22: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Interface Tables and Records 16 Resource25/Schedule25 Interfaces

Summary List of Tables and Records Used

Introduction

Resource25/Schedule25 interfaces use tables and records that can be divided into the followingcategories:

• Common• Shared• Product-specific

Among these categories, some tables and records are required, while others are optional.

Impact of Changes to Tables and Records

If you make changes to schemas for any tables or records, you must reinstall each associatedproduct or module.

Common Tables and Records

Modules in the Resource25/Schedule25 interfaces use several tables and records that arecommon throughout CX. These tables and records are:

Note: For additional information about these common tables and records see the CX SystemReference Technical Manual unless otherwise noted.

• Building table (bldg_table)• Department table (dept_table)• Facility table (facil_table)

Shared Tables and Records

Some tables and records used in the Resource25/Schedule25 interfaces originate, or are morefrequently used, within other CX product areas. These tables and records, and their originatingproduct areas, are:

• Meeting record (mtg_rec)− Course/Class Schedule

• Section record (sec_rec)− Course/Class Schedule

Resource25/Schedule25 Interfaces Tables and Records

Programs in the Resource25/Schedule25 interfaces use the following tables and records. Fileinformation about these tables and records is in this section.

• Meeting Sequence record (r25vcalseq_rec)

Required Tables and Records

The r25vcalseq_rec is required to run the features of the Resource25/Schedule25 interfaces:

Page 23: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 17 Interface Tables and Records

Schemas

Introduction

Schema files define the structure of database files and associated fields in the CX datadictionary. You can access schema files associated with the Resource25/Schedule25 interfacesin the following directory path: $CARSPATH/schema/student.

File Naming Conventions

CX makes distinctions in the naming of schemas. For schema files containing definitions of CXtables, the UNIX filename begins with the letter t followed by characters describing the Englishname of the table (e.g., tst for the State table). For schema files containing definitions of CXrecords, the UNIX filename describes the English name of the record (e.g., id for the ID record).

The first line in a schema file, after revision information, specifies the INFORMIX database tablethat the schema defines. For example, st_table (State table) is specified in the tst schema file.

Field Descriptions

Schema files contain descriptions of each field defined in a table or record. You can viewdescriptions of fields in Resource25/Schedule25 interfaces tables and records by accessing theschema files.

Schema File Reports

Introduction

The standard CX product includes three reports that provide information about the tables andrecords used in each product area. When table implementation begins, you can run the reports toprovide the installation team with the most current information about the tables and records, andthe columns in each.

Report Locations

Access the reports from the System Management: Data Dictionary menu.

Report Descriptions

The following three reports provide information that is useful during the table setup phase ofimplementation:

Database Fields for the Jenzabar CX Database Dictionary

Report filename: dbefield

Menu option: Fields by File Report

Description: This report lists each column in the specified range of files (e.g., id_rec toprofile_rec), including its name, short and long descriptions, field type, and size.

Page 24: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Interface Tables and Records 18 Resource25/Schedule25 Interfaces

Database Files for the Jenzabar CX Database Dictionary

Report filename: dbefile

Menu option: Fields by Track Report

Description: This report lists each table that relates to the specified range of product areas(e.g., A for Admissions to F for Financial), including the table name, description, andpurpose.

Database Files/Fields for the Jenzabar CX Database Dictionary by Track

Report filename: dbetrack

Menu option: File/Field by Track Report

Description: This report combines the contents of dbefield and dbefile, displaying the tablesfor the specified product areas (e.g., A for Admissions to F for Financial) and the columns ineach table.

Tables and Records

Table and Record Information

The following list identifies the tables and records that originate from the Resource25/Schedule25interfaces. The list includes the filenames, location, purpose, and association of each table andrecord with programs, products, and other tables and records.

Note: The Program interrelationships in the list are included in the Resource25/Schedule25interfaces. The Product interrelationships in the list are not included in theSchedule25/Resource25 interfaces.

Meeting Sequence RecordKeeps track of the last sequence number used in a vCalendar transaction for each meeting.

UNIX filename: r25vcalseq

Informix filename: r25vcalseq_rec

Schema location: $CARSPATH/schema/student

Program interrelationships: Course Entry (crsent)

Product interrelationships: Course/Class Schedule

Page 25: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 19 Macros and Includes

SECTION 4 – RESOURCE25/SCHEDULE25 MACROS AND INCLUDES

Overview

Introduction

This section provides reference information about macros and includes used to set up theResource25 and Schedule25 interfaces.

Relationship Among Macros, Includes, and C Programs

For all elements of the product other than C programs, m4 macros contain the definitions offeatures that have been designed to be modified for each institution. These macros, locatedunder $CARSPATH/macros, are passed through the m4 processor.

CX contains an alternative method for the setting of features in C programs. Macros in the sourcecode of C programs are not passed through the m4 processor because the C compiler has itsown preprocessor, the cc.

To provide the same apparent functionality to C programs, a section in the include sourcedirectory has been allocated for a type of include file that acts as an intermediary between the m4processor and the cc preprocessor. In operation, m4 macros are defined whose output is a validcc macro. These m4 macros are placed in the include files. Then the include files are translatedand the appropriate cc macro is placed in the include file. The C compiler includes the installedinclude file during compilation so that the m4 macro influences the result of the compilation.

General Installation Procedures

See the CX Implementation and Maintenance Technical Manual for general procedures onsetting and installing changes to macros and includes.

Macros

Introduction

CX contains macros that define specific values used throughout the Resource25 and Schedule25interfaces. The macros and includes enable you to change the available options and functionalityof the Resource25 and Schedule25 interfaces without having to modify C code. By modifyingmacros, you can customize your implementation of the Resource25 and Schedule25 interfacesand make the interfaces easier to maintain.

Definition and Function

A macro is an instruction that causes the execution of a pre-defined sequence of instructions inthe same source language. A macro consists of uppercase letters and underscores, and is usedin place of a text string within source files. CX expands the macro to the longer text during theinstallation process for a file. CX uses the following kinds of macros:

• Enable - Allows you to enable a feature of CX• DBS_COMMON - Allows you to define database values in screens• Periodic - Allows you to make changes on a periodic basis

Macros can perform one of the following functions:• Define defaults on a screen (_DEF)• Define valid values in a field (_VALID or _INCL)• Enable system modules (ENABLE_MOD)• Enable system features (ENABLE_FEAT)

Page 26: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Macros and Includes 20 Resource25/Schedule25 Interfaces

• Establish a valid value for an include

Page 27: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 21 Macros and Includes

How to Locate Macros

To modify macros for the Resource25 and Schedule25 interfaces, access the$CARSPATH/macros/custom/student file. To access Common macros, access the$CARSPATH/macros/custom/common file.

Applocate Program

You also can locate macros using the Applocate program. Applocate checks the descriptions ofmacro files for the product you specify and lists each file that it locates in a separate file in yourhome directory.

Note: To locate the macros used in the Resource25 and Schedule25 interfaces, usingApplocate, you must specify the product name.

Follow these steps to run the Applocate program.

1. Select Utility Menu from the CX menu. The Utilities: Main menu appears.

2. Select File Options. The Utilities: File Options menu appears.

3. Select Locate Macro Values. The Locate Macro Values screen appears.

4. Select Table Lookup in the Macro Category field. A list of module names appears in aTable Lookup box.

5. Select a module name (e.g., CATALOG/SCHEDULE), and click OK. The Table Lookup boxdisappears.

6. Select Finish. The Output Parameters and Scheduling window appears.

7. Enter the following:• In the Time field, enter NOW.• In the Background field, enter Y.

8. Select Finish.

The system creates the file, applocate.out, and sends it to your home directory.

Macros that Control Features

The following macros enable features and define some default values used in the Resource25and Schedule25 interfaces. The macros appear in the order in which they are located in the$CARSPATH/macros/custom/student file.

‘ENABLE_FEAT_R25’, ‘N’Defines whether to display the menu options dealing with the Resource25 interface on theRegistrar: Course/Class Schedule menu. The macro default setting, N, specifies that theResource25 Interface menu does not appear in the Registrar: Course/Class Schedulemenu.

‘ENABLE_FEAT_S25’, ‘N’Defines whether to display the menu options dealing with Schedule25 interface on theRegistrar: Course/Class Schedule menu. The macro default setting, N, specifies that theSchedule25 interface menu does not appear in the Registrar: Course/Class Schedulemenu.

‘R25_DATABASE’, ‘r25’Defines the name of the Resource25 database.

Page 28: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Macros and Includes 22 Resource25/Schedule25 Interfaces

‘R25_VCAL_FILES’, $ENV{CARSPATH}/text/r25’Defines the root directory where Resource25 reads and writes vCalendar files. Thesubdirectories, request and publish, must exist under this path. The macro default setting is$ENV{CARSPATH}/text/r25.

‘S25_FILES’, $ENV{CARSPATH}/text/s25’Defines the directory where Schedule25 Class Descriptor files should be exported andimported. The macro default setting is $ENV{CARSPATH}/text/s25.

‘S25_FACIL_TYPES’, ‘FACIL_TYPE_VALID’Defines which facility types should be included in the export of the campus profile (e.g., C, A,O). The macro default setting is ‘FACIL_TYPE_VALID’.

‘S25_FACIL_DEF’, ‘C’Defines the default room type preference for all departments exported in the campus profile.The macro default setting is ‘C’ for classroom.

‘S25_PARTITION_DEF’, ‘CARS,MAIN’Defines the default partition preference for all departments exported in the campus profile.This should consist of the campus and building. The macro default setting is ‘CARS,MAIN’.

‘R25_EVENT_TYPE’, ‘MEETING’Defines the event type in Resource25 for CX meetings. The macro default setting is‘MEETING’.

Page 29: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 23 Course Entry

SECTION 5 – COURSE ENTRY

Overview

Introduction

This section provides reference information about the Course Entry program (crsent). TheResource25 and Schedule25 interfaces use Course Entry to check conflicts against Resource25data and to create the vCalendar transaction file upon meeting changes.

How Course Entry Interfaces with Resource25/Schedule25

Summary

According to the parameter setup, crsent will check for conflicts against Resource25 data and willcreate vCalendar transaction files when meetings are changed.

Course Entry Program Parameters

Course Entry has two parameters to facilitate conflict checking and the creation of vCalendartransaction files.

The parameters are:• -R (to enable conflict checking against Resource25 data)• -v (to enable creation of vCalendar files for changed meeting data)

Conflict Checking

Conflict checking occurs in two instances:• When a meeting is changed, added, or deleted• When a facility search is performed

When a meeting is changed or added, crsent first will check for internal conflicts. Then it willcheck against Resource25 conflicts by calling the r25conflict Perl script, specifying all neededmeeting information to the script. If there is a conflict with Resource25, a window will appeardisplaying the first five conflicts it encountered. Jenzabar, Inc. anticipates that there will never, oralmost never, be more than five conflicts for a specified meeting.

When a facility search is performed, at the point where a meeting can be added or changed,crsent loads all facilities that meet the search criteria defined on the search screen, and then foreach facility loaded, checks for conflicts with other meetings, using the current meeting timeinformation on the screen for comparison. For each facility loaded, and for each facility that hasnot found an internal conflict, the process also will check conflicts against Resource25 data bycalling the r25conflict script with the appropriate parameters.

If there is a conflict, that facility will not be displayed as available, and crsent proceeds to checkthe next facility, until all facilities that have been loaded are checked.

If the user has not defined meeting times (begin/end dates in the meeting currently underconsideration) then no conflict checking is performed.

Page 30: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Course Entry 24 Resource25/Schedule25 Interfaces

Creation of the Resource25 Export File

New, changed, or deleted meetings occurring after the initial export of meeting data toResource25 must be communicated to Resource25 so events scheduled within Resource25 thatuse classroom facilities do not cause conflicts.

Course Entry must create a vCalendar file whenever there is a change in a meeting’s status. Theplaces in crsent where this must be done include:

• Where a meeting is marked “canceled” when its section is canceled• Where a meeting is added• Where a meeting is deleted• Where a meeting time or location is changed

The vCalendar file created for an individual meeting is named using the mtg_no, with a .vcsextension (e.g., 14052.vcs) and resides in the request subdirectory of the vCalendar path.

Resource25 polls for new transactions at a frequency specified in minutes, so crsent cannot beexpected to wait for a response. In fact, depending on the request, it could be hours or even daysbefore a response is received if human intervention is required. Course Entry, therefore, simplywill create the vCalendar files and will not look for a response from Resource25.

Page 31: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 25 Menus, Screens, and Scripts

SECTION 6 – MENUS, SCREENS, AND SCRIPTS

Overview

Introduction

This section provides reference information on the following features of the Resource25 andSchedule25 interfaces:

• Menu source files• Menu option files• Perl scripts

Directory Locations

The features detailed in this section are located in the following directory paths:

Menu source files$CARSPATH/menusrc/student/regist/schedule/r25$CARSPATH/menusrc/student/regist/schedule/s25

Menu option files$CARSPATH/menuopt/regist/scripts

Perl scripts$CARSPATH/modules/regist/scripts

Menu Options

Programs, Screens, and Scripts

The following list associates each Resource25 and Schedule25 interface program, screen, andscript menu option and corresponding menuopt file and identifies the menuopt locations and whatthe menu option accesses.

Note: The following menus and options are listed in the order in which they appear on thestandard CX menu structure. Italicized parameters indicate those that a user can enteror change.

Registrar: Resource25 Menu

Note: This submenu is available if the macro ENABLE_FEAT_R25 is set to Y.

Export Campus Profile

Accesses: $CARSPATH/modules/regist/scripts/s25campexp (Perl script)

File: $CARSPATH/menuopt/regist/scripts/s25campexp

Parameters Passed: • Exclude Inactive Facilities

Export Meetings - Batch

Accesses: $CARSPATH/modules/regist/scripts/r25vcalexp (Perl script)

File: $CARSPATH/menuopt/regist/scripts/r25vcalexp

Parameters Passed: • Session• Academic Year

Page 32: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Menus, Screens, and Scripts 26 Resource25/Schedule25 Interfaces

Import Room Assignments

Accesses: $CARSPATH/modules/regist/scripts/r25vcalimp (Perl script)

File: $CARSPATH/menuopt/regist/scripts/r25vcalimp

Parameters Passed: None

Registrar: Schedule25 Menu

Note: This submenu is available if the macro ENABLE_FEAT_S25 is set to Y.

Export Campus Profile

Accesses: $CARSPATH/modules/regist/scripts/s25campexp (Perl script)

File: $CARSPATH/menuopt/regist/scripts/s25campexp

Parameters Passed: • Exclude Inactive Facilities

Export Meetings

Accesses: $CARSPATH/modules/regist/scripts/s25mtgexp (Perl script)

File: $CARSPATH/menuopt/regist/scripts/s25mtgexp

Parameters Passed: • Session• Academic Year

Import Room Assignments

Accesses: $CARSPATH/modules/regist/scripts/s25mtgimp (Perl script)

File: $CARSPATH/menuopt/regist/scripts/s25mtgimp

Parameters Passed: None

Page 33: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 27 Menus, Screens, and Scripts

Perl Scripts

Introduction

The Resource25 and Schedule25 interfaces contain Perl scripts to automate the processing ofinformation. The Perl scripts for Resource25 and Schedule25 interfaces are located in thefollowing directory path: $CARSPATH/modules/regist/scripts

Perl Scripts

The following list provides a description of the Perl script and its menu access(es).

s25campexpThis script creates the rooms.dat, depts.dat, part.dat, and phys.dat files both Resource25and Schedule25 need.

Note: If the exclude parameter is Y, this script will exclude inactive facilities wherestat !=FACIL_STAT_ACTIVE and stat !=space. The resulting file is stored in thedirectory (i.e., the path defined in the macro S25_FILES).

Menu Access: Registrar: Resource25 Menu: Export Campus Profile

Menu Access: Registrar: Schedule25 Menu: Export Campus Profile

s25mtgexpThis script creates the datain.dat file Schedule25 needs.

Note: The resulting file is in Class Descriptor format and is stored in the directorygiven by the S25_FILES macro.

Menu Access: Registrar: Schedule25 Menu: Export Meetings

s25mtgimpThis script processes the data file, sortin.dat, created after Schedule25 has made its roomassignment. The script will update mtg_recs and will create an output file listing the meetingsthat were processed.

Menu Access: Registrar: Schedule25 Menu: Import Room Assignments

r25vcalexpThis script writes all Meeting records for the specified session and year to a file calledcis.vcs, which is in vCalendar format.

Note: The resulting file is stored in the directory location given by theR25_VCAL_FILES macro.

Menu Access: Registrar: Resource25 Menu: Export Meetings - Batch

r25vcalimpThis script processes the data file created by Resource25 upon execution of its export utility.The script will update Meeting records (mtg_rec) and will create an output file listing themeetings that it processed.

Menu Access: Registrar: Resource25 Menu: Import Room Assignments

r25vcalexpThis script is run only in the background via crsent and will create a vCalendar file for theindividual meeting that has been changed or added in crsent. The file will be stored in thedirectory given by the macro R25_VCAL_FILES.

Menu Access: Not applicable

Page 34: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Menus, Screens, and Scripts 28 Resource25/Schedule25 Interfaces

r25conflictThis script takes Meeting record (mtg_rec) data as input parameters and then checks theResource25 database to see whether there is a conflict with the specified meetinginformation. The script outputs information related to any conflict it finds.

Note: This script is called only from within crsent to perform conflict checking. Thetable SP_RESERVATIONS has the start and end time of every event each dayfor each ROOM_ID, which can be matched to the SHORT_NAME in theROOMS table. The SHORT_NAME consists of the campus, building, and roomof a meeting. The script returns a status of 0 if no conflicts exist, 2 if conflictsexist, and 1 if an error occurred.

Menu Access: Not applicable

Page 35: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 29 Setting Up

SECTION 7 – SETTING UP THE INTERFACES

Overview

Introduction

This section provides procedures for setting up and installing the Resource25 and Schedule25interfaces. The following procedures are included:

• Assessing institutional needs for the module• Reviewing data in tables and records• Changing default field values in macros

Basic Information

This section contains detailed procedures specific to the Resource25 and Schedule25 interfaces.For information on performing basic procedures, such as using the MAKE processor andreinstalling options, refer to the following resources:

• Database Tools and Utilities course notebook• CX System Reference Technical Manual

Setting Up the Resource25 Interface

Introduction

Resource25 provides menus for configuring space (e.g., facilities), customers (e.g.,departments), and events (e.g., classes).

Resource25 stores its data in an Informix database (no earlier than Release 7), which the usermust create. SQL scripts are provided that can be executed from dbaccess to create thenecessary tables/views and grant privileges. Resource25 is a Windows application that accessesthe database using the Informix ODBC driver (Informix CLI or I-connect).

Resource25 imports class events either as Schedule25 Class Descriptor files or as vCalendarfiles. vCalendar is a specification defined for the exchange of information between electronicmessaging services, and calendaring and scheduling applications such as Personal InformationManagers. This is the method CX will use for communicating with Resource25.

You must complete a number of steps to set up the Resource25 interface. This section lists anddescribes the steps you must perform to set up the Resource25 interface.

Resource25 Checklist

You can use the following list as a checklist. This list precedes more detailed setup information.

1. Create a database for Resource25.

2. Create a UNIX r25 directory for file import/export. Create request and publish subdirectories.

3. If applicable, share the r25 directory via Samba software and map as a PC network drive.

4. Edit macros.

5. Configure Resource25.

6. Set up a data service for Resource25 database access.

7. Export campus profile files from CX.

8. Move campus profile files to the r25/s25/import directory.

Page 36: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 30 Resource25/Schedule25 Interfaces

9. Import campus profile files into Resource25.

Page 37: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 31 Setting Up

10. If desired, add room features and preferences.

11. Export meetings for a session from CX.

12. Import meeting events into Resource25.

13. Perform room assignments in Resource25.

14. Publish meeting events for which assignments were made from Resource25.

15. Import room assignments into CX.

16. Turn on Resource25 event conflict checking and change notification in the Course Entryprogram (crsent).

17. Import changes into Resource25.

Step 1 - Creating a Database for Resource25

Resource25 stores its data in an Informix database (no earlier than Release 7). You must createthis database with the appropriate permissions for user access. Create the database inaccordance with the requirements in the Resource25 documentation from Universal Algorithms.

Step 2 - Creating a UNIX r25 Directory

Jenzabar, Inc. recommends that you create a UNIX r25 directory under the $TXTPATH directory.The full path for files exported from CX would be $TXTPATH/r25/request. The full path for filespublished from Resource25 would be $TXTPATH/r25/publish.

Step 3 - Mapping the r25 Directory as a PC Network Drive (Optional)

If applicable, map the r25 directory as a PC network drive. If Samba software is not being used,you must transfer (e.g., ftp) exported files between UNIX and Windows.

Step 4 - Editing Macros

Edit the following macros according to the information provided:

ENABLE_FEAT_R25Set to “Y” to display the Resource25 Interface menu option on the Registrar: Course/ClassSchedule Menu.

R25_DATABASESet to “r25” or whatever name was given to Resource25’s Informix database.

R25_VCAL_FILESSet to the path for the r25 directory created in step 1. The default is $ENV{CARSPATH}/text/r25(i.e., $TXTPATH/r25).

Note: You must use Perl script syntax when you specify the environment variable($ENV{VARIABLE_NAME}).

S25_FILESThis is the path where CX will write the campus profile files. The default is$ENV{CARSPATH}/text/s25. This is also the path for meeting file imports and exports for theSchedule25 interface. Jenzabar, Inc. recommends that, for Resource25 users, you change thepath to $ENV{CARSPATH}/text/r25 (i.e., the same as the macro R25_VCAL_FILES).

Note: You must use Perl script syntax when you specify the environment variable($ENV{VARIABLE_NAME}).

Page 38: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 32 Resource25/Schedule25 Interfaces

S25_FACIL_TYPESThis macro specifies the types of rooms CX should include in the campus profile rooms.dat file.The default is the macro FACIL_TYPE_VALID. The facil_table in the CX database has thecolumn ctgry, which indicates the type of facility (e.g., C for classroom, A for auditorium, O foroffice). As an example, if you do not want to include offices in the export, S25_FACIL_TYPESwould be set to “C, A”.

This macro also is used when creating the physical features file of the campus profile (i.e.,phys.dat). Room type entries follow the feature, PHONE, and are included for each item in themacro as follows:

• Feature 1 PHONE• Feature 2 ROOM TYPE:C• Feature 3 ROOM TYPE:A

When the rooms.dat file is created, each room is assigned a ROOM TYPE feature based on thevalue of its ctgry column in the facil_table. For example, a room with a value of “C” in its ctgrycolumn would possess feature number 2 (i.e., ROOM TYPE:C).

S25_FACIL_DEFWhen the depts.dat file of the campus profile is created, each department identifies a physicalfeature preference, which can be taken into account when assigning a room for one of thedepartment’s classes in Resource25. (Use of the preference is optional.) All departmentsexported for the campus profile will receive the same preference, which you specify with theS25_FACIL_DEF macro. The default is “C” for classroom.

S25_PARTITION_DEFWhen the depts.dat file of the campus profile is created, each department identifies a spacecategory preference (called a partition in Schedule25 terminology), which can be taken intoaccount when assigning a room for one of the department’s classes in Resource25. (Use of thepreference is optional.) The facil_table has a dept column, which indicates the department thatcontrols the facility. The department is given a space preference for each building in which thedepartment controls one or more facilities. If a department controls no facilities, the buildingidentified by the S25_PARTITION_DEF macro is used as the preference. The default is“CARS,MAIN”. When you edit this macro, specify the building as campus,bldg.

R25_EVENT_TYPEThis macro defines the event type in Resource25 for CX meetings. The macro default setting is‘MEETING’.

Page 39: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 33 Setting Up

Step 5 - Configuring Resource25

You must perform three basic tasks to configure Resource25:

1. Construct event hierarchy.

2. Create filter rules.

3. Set vCalendar options.

Constructing an event hierarchy.Resource25 requires the construction of an event type relationship hierarchy, which is used forgrouping events and assigning preferences or constraints to each group. Each level of thehierarchy may inherit from higher-level events. The Resource25 interface with CX requires aMEETING event type.

The highest level of the event hierarchy might look something like this:

SPECIAL EVENTS ACADEMIC ADMINISTRATIVE

CX events exported from the Meeting records would fall under ACADEMIC. The recommendedACADEMIC hierarchy would be:

• ACADEMIC• SESSION• MEETING

Event cabinets are created based on this structure. For example, you would create the followingcabinet:

1998/99 Academic Year (ACADEMIC) Sept 15, 1998 to June 15, 1999Fall 1998 (SESSION) Sept 15, 1998 to Jan 15, 1999Spring 1999 (SESSION) Feb 1, 1999 to June 15, 1999

When CX creates the cis.vcs vCalendar file from Meeting records, it identifies each record asevent type MEETING, and the start/end date of the meetings are included. Resource25 can usethe “default filter rule” to place each meeting under the appropriate parent event. Resource25knows that SESSION is the level above MEETING. For example, if a Meeting record has the daterange Sept 18, 1998 - Jan 14, 1999, Resource25 determines that the only SESSION event ableto span the dates of the incoming MEETING event is Fall 1998.

CX names meeting events using the format “sessyr, crs_no, sec_no, mtg_no”, where sessyr isthe composite of the session and year values (e.g., FA1999). After importing cis.vcs, the eventcabinet might look like this:

1998/99 Academic Year (ACADEMIC)Fall 1998 (SESSION)

FA1998,MAT101,01,14022 (MEETING)FA1998,ENG223,01,13978 (MEETING)FA1998,BIO102,01,14036 (MEETING)FA1998,BIO102,02,14037 (MEETING)

Spring 1999 (SESSION)

The only event type CX requires you to define is the MEETING type, since CX references thistype in the vCalendar files it creates. If desired, you could eliminate the SESSION type, and allMEETING events would be placed directly under the ACADEMIC event for the appropriate year.

The session/year identifier is included in the meeting event name in case sessions overlap. Youcan define filter rules based on the session/year part of the event name to identify the parentevent.

Page 40: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 34 Resource25/Schedule25 Interfaces

Creating filter rules.If the meetings for a session cannot be imported using default filter rules because of overlappingsession start/end dates, you must create filter rules for each session. Perform this from theResource25 Interface | Import | vCalendar Filter Rules option.

You would select the MEETING event type, enter a name for the filter rule (e.g., FA98), and thenclick New. The parent event would be the Fall 1998 session, and the condition would be that theSUMMARY field starts with FA98.

Setting vCalendar options.You should click on System Definitions under the Resource25 Administration menu, and thenclick on vCalendar to display the vCalendar Processing Options. The Transaction Cycle shouldbe set to Break, since CX does not look for replies for its request transactions.

After clicking the Directories button, under Import Directories, both REQUEST and CANCELshould be set to the request subdirectory of the R25_VCAL_FILES path. For example, if$TXTPATH/r25 has been mapped to network drive W:, the REQUEST and CANCEL path wouldbe W:/request. Under Export Directories, PUBLISH should be set to the publish subdirectory ofthe R25_VCAL_FILES path (e.g., W:/publish).

If Samba software is not being used, you should leave the default paths (R25/vCal/request andpublish) and manually transfer files after each export.

Step 6 - Setting Up a Data Service for Resource25 Database Access

CX must examine Resource25’s Informix database to determine whether Resource25 eventsconflict with Meeting records. You must create a data service so the r25 database can beaccessed from the Perl scripts.

In addition, Connect permissions to the r25 database must be given to the user “carsu” so it canbe accessed from the menu shell.

Step 7 - Exporting Campus Profile Files from Jenzabar CX

The campus profile consists of the files phys.dat, part.dat, depts.dat, and rooms.dat. These filesare written to the path specified by the S25_FILES macro. Jenzabar, Inc. recommends that, forResource25 users, the path be changed to $ENV{CARSPATH}/text/s25 (i.e., the same as themacro R25_VCAL_FILES).

Note: The status on the export can be directed to “more” or to “file.” If sent to “file,” theoutput will be stored in the s25campexp.out file in your home directory.

You can export campus profile files from Jenzabar CX by doing the following:

1. Select Resource25 Interface from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Registrar: Resource25 Menu appears.

2. Select Export Campus Profile. The Export Campus Profile Files screen appears with thecursor in the Exclude Inactive Facilities field.

Note: The only parameter for the export is an option whether to Exclude InactiveFacilities (either Y or N). If set to Y, all rooms whose “stat” column is not equalto “space” or to the value of the FACIL_STAT_ACTIVE macro are excludedfrom the export.

3. Do you want to exclude facilities with an inactive status?• If yes, enter Y.• If no, enter N.

The cursor moves to the Output field.

Page 41: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 35 Setting Up

4. Enter the code for the output you want to use, then select Finish. The Output Parametersand Scheduling window appears.

Note: You can use Table Lookup to display available codes.

5. Complete the fields on the Output Parameters and Scheduling window.

Note: See the Getting Started User Guide for information about how to complete theOutput Parameters and Scheduling window.

6. Select Finish.

7. Press <Enter> until the Registrar: Resource25 Menu appears.

Step 8 - Moving Campus Profile Files to the r25/s25/import Directory

You must manually move campus profile files from the S25_FILES directory to the r25/s25/importdirectory. Resource25 expects to find phys.dat, part.dat, depts.dat, and rooms.dat in s25/importunder the directory where Resource25 was installed.

Step 9 - Importing Campus Profile Files into Resource25

Import campus profile files into Resource25. Before importing rooms, options should be asfollows:

• Do not modify S25 room names Checked• Convert repeating spaces to single Unchecked• Erase all spaces in S25 room names Unchecked

Campus profile import options are found under Interface | Import | Import Schedule25/25E files.Imports should be performed in the following order:

1. Features (phys.dat)

2. Partitions (part.dat)

3. Departments (depts.dat)

4. Rooms (rooms.dat)

Step 10 - Adding Room Features and Preferences (Optional)

If classroom assignments will be made with Resource25, you may want to assign additional roomfeatures to the imported facilities (e.g., whiteboard, overhead projector) to facilitate roomsearches.

Step 11 - Exporting Meetings for a Session from Jenzabar CX

Status on the export can be directed to “more” or to “file.” If sent to “file,” the output will be storedin the r25vcalexp.out file in your home directory. The resulting output will consist of a list of theexported meetings and any conflicts with existing Resource25 events that were detected.Meetings are written in vCalendar format to cis.vcs in the request subdirectory ofR25_VCAL_FILES.

You can export meetings for a session from CX by doing the following:

1. Select Resource25 Interface from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Registrar: Resource25 Menu appears.

2. Select Export Meetings - Batch. The Export Meetings to Resource25 screen appears withthe cursor in the Session field.

Page 42: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 36 Resource25/Schedule25 Interfaces

3. Enter the code for the session of meetings you want to export to Resource25. The cursormoves to the Academic Year field.

Note: You can use Table Lookup to display available codes.

4. Enter the academic year (yyyy) of meetings you want to export to Resource25. The cursormoves to the Output field.

5. Enter the code for the output you want to use, then select Finish. The Output Parametersand Scheduling window appears.

Note: You can use Table Lookup to display available codes.

6. Complete the fields on the Output Parameters and Scheduling window.

Note: See the Getting Started User Guide for information about how to complete theOutput Parameters and Scheduling window.

7. Select Finish.

8. Press <Enter> until the Registrar: Resource25 Menu appears.

Note: Resource25 is currently unable to handle multiple events scheduled for thesame facility, so for cross-listed courses, one meeting event is exported with aheadcount equal to the sum of the maximum occupancy for the cross-listedcourses.

Step 12 - Importing Meeting Events into Resource25

The Import vCalendar files option is under Interface | Import. When you click the Start button,Resource25 scans the cis.vcs file from the R25_VCAL_FILES/request directory for new,changed, or canceled events. When the Stop button becomes available, Resource25 hascompleted its scan. Errors and status are written to the Log window on the Import form. If soconfigured, Resource25 will generate To Do items for the responsible event organizer when anevent needs a room or when the headcount exceeds the room capacity.

Step 13 - Performing Room Assignments in Resource25 (Optional)

Performing room assignments in Resource25 is an optional step. If desired, all room assignmentsmay be made in CX and exported to Resource25 simply to avoid conflicts with non-class events.

Step 14 - Publishing Meeting Events for Which Room Assignments Were Made from Resource25

With the list of meeting events displayed on the Event Cabinets form, you can highlight an eventand then select Publish in vCalendar format from the Actions menu. Resource25 will write theevent to a file in the publish directory using the event’s Resource25 reference number as thefilename with the extension .vcs.

You may prefer to perform an event search for the date span for a particular session and publishall matching events. Individual .vcs files are created for each meeting event.

Step 15 - Importing Room Assignments into Jenzabar CX

CX reads vCalendar files for meetings published by Resource25 from the publish subdirectory ofR25_VCAL_FILES. Events without room assignments are ignored, as are non-MEETING events.Status on the import can be directed to “more” or to “file.” If sent to “file,” the output will be storedin the r25vcalimp.out file in your home directory. This file consists of a list of the importedmeetings with room assignments.

You can import room assignment changes into CX by doing the following:

Page 43: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 37 Setting Up

1. Select Resource25 Interface from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Registrar: Resource25 Menu appears.

2. Select Import Room Assignments. The Import Room Assignments from Resource25 screenappears with the cursor in the Output field.

3. Enter the code for the output you want to use, then select Finish. The Output Parametersand Scheduling window appears.

Note: You can use Table Lookup to display available codes.

4. Complete the fields on the Output Parameters and Scheduling window.

Note: See the Getting Started User Guide for information about how to complete theOutput Parameters and Scheduling window.

5. Select Finish.

6. Press <Enter> until the Registrar: Resource25 Menu appears.

Step 16 - Turning on Resource25 Event Conflict Checking and Change Notification in crsent

You can turn on Resource25 event conflict checking and change notification in crsent by doingthe following:

1. Select Catalog Maintenance from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Catalog Maintenance screen appears with the cursor in theSession field.

2. Enter the desired session year code(s), then press <Tab>. The cursor moves to the EnableR25 Conflict Checking field.

3. Enter Y to check for conflicting Resource25 events when a room assignment is made in CXor when an available room search is performed. The cursor moves to the Create R25Transaction Files field.

4. Enter Y to create a vCalendar file whenever a meeting is added, changed, or deleted.

5. Select Finish to exit the screen. The Catalog Maintenance Options window appears.

6. Highlight Exit, then click OK. A question appears asking whether you want to exit.

7. Select Yes. The Registrar: Course/Class Schedule menu appears.

Step 17 - Importing Changes into Resource25

This step is identical to step 12, with the exception that Resource25 scans each mtg_no.vcs filefrom the request subdirectory.

Page 44: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 38 Resource25/Schedule25 Interfaces

Setting Up the Schedule25 Interface

Introduction

Schedule25 requires campus profile files describing departments, facilities, and physicalattributes (depts.dat, part.dat, rooms.dat, phys.dat). Class information must be provided indatain.dat in Class Descriptor format. It contains class schedules, departments, and optionalroom pre-assignments.

After processing these files, Schedule25 writes its output to sortrm.dat, also in the ClassDescriptor format, including any room assignments it was able to make. Schedule25 createserror files for assignments it failed to make and generates various reports on assignments, roomavailability, and failures.

Additional tasks include creating the campus profile, exporting meetings from CX to Schedule25,and importing assignments from Schedule25 to CX.

You must complete a number of steps to set up the Schedule25 interface. This section lists anddescribes the steps you must perform to set up the Schedule25 interface.

Schedule25 Checklist

You can use the following list as a checklist. This list precedes more detailed setup information.

1. Edit macros.

2. Edit ctrl.dat file.

3. Export campus profile files from CX.

4. Export meetings for a session from CX.

5. If desired, edit files to add new physical features or preferences.

6. Move campus profile files and datain.dat to the Schedule25 installation directory if not thesame path as S25_FILES.

7. Run Schedule25 optimizer.

8. If necessary, move sortrm.dat from the Schedule25 installation directory to the S25_FILESpath.

9. Import room assignments into CX.

Step 1 - Editing Macros

Edit the following macros according to the information provided:

ENABLE_FEAT_S25Set to “Y” to display the Schedule25 Interface menu option on the Registrar: Course/ClassSchedule Menu.

S25_FILESThis is the path where CX will write the campus profile files. The default is$ENV{CARSPATH}/text/s25. If you are using the UNIX version of Schedule25, the macro shouldpoint to the directory where Schedule25 is installed. This is also the path for meeting file importsand exports for the Schedule25 interface.

Note: You must use Perl script syntax when you specify the environment variable($ENV{VARIABLE_NAME}).

Page 45: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 39 Setting Up

S25_FACIL_TYPESThis macro specifies the types of rooms that CX should include in the campus profile rooms.datfile. The default is the macro FACIL_TYPE_VALID. The facil_table in the CX database has thecolumn ctgry, which indicates the type of facility (e.g., C for classroom, A for auditorium, O foroffice). As an example, if you did not want to include offices in the export, S25_FACIL_TYPESwould be set to “C,A”.

This macro is also used when creating the physical features file of the campus profile (i.e.,phys.dat). Room type entries follow the feature, PHONE, and are included for each item in themacro as follows:

• Feature 1 PHONE• Feature 2 ROOM TYPE:C• Feature 3 ROOM TYPE:A

When the rooms.dat file is created, each room is assigned a ROOM TYPE feature based on thevalue of its ctgry column in the facil_table. For example, a room with a value of “C” in its ctgrycolumn would possess feature number 2 (i.e., ROOM TYPE:C).

S25_FACIL_DEFWhen the depts.dat file of the campus profile is created, each department identifies a physicalfeature preference, which will be taken into account when assigning a room for one of thedepartment’s classes. All departments exported for the campus profile will receive the samepreference, which you specify with the S25_FACIL_DEF macro. The default is “C” for classroom.If additional preferences are desired, you should refer to the Schedule25 manual to modifydepts.dat.

S25_PARTITION_DEFWhen the depts.dat file of the campus profile is created, each department identifies a spacecategory preference (called a partition in Schedule25 terminology), which will be taken intoaccount by the optimizer when assigning a room for one of the department’s classes. Thefacil_table has a dept column, which indicates the department that controls the facility. Thedepartment is given a partition preference for each building in which the department controls oneor more facilities. If a department controls no facilities, the building identified by theS25_PARTITION_DEF macro is used as the preference. The default is “CARS,MAIN”. When youedit this macro, specify the building as campus,bldg. If additional preferences are desired, youshould refer to the Schedule25 manual to modify depts.dat.

Step 2 - Editing the ctrl.dat File

The ctrl.dat file is the Schedule25 control file, which describes the format of the Class Descriptorfile used for meeting imports and exports (sortrm.dat and datain.dat). A sample ctrl.dat file issupplied with the Schedule25 interface. You should not change any of the field width or startcolumn information, but you may want to adjust the following parameters:

• Minimum permissible ratio enrollment/seats• Enrollment adjuster• Minimum correct input fraction• Number of weeks in term• Extra finish minutes• Earliest start time• Latest finish time

Page 46: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 40 Resource25/Schedule25 Interfaces

Step 3 - Exporting Campus Profile Files from Jenzabar CX

The campus profile consists of the files phys.dat, part.dat, depts.dat, and rooms.dat. These filesare written to the path specified by the S25_FILES macro.

Note: The status on the export can be directed to “more” or to “file.” If sent to “file,” theoutput will be stored in the s25campexp.out file in your home directory.

You can export campus profile files from CX by doing the following:

1. Select Schedule25 Interface from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Registrar: Schedule25 menu appears.

2. Select Export Campus Profile. The Export Campus Profile Files screen appears with thecursor in the Exclude Inactive Facilities field.

Note: The only parameter for the export is an option whether to Exclude InactiveFacilities (either Y or N). If set to Y, all rooms whose “stat” column is not equalto “space” or to the value of the FACIL_STAT_ACTIVE macro are excludedfrom the export.

3. Do you want to exclude facilities with an inactive status?• If yes, enter Y.• If no, enter N.

The cursor moves to the Output field.

4. Enter the code for the output you want to use, then select Finish. The Output Parametersand Scheduling window appears.

Note: You can use Table Lookup to display available codes.

5. Complete the fields on the Output Parameters and Scheduling window.

Note: See the Getting Started User Guide for information about how to complete theOutput Parameters and Scheduling window.

6. Select Finish.

7. Press <Enter> until the Registrar: Schedule25 Menu appears.

Step 4 - Exporting Meetings for a Session from Jenzabar CX

Status on the export can be directed to “more” or to “file.” If you send it to “file,” the output will bestored in the s25mtgexp.out file in your home directory. The resulting output will consist of a list ofthe exported meetings. Meetings are written in Class Descriptor format to datain.dat in the pathspecified by S25_FILES.

You can export meetings for a session from CX by doing the following:

1. Select Schedule25 Interface from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Registrar: Schedule25 Menu appears.

2. Select Export Meetings. The Export Meetings to Schedule25 screen appears with the cursorin the Session field.

3. Enter the code for the session of meetings you want to export to Schedule25. The cursormoves to the Academic Year field.

Note: You can use Table Lookup to display available codes.

4. Enter the academic year (yyyy) of meetings you want to export to Schedule25. The cursormoves to the Output field.

Page 47: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 41 Setting Up

5. Enter the code for the output you want to use, then select Finish. The Output Parametersand Scheduling window appears.

Note: You can use Table Lookup to display available codes.

6. Complete the fields on the Output Parameters and Scheduling window.

Note: See the Getting Started User Guide for information about how to complete theOutput Parameters and Scheduling window.

7. Select Finish.

8. Press <Enter> until the Registrar: Schedule25 Menu appears.

Step 5 - Editing Files to Add New Physical Features or Preferences (Optional)

Editing files to add new physical features or preferences is an optional step. You may want to addnew features to the phys.dat file and then reference these features as preferences in depts.dat ordatain.dat. Also, you may want to change or add to the partition preferences in depts.dat.

Step 6 - Moving Campus Profile Files (Optional)

Move campus profile files and datain.dat to the Schedule25 installation directory, if not the samepath as S25_FILES. Schedule25 expects to find the files in its installation directory. If you areusing the UNIX version of Schedule25, the S25_FILES macro can point to the installationdirectory.

Step 7 - Running the Schedule25 Optimizer

If you run the Schedule25 optimizer, Schedule25 reads the campus profile from the phys.dat,part.dat, depts.dat, and rooms.dat files. It then imports class schedules and pre-assigned roomsfrom datain.dat and performs the best match of rooms with classes, taking into account featureand department preferences. Schedule25 writes the classes and room assignments to sortrm.datin Class Descriptor format.

Step 8 - Moving sortrm.dat (Optional)

If necessary, move the sortrm.dat from the Schedule25 installation directory to the S25_FILESpath. Schedule25 writes the file to its installation directory. If you are using the UNIX version ofSchedule25, the S25_FILES macro can point to the installation directory. The S25_FILES path iswhere CX looks for the sortrm.dat file when importing room assignments.

Step 9 - Importing Room Assignments into Jenzabar CX

CX reads the sortrm.dat Class Descriptor file generated by Schedule25 from the path specifiedby S25_FILES. Status on the import can be directed to “more” or to “file.” If you send it to “file,”the output will be stored in the s25mtgimp.out file in your home directory. This file consists of alist of the imported meetings with room assignments.

Import room assignments into CX by doing the following:

1. Select Schedule25 Interface from the Registrar: Course/Class Schedule menu in CX, thenenter the password. The Registrar: Schedule25 Menu appears.

2. Select Import Room Assignments. The Import Room Assignments screen appears with thecursor in the Output field.

3. Enter the code for the output you want to use, then select Finish. The Output Parametersand Scheduling window appears.

Note: You can use Table Lookup to display available codes.

Page 48: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Setting Up 42 Resource25/Schedule25 Interfaces

4. Complete the fields on the Output Parameters and Scheduling window.

Note: See the Getting Started User Guide for information about how to complete theOutput Parameters and Scheduling window.

5. Select Finish.

6. Press <Enter> until the Registrar: Schedule25 Menu appears.

Page 49: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 43 Using Screens

SECTION 8 – USING THE RESOURCE25/SCHEDULE25 INTERFACESSCREENS

Overview

Introduction

This section shows each screen and window you use in the Resource25/Schedule25 interfacesand provides explanations for each of their fields. This section also provides a reference of thecommands and options you use to perform procedures in the Resource25/Schedule25 interfaces.

Refer to this section when you have questions about a specific field or command, or when youare performing procedures associated with the Resource25/Schedule25 interfaces.

Organization

The screens, windows, fields, and commands are listed in alphabetical order (unless otherwisenoted) so you can locate the information quickly.

Screen Differences

The screen and window examples in this section represent those contained in the CX standardproduct in GUI format unless otherwise noted. Screen examples show question marks (?) for theTable Lookup option where space permits. If your institution changes these screens and windowsto meet its specific needs, yours will differ from those shown in this section. Your screens andwindows also will look different if you use CX in character-based format.

Export Campus Profile Files Screen

Purpose

The Export Campus Profile Files screen enables you to create the phys.dat, part.dat, depts.dat,and rooms.dat files, which describe the campus facilities and academic accounts.

Note: Although the files are written to whatever directory is defined in the S25_FILES macro,they may need to be moved after they are created.

Access

Access the Export Campus Profile Files screen by selecting the following, beginning at theStudent Management: Main menu:

1. Registrar 2. Course/Class Schedules 3. Resource25 Interface, then enter the password 4. Export Campus Profile

Note: Other access paths can exist.

Page 50: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Using Screens 44 Resource25/Schedule25 Interfaces

Example

Following is an example of the Export Campus Profile Files screen.

Fields

The following list describes the fields that appear on the Export Campus Profile Files screen.

Exclude Inactive FacilitiesRequired - Either Y (Yes) or N (No) indicating whether to exclude facilities that have aninactive status.

OutputRequired - The name of the printer to use for output (e.g., lpt).

Commands

The following list describes the commands you can execute from the Export Campus Profile Filesscreen.

Note: You can use a specific command only when it appears on the current command line,toolbar, menu, or when it is black (not dimmed) on the list that appears when youselect Commands from the menu bar. Also, you must have the necessary databasepermission to use that command.

CancelExits the screen without saving any field entries.

FinishDoes either or both of the following:

• Displays the Output Parameters and Scheduling window.• Saves your field entries, then exits the current screen.

Page 51: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 45 Using Screens

Export Meetings to Resource25 Screen

Purpose

The Export Meetings to Resource25 screen enables you to export all Meeting records (mtg_rec)for the specified session and year to Resource25.

Note: The records are written in vCalendar format to a file called cis.vcs in the requestsubdirectory of the value defined in R25_VCAL_FILES.

Access

Access the Export Meetings to Resource25 screen by selecting the following, beginning at theStudent Management: Main menu:

1. Registrar 2. Course/Class Schedules 3. Resource25 Interface, then enter the password 4. Export Meetings - Batch

Note: Other access paths can exist.

Example

Following is an example of the Export Meetings to Resource25 screen.

Page 52: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Using Screens 46 Resource25/Schedule25 Interfaces

Fields

The following list describes the fields that appear on the Export Meetings to Resource25 screen.

Academic YearRequired - The instructional year (yyyy) for which to select Meeting records.

OutputRequired - The name of the printer to use for output (e.g., lpt).

SessionRequired - The code of the session (e.g., FA) for which to select Meeting records.

Commands

The following list describes the commands you can execute from the Export Meetings toResource25 screen.

Note: You can use a specific command only when it appears on the current command line,toolbar, menu, or when it is black (not dimmed) on the list that appears when youselect Commands from the menu bar. Also, you must have the necessary databasepermission to use that command.

CancelExits the screen without saving any field entries.

FinishDoes either or both of the following:

• Displays the Output Parameters and Scheduling window.• Saves your field entries, then exits the current screen.

Export Meetings to Schedule25 Screen

Purpose

The Export Meetings to Schedule25 screen enables you to export all Meeting records (mtg_rec)for the specified session and year to Schedule25.

Note: The records are written in Class Descriptor format to a file called datain.dat in theS25_FILES macro.

Access

Access the Export Meetings to Schedule25 screen by selecting the following, beginning at theStudent Management: Main menu:

1. Registrar 2. Course/Class Schedules 3. Schedule25 Interface, then enter the password 4. Export Meetings

Note: Other access paths can exist.

Page 53: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 47 Using Screens

Example

Following is an example of the Export Meetings to Schedule25 screen.

Fields

The following list describes the fields that appear on the Export Meetings to Schedule25 screen.

Academic YearRequired - The instructional year (yyyy) for which to select Meeting records.

OutputRequired - The name of the printer to use for output (e.g., lpt).

SessionRequired - The code of the session (e.g., FA) for which to select Meeting records.

Commands

The following list describes the commands you can execute from the Export Meetings toSchedule25 screen.

Note: You can use a specific command only when it appears on the current command line,toolbar, menu, or when it is black (not dimmed) on the list that appears when youselect Commands from the menu bar. Also, you must have the necessary databasepermission to use that command.

CancelExits the screen without saving any field entries.

FinishDoes either or both of the following:

• Displays the Output Parameters and Scheduling window.• Saves your field entries, then exits the current screen.

Page 54: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Using Screens 48 Resource25/Schedule25 Interfaces

Import Room Assignments Screen

Purpose

The Import Room Assignments screen enables you to update Meeting records (mtg_rec) afterSchedule25 performs its classroom optimization.

Note: The system reads the sortrm.dat file to obtain room assignments made bySchedule25.

Access

Access the Import Room Assignments screen by selecting the following, beginning at the StudentManagement: Main menu:

1. Registrar 2. Course/Class Schedules 3. Schedule25 Interface, then enter the password 4. Import Room Assignments

Note: Other access paths can exist.

Example

Following is an example of the Import Room Assignments screen.

Page 55: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 49 Using Screens

Fields

The following list describes the fields that appear on the Import Room Assignments screen.

OutputRequired - The name of the printer to use for output (e.g., lpt).

Commands

The following list describes the commands you can execute from the Import Room Assignmentsscreen.

Note: You can use a specific command only when it appears on the current command line,toolbar, menu, or when it is black (not dimmed) on the list that appears when youselect Commands from the menu bar. Also, you must have the necessary databasepermission to use that command.

CancelExits the screen without saving any field entries.

FinishDoes either or both of the following:

• Displays the Output Parameters and Scheduling window.• Saves your field entries, then exits the current screen.

Import Room Assignments from Resource25 Screen

Purpose

The Import Room Assignments from Resource25 screen enables you to update Meeting records(mtg_rec) after MEETING events have been published from Resource25.

Note: This option processes all vCalendar files (*.vcs) in the publish subdirectory.

Access

Access the Import Room Assignments from Resource25 screen by selecting the following,beginning at the Student Management: Main menu:

1. Registrar 2. Course/Class Schedules 3. Resource25 Interface, then enter the password 4. Import Room Assignments

Note: Other access paths can exist.

Page 56: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Using Screens 50 Resource25/Schedule25 Interfaces

Example

Following is an example of the Import Room Assignments from Resource25 screen.

Fields

The following list describes the fields that appear on the Import Room Assignments fromResource25 screen.

OutputRequired - The name of the printer to use for output (e.g., lpt).

Commands

The following list describes the commands you can execute from the Import Room Assignmentsfrom Resource25 screen.

Note: You can use a specific command only when it appears on the current command line,toolbar, menu, or when it is black (not dimmed) on the list that appears when youselect Commands from the menu bar. Also, you must have the necessary databasepermission to use that command.

CancelExits the screen without saving any field entries.

FinishDoes either or both of the following:

• Displays the Output Parameters and Scheduling window.• Saves your field entries, then exits the current screen.

Page 57: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Resource25/Schedule25 Interfaces 51 Index

INDEX

Aaccessing

Export Campus Profile Files screen, 43Export Meetings to Resource25 screen, 45Export Meetings to Schedule25 screen, 46Import Room Assignments from Resource25

screen, 49Import Room Assignments screen, 48schemas, 17

CC programs

relationship to macros and includes, 19campus profile

creation of, 7columns

table, 15commands

Export Campus Profile Files screen, 44Export Meetings to Resource25 screen, 46Export Meetings to Schedule25 screen, 47Import Room Assignments from Resource25

screen, 50Import Room Assignments screen, 49

conventions, 2creating

campus profile, 7

Ddata dictionary, 17definitions

SQL tables, 15tables, records, 17

documents, related, 2

EExport Campus Profile Files screen, 43

accessing, 43commands, 44fields, 44purpose, 43screen example, 44

Export Meetings to Resource25 screen, 45accessing, 45commands, 46fields, 46purpose, 45screen example, 45

Export Meetings to Schedule25 screen, 46

accessing, 46commands, 47fields, 47purpose, 46screen example, 47

Ffields

Export Campus Profile Files screen, 44Export Meetings to Resource25 screen, 46Export Meetings to Schedule25 screen, 47Import Room Assignments from Resource25

screen, 50Import Room Assignments screen, 49

IImport Room Assignments from Resource25

screen, 49accessing, 49commands, 50fields, 50purpose, 49screen example, 50

Import Room Assignments screen, 48accessing, 48commands, 49fields, 49purpose, 48screen example, 48

includesrelationship to macros and C programs, 19

Mmacros

relationship to includes and C programs, 19manual

conventions, 2intended audience, 1purpose, 1

PPerl scripts, 27procedures

setting up Resource25 interface, 29setting up Schedule25 interface, 37

purposeExport Campus Profile Files screen, 43Export Meetings to Resource25 screen, 45Export Meetings to Schedule25 screen, 46

Page 58: Resource 25/Schedule 25 Interfaces - Home | UConn Health · Using This Manual 2 Resource25/Schedule25 Interfaces Related Documents and Help The following resources also are available

Index 52 Resource25/Schedule25 Interfaces

Import Room Assignments from Resource25screen, 49

Import Room Assignments screen, 48

Rrecords, 18

field descriptions, 17required, 16

references. See documents, relatedrelated documents, 2reports

schema file reports, 17Resource25 interface

setting up, 29rows

table, 15

SSchedule25 interface

setting up, 37schema file reports, 17schema files

reports, 17schemas, 17

naming, 17reports, 17

screen examplesExport Campus Profile Files screen, 44Export Meetings to Resource25 screen, 45Export Meetings to Schedule25 screen, 47

Import Room Assignments from Resource25screen, 50

Import Room Assignments screen, 48screens

Export Campus Profile Files screen, 43Export Meetings to Resource25 screen, 45Export Meetings to Schedule25 screen, 46Import Room Assignments from Resource25

screen, 49Import Room Assignments screen, 48

SQLtable definition, 15

Student Affairs/Housingrequired tables, records, 16

syntaxschema names, 17

Ttables

columns, 15field descriptions, 17required, 16rows, 15

UUNIX

table names, 17

Wwindows. See screens