Prism. Installation Guide

Transcription

1 Prism Installation Guide

2 Copyright 2001 Jenazabar, Inc. 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 store copies with your Jenzabar software. You may also modify the documentation to reflect your institution's usage and standards. Permission to print, store, or modify copies in no way affects ownership of the documentation; however, Jenzabar, Inc. assumes no responsibility for any changes you make. Filename: inprism Distribution date: 06/15/1998 Contact us at Jenzabar CX, and QuickMate are trademarks of Jenzabar, Inc. INFORMIX, PERFORM, and ACE are registered trademarks of the IBM Corporation Impromptu, PowerPlay, Scenario, and Cognos are registered trademarks of the Cognos Corporation UNIX is a registered trademark in the USA and other countries, licensed exclusively through X/Open Company Limited Windows is a registered trademark of the Microsoft Corporation All other brand and product names are trademarks of their respective companies

3 JENZABAR, INC. PRISM INSTALLATION GUIDE TABLE OF CONTENTS INTRODUCTION... 1 Overview... 1 Purpose of This Guide... 1 Intended Audience... 1 GETTING STARTED... 3 Introduction... 3 Tasks Prior to Installation... 3 Exiting from the Setup Program... 3 PC INSTALLATION... 5 Introduction... 5 PC Hardware Requirements... 5 Software Requirements... 5 Database Connectivity... 5 Future Updates... 5 Installing Prism... 6 How to Install on a PC Drive or Network Server Drive... 6 Test the Connection from Prism to Your Database... 8 Suggestions for Installing on Users PCs... 8 Editing the User Permissions to Restrict the Data... 9 Modifying ini Files for Local Customizations Modifying the Module Area ini Files Format of the Module ini Files Defining the Scroll Screens for an Area Adding or Removing Fields on Your Result List...12 Adding Fields to SQL For Query Builder and Report Writer Use Adding Data Fields to the Selection Screens Adding Lookup Fields to the Selection Screens...13 Modifying the Prism.ini File to Set the Default Settings Changing the Default Report Logo Changing the Default Runcode Changing the Default Page Orientation Changing the Default Margins Suggestion for Making Global Changes to the ini Files ERROR MESSAGES AND TROUBLESHOOTING Introduction Data Source Name Error Message User Name Error Message Database Login Screen Appears INDEX... 1 i

4

5 Overview INTRODUCTION Prism enables users to access live information easily with just a point-and-click of a mouse. Prism s ease-of-use makes it an excellent query and reporting tool for nontechnical and occasional users. Prism includes a report writer that enables the user to format query results as desired. With Prism, users can generate their own lists, labels or merge files. The information available on each Prism window is application specific. Purpose of This Guide Use this guide to install Prism. The information in this guide can help you install Prism and configure the connection to the database using the Jenzabar CX ODBC driver. Intended Audience This guide is for use by the system users in your institution s computer center. System users include the Jenzabar system coordinator, Jenzabar system administrator, and programmer/analysts. Installing Prism 1 Introduction

6

7 Introduction GETTING STARTED The following tasks provide important information you need to know before you begin to install Prism. Tasks Prior to Installation You need to accomplish the following general tasks at your institution before you install Prism: Install the Jenzabar CX ODBC Driver as instructed in the separate installation guide titled, CX ODBC Driver Installation Guide. Note the Data Source Name you use when installing the ODBC driver. Close any applications you may have open, but do not exit Windows. The Prism Setup program cannot install system files or modify shared files if they are already in use. This includes any toolbars, such as the Microsoft Office Toolbar. You will need a list of the user login names and their UIDs (Jenzabar user ID) of each individual to be granted access to Prism on each machine. Exiting from the Setup Program You can exit from the Prism Setup program before completing the installation whenever the Cancel button appears. Follow these steps to exit before completing the installation: 1. Click on Cancel. The Exit Setup box appears. 2. Click on Exit Setup. You have exited the Setup program. You will need to rerun the Setup program at a later time to complete the installation of Prism. Installing Prism 3 Getting Started

8

9 PC INSTALLATION Introduction This section provides information to install Prism on administrators and users PCs. PC Hardware Requirements An IBM-compatible PC with the following processor specifications: Minimum: 486 Processor or greater Memory: The following Random Access Memory (RAM) configuration for the PC is: Minimum: 8 MB Hard-disk Storage Requirements: Minimum: 20 MB or greater of free disk space Software Requirements Microsoft Windows 3.1 or higher operating system. Database Connectivity Prism is a Client/Server application that runs in a Windows 16-bit environment. You can use any ODBC compliant database with this product. The application uses a database server for data access and the user s PC for the user interface. We recommend the Jenzabar CX ODBC driver. Future Updates Future updates to Prism will be distributed in diskette form. Instructions for keeping locals will be included if needed. Installing Prism 5 Installation

10 Installing Prism How to Install on a PC Drive or Network Server Drive Follow these steps to install Prism in the desired location using Windows or Windows Start Windows or Windows Close any applications that are open, such as those that are opened by your Start Menu. This includes any toolbars that may be on your desktop, such as the Microsoft Office Toolbar. 3. Begin the installation program. If you are using Windows 3.1, click on File Manager. Select your PC drive. Double click on setup.exe. If you are using Windows 95, click on Start from the Taskbar. Click on Run. The Run box appears. In the Run box, on the Command Line, enter the path for the Prism setup program. Insert the disk marked Prism Disk 1 in your PC drive A (or B) and enter: a:\setup.exe (or b:\setup.exe). Click on OK to continue. 4. The Setup box appears. This indicates the installation program, which will be used to install Prism, is being loaded. The program will appear to return to the PC, but it is still working beyond the time the 100% shows in the box. 5. The Welcome to Prism box appears. Click on Next. Installation 6 Installing Prism

11 6. The Destination Directory window appears. The default destination directory is c:\prism. If you want to choose another directory, click on the Browse button and select a different path. Click on Next. 7. A Select Program Folder Window appears. If you want to install Prism in a program group other than one named Prism, change the program group name. Click on Next. 8. The settings you have selected are displayed for your confirmation. If you need to change the Destination Directory, Click on Back to make those changes. To continue with the installation, click on Next. The setup program begins to install the files for Prism. Insert the diskettes as requested. 9. When the files are installed, the Setup Complete box appears. Click on Finish. The installation is complete. Note: If problems occur, reboot the PC, disable any virus-checking software, and run setup.exe again. 10. Verify the database connectivity in sql.ini. Edit the sql.ini file with notepad or another compatible editor. This file is located in the c:\prism directory. The file should read as follows: [winclient.dll] condll=sqlodbw [infogtwy] REMOTEDBNAME=EdVanta,DSN=EdVanta [odbctr] REMOTEDBNAME=EdVanta,DSN=EdVanta If the ODBC data source name you noted earlier (during ODBC installation) is not EdVanta, you need to change the DSN to be equal to the name of your data source. For example, if the data source is cars, the two lines would look like this: REMOTEDBNAME=EdVanta,DSN=cars Save and exit the file 11. Add appropriate user information to the C:\Prism\Etc\Prism.pwd file. (See section Suggestions for Installing on Users PCs for information about performing this step on only one PC.) Edit the Prism.pwd file with notepad or another compatible editor. Open the first line. Copy the line provided. Paste the copied line in the line you created above. Change the first field on the line to the user name of the person using this machine. Change the number in the second column to the UID of the person using this machine. Change the third column to the actual fullname of the person using this machine. Save and exit the file. Installing Prism 7 Installation

12 Test the Connection from Prism to Your Database This test will verify that you can successfully connect to the database via the ODBC driver. 1. Start Prism. (It can be found in the Prism program group). 2. Enter your login name and password. 3. Click on Login. 4. You should now see the various module icons in full color. Suggestions for Installing on Users PCs After one PC has been set up and you have verified that you can attach to the database using Prism, you may want to do the following to ease the installation on other users machines. You can use the sql.ini file that you have already set up if all your users have the same data source name for their ODBC driver. Copy the sql.ini to either a network drive or a diskette. In place of step 10 of the Installation Instructions, copy the sql.ini file from the network or diskette to c:\prism (or whatever default directory you used). You can give yourself access to Prism from each user s PC without re-editing the Prism.pwd file; or you can set all PCs up for everyone to access. Copy the version of the solis.pwd you want to use to a network drive or to a diskette. This is the one you set up on the first machine. In place of step 11 of the installation instructions, login through Prism. On the main screen there should be an Admin button. Click on this button. The following screen should appear: Now you can add the users by knowing their login name and UID. Click on the Add button and enter the user name, an English name, and the UID of the individual. Set the necessary permissions on each individual by clicking on either the View or None option beside each area. (See the next section to determine what area of permissions each individual will need.) Installation 8 Installing Prism

13 Editing the User Permissions to Restrict the Data Prism will never overwrite the permissions that are already on the database, but you might want to restrict the users from seeing various modules or details. The following lists the areas and the access allowed to the user if the View option is set: Leads Admissions Students Financial Aid Alumni Inst Advance Finance Grades Supervisor Allows the user to view lead information. If your institution does not use the lead record portion of the product, then set this option to None for all users Allows the user to view admissions information. Allows the user to view student and course information. Allows the user to view financial aid information about students and funds. Allows the user to view alumni information. Allows the user to view donor, gift, and pledge information. Allows the user to view financial data. Allows the user to view students grades and GPA in applicable areas. (The student area shows grades and GPA if this option is set to View.) If this option is disabled, the user will see all other student data. Provides access to the Admin screen. Permission to the Admin screen allows the user to update the permissions for the users on that particular PC. Installing Prism 9 Installation

14 Modifying ini Files for Local Customizations Prism uses ini files. Several of these files can be customized for user preferences. The modulearea ini files contain the settings for fields on the Selection screen, records to be included for Query Builder, the fields to display in the result list window, and the scroll screen that can be accessed by an area. The prism.ini file contains the global settings for each particular installation of Prism. In this file you can change the default report logo and the default runcode. Modifying the Module Area ini Files Each module area has one or more ini files associated with it. These files are in the c:\prism\etc directory (assuming you installed the program to the default directory). You can use the following list as a reference to determine which ini file goes with which selection screen: Modules Area: Selection Screen: File Name: Leads Lead Led.ini Admissions Admissions Adm.ini Financial Aid Applicants Fa1.ini Recipients Fa2.ini Funds Fa3.ini Students Student List St1.ini Catalog St2.ini Alumni Alumni Alu.ini Advancement Donors Ia1.ini Gifts Ia2.ini Pledges Ia3.ini Installation 10 Installing Prism

15 Format of the Module ini Files The following is an example of a module ini file. A description of each section is given below as well as how to modify these files for your particular institution. [Setting] KeyFields=id_rec.id SecurityTable=prog_enr_rec [Scroll Screens] Address=Yes Employment=No [Base SQL] SELECT id_rec.id, id_rec.fullname, prog_enr_rec.prog FROM id_rec, prog_enr_rec WHERE prog_enr_rec.id = id_rec.id [Select Fields] Field1=LookUpField,profile_rec.ethnic_code,Ethnicity,"SELECT ethnic Code,txt Description FROM ethnic_table" Field3=DataField,stu_acad_rec.reg_stat,Reg Status,Upshift Section Definitions Settings section - Contains the definition for the KeyFields and SecurityTable values. The SecurityTable is a record that must exist before the value found in the KeyFields can be printed to the screen. For example, with the two values as defined above you should never end up with a person in your result list who does not have a prog_enr_rec even if that person is in the id_rec. Scroll Screens - This section tells Prism which of the scroll screens to make available to this portion of Prism. You can access these screens from the More Info menu on the List Window (Result List). Valid values are: Screen Name Address Accomplishment Contact Education Exam Interest Involvement PreferredAddress AlternateName Relationship Constituency Employment Record / Description aa_rec / This is a scroll screen from the alternate address record. Accomp_rec / Accomplishment scroll screen. ctc_rec / This uses the logic in the ent_sel_crit table where available to determine what contacts to show for a given area. ed_rec / Education scroll screen. exam_rec / Examination scroll screen. int_rec / Interest scroll screen Involve_rec / Involvement scroll screen. Uses ADR-like logic to produce default mailing address information. Addree_rec / Altername Name scroll screen. Relation_rec / Relationship scroll screen. Consstat_rec / Constituent Status scroll screen. emp_rec / Employment scroll screen. Installing Prism 11 Installation

16 Base SQL - This section contains the central information for each Prism area. Any field listed in this select statement shows on the Result List (List Window). The records listed in the from statement are the records from which you can see the fields in both the report writer and the query builder. Prism does what is known as smart outer joins in dealing with outer joins on records. Almost any ini file you look at will have an outer join to the profile_rec. Should you decide to query on only female students, Prism will remove the outer from the query. Select Fields - This section of the ini file defines the fields to be used for querying on the selection screens. Not all fields have to be used when querying. You would want to have fields on this screen that would be regularly used for queries by the user. This section allows you to put various query commands on the fields such as doing lookups and upshifting data. A maximum of 15 fields can be on any one selection screen. Three of these fields will display on the left column of the screen, and the rest will be in the right column. Defining the Scroll Screens for an Area Several of the scroll screens are available in Prism. You can customize which scroll screens can be viewed. To customize the scroll screens for an area, do the following: 1. Open the ini file to be modified in a text editor such as Notepad. (See the section titled Modifying the Module Area ini files for help in determining which file to modify.) 2. Find the section entitled [Scroll Screens]. 3. Set each item equal to No or Yes as desired. (A line with a scroll screen enabled will look like this: Address=Yes.) If you want to disable this screen, replace the Yes with a No. 4. Save your changes and exit. Adding or Removing Fields on Your Result List You may have noticed that each ini file has a SQL section. This SQL section provides Prism with its instruction on how to display various items. One such instruction defines which database fields will be displayed on the Result List (list Window) screen. This is the information your users want to see most often. To change this information: 1. Open the ini file to be modified in a text editor such as Notepad. (See the section titled Modifying the Module Area ini files for help in determining which file to modify.) 2. Find the section entitled [Base SQL]. 3. Add or remove the fields in the SELECT portion of the statement. (These are the fields which appear in the Result List.) If necessary, modify the FROM and WHERE clauses to include the database record from which these fields are from and join them to the appropriate records. 4. Save your changes and exit. Installation 12 Installing Prism

17 Adding Fields to SQL For Query Builder and Report Writer Use Prism has a report writer and a query builder which allow the user to choose fields from the database and use them. These two areas of the product also obtain their information from the SQL statement of the ini file. The Result list uses only those fields specified in the SQL statement. The Query Builder and Report Writer use the tables listed in the FROM section of the SQL and pull in all fields from those records including locally added fields that are not part of the standard Jenzabar CX product. To modify which records from the database are used, do the following: 1. Open the ini file to be modified in a text editor such as Notepad. (See the section titled Modifying the Module Area ini files for help in determining which file to modify.) 2. Find the section entitled [Base SQL]. 3. Add or remove the fields in the FROM portion of the statement. (These are the records from which Query Builder and Report Writer find their data fields.) If necessary, modify the WHERE clauses to join the records in the FROM portion of the statement. Make sure you do not remove any records that are used in the SELECT portion. 4. Save your changes and exit. Adding Data Fields to the Selection Screens You can modify the selection screen defining what fields the user can easily query on to meet your needs. You can add a total of 15 fields, either lookup fields or data fields. Data fields are those fields that do not have corresponding tables to use for validating the data being entered. Year is an example of a data field. To add a data field to your selection screen, do the following: 1. Open the ini file to be modified in a text editor such as Notepad. (See the section titled Modifying the Module Area ini files for help in determining which file to modify.) 2. Find the section entitled [Select Fields]. 3. Add a field using the following syntax: FieldX=DataField,id_rec.zip,Zip Code,Upshift Where FieldX is the field number you are adding (you can use any number between 1 and 15 if it does not already exist on the screen). DataField is a Keyword and should come next, followed by the actual database field. The third portion (after the second comma) is the label you want to have displayed on the screen for this field. The final portion of the screen is optional. If you want to have the value entered by the users in all capital letters, enter the word Upshift. 4. Save your changes and exit. Adding Lookup Fields to the Selection Screens The other type of field that can be displayed on a Selection Screen is a lookup field. These are data fields where the user can pick from a valid value stored in another table. To add a lookup field, do the following: 1. Open the ini file to be modified in a text editor such as Notepad. (See the section titled Modifying the Module Area ini files for help in determining which file to modify.) 2. Find the section entitled [Select Fields]. Installing Prism 13 Installation

18 3. Add a field using the following syntax: FieldX=LookUpField,id_rec.st,State,"SELECT st Code,txt Description FROM st_table" Where FieldX is the field number you are adding (you can use any number between 1 and 15 if it does not already exist on the screen). LookUpField is a Keyword and should come next followed by the actual database field. The third portion (after the second comma) is the label you want to have displayed on the screen for this field. The last portion of the statement is a select statement telling Prism what table in the database to use for the lookup. The syntax of this statement is a simple select-from SQL statement. The words Code and Description used above are the labels for st and text in the lookup pop-up box. 4. Save your changes and exit. Modifying the Prism.ini File to Set the Default Settings The Prism.ini file contains several defaults for the way Prism will run. Some of these defaults can be overwritten during the running of Prism, but it would probably be helpful to set the defaults and only change them when you want something different. In the Prism.ini file you can set the default logo for the reports (or set it to blank to disable it), set the default mail runcode, set the default page orientation, and set the default margins. Changing the Default Report Logo The default logo specified in the Prism.ini is printed on several reports. This logo can be overwritten in the report writer. Prism as it is shipped includes the Jenzabar logo as the report logo. If you have a bitmap file to use in your report, make sure you know its location. If you do not have a logo to use, then you should create a blank bitmap as the logo. 1. Open the Prism.ini file (found in c:\prism by default) in a text editor such as Notepad. 2. In the Reports section change the ReportLogo to be the directory and bitmap file you want to use. 3. Save and exit the file. Changing the Default Runcode The default runcode refers to the runcode you want to use by default when using the ADR logic to create addresses. This is defaulted to PERM when shipped from Jenzabar. To change this, do the following: 1. Open the Prism.ini file (found in c:\prism by default) in a text editor such as Notepad. 2. In the Reports section change the MailRunCode to the adr runcode you want to use. 3. Save and exit the file. Changing the Default Page Orientation The default page orientation refers to the layout of the printout from the Print Current List option. This is set to Portrait when shipped from Jenzabar. If you want to change this to Landscape, do the following: 1. Open the Prism.ini file (found in c:\prism by default) in a text editor such as Notepad. 2. In the Reports section change the Orientation from Portrait to Landscape. 3. Save and exit the file. Installation 14 Installing Prism

19 Changing the Default Margins The default margins are those margins used by the Print Current List option when printing your result list. These can be changed to suit your preferences by doing the following: 1. Open the Prism.ini file (found in c:\prism by default) in a text editor such as Notepad. 2. In the Reports section change the various Margin options to suit your needs. (The options are TopMargin, BottomMargin, RightMargin and LeftMargin.) 3. Save and exit the file. Suggestion for Making Global Changes to the ini Files After you have changed these files on one machine to have the desired setting, simply copy the modified files to the same directory on another machine. Be sure when moving the module area ini files that you have the fields defined to fields you allow that user to see. Prism uses database permissions to restrict the users from seeing data, but you can restrict what screens and to some extent, some fields by using the ini files. Installing Prism 15 Installation

20

21 Introduction ERROR MESSAGES AND TROUBLESHOOTING This section provides information about correcting problems when running Prism. Two problems can occur. You may receive an error message, or the database login screen for the ODBC driver may appear. Data Source Name Error Message You may receive the following error message from Prism: [Microsoft][ODBC DLL] Data source name not found and no default driver specified This error occurs if the C:\Prism\sql.ini file is not properly configured. 1. Follow step 10 detailed in the section How to Install on a PC Drive or Network Server Drive in this guide. 2. Determine the correct ODBC data source name by selecting Program from the Windows Start menu. Then, select ODBC and ODBC Administrator. In the ODBC Administrator window, note the line that ends with (CARS EdVanta 16-bit ODBC Driver 1.5). The characters prior to this statement are the data source name. In the following example, EdVanta 16 is the data source name. Example: EdVanta 16 (CARS EdVanta 16-bit ODBC Driver 1.5) The sql.ini file for the data source will look as follows: [winclient.dll] comdll=sqlodbw [infogtwy] REMOTEDBNAME=EdVanta,DSN=EdVanta 16 [odbctr] User Name Error Message You may receive the following error message from Prism: User Name not found This error occurs if the user trying to connect with Prism is not in the c:\prism\etc\prism.pwd file. To correct this error, open the file, copy the line provided (beginning with cisc:100) to a new line. Then change cisc to the user s login name. The 100 is changed to the user s UNIX UID number. You can change CIS Access to the user s name in English. For complete details about adding a user, see Step 11 in the section How to Install on a PC Drive or Network Server Drive in this guide. Database Login Screen Appears If the login screen for the ODBC driver appears, you can take several corrective actions as follows. 1. First, verify that the ODBC driver you installed on the HP or AIX box was meant for the version of Informix and HP or AIX that you are currently running. The diskette should contain a label identifying the HP or AIX, and Informix versions. If you have recently upgraded your system, this could be the problem. If you are in need of a different version, call the Jenzabar Support Center. Installing Prism 17 Troubleshooting

22 2. Test the UNIX portion of the ODBC driver by entering the following commands: cd /opt/cisodbc/bin (or the directory in which you put the ODBC driver)./cisinf4 (if cisinf4 is the ODBC executable sitting in this directory) If the process remains static and no error message occurs, the UNIX portion is okay. Do a Ctrl-C to return to a prompt. If this process failed, then the back-end (server) ODBC driver is not running correctly. Try installing a new version. 3. Verify the port number. telnet <machine name> <port number> For example, telnet carsdev 9055 where carsdev is the machine name of the system where the ODBC driver is installed, and 9055 is the port number it is installed to (defined in the /etc/services file). If you receive something similar to the following, the system is set up correctly. DEVdevi7: telnet carsdev 9055 Trying... Connected to carsdev.carsinfo.com Escape character is ^]. Do a Ctrl-] to end the test. If you did not receive the above sequence or an error message occurs, your setup of the /etc/services and/or /etc/inetd.conf file has failed. 4. If the above procedures were successful, check the PC component of the ODBC driver. (The following steps are for a Windows 95 PC and assume you are checking the 16-bit ODBC driver.) Click on Start. Select Program, then ODBC, and ODBC Administrator. Highlight the ODBC driver you installed and are currently using. Click on the Setup button. Verify the machine name and port number. Click OK. Click Close. Troubleshooting 18 Installing Prism

23 INDEX B base sql, 12 D database connectivity, 5 default report logo, 14 default settings, 14 F fields adding to SQL, 13 adding/removing, 12 data, 13 lookup, 13 H hardware requirements, 5 I ini files module format, 11 installation ODBC driver, 3 steps, 6 tasks prior to, 3 M margins, 15 O ODBC driver, installation, 3 P page orientation, 14 pre-installation tasks, 3 Prism, purpose of, 1 Q Query Builder, 13 R Report Writer, 13 requirements hardware, 5 software, 5 runcode, 14 S scroll screens, 11 defining, 12 settings section, 11 setup program canceling, 3 exiting from, 3 software requirements, 5 T troubleshooting, 17 U user permissions, 9 Installing Prism 1 Index