DSG Maintenance Code Description

Transcription

1 DSG Maintenance Code Description Index maintenance_director_portal.php maintenance_secretary_portal.php maintenance_submittal_status.php maintenance_ s_folder.php maintenance_dir_submittal_log.php maintenance_member_participation.php maintenance_image_reminder_ .php maintenance_image_reminder_content.html maintenance_descriptors_images.php maintenance_images_posted_ .php maintenance_image_posted_content.html maintenance_review_reminder_ .php maintenance_review_reminder_content.html maintenance_reviews_visual_feedback.php maintenance_reviews_posted_ .php maintenance_review_posted_content.html maintenance_group_text_file.php (Obsolete see below) maintenance_update_member-group_data.php maintenance_member_list.php maintenance_member_list_export_inst.php maintenance_member_list_sort_name.php maintenance_member_list_ .php maintenance_member_list_sched.php maintenance_member_list_psa.php maintenance_encrypt_password.php bio_display_for_reviews.php dsg_member_list.txt group-xx-log.txt director-data.txt pid-dsg-stylesheet.css

2 Program name: maintenance_director_portal.php (not password protected) maintenance_secretary_portal.php (password protected) Description: The general structure of the DSG maintenance programs is as follows. All are called from these two maintenance portal programs. All programs are located in the www directory. All can be run repeatedly as revised or additional data becomes available for a group and round. maintenance_director_portal.php - Provides access to maintenance functions below. Not password protected. Intended for director s use only. maintenance_secretary_portal.php Subset of director portal described above and is password protected. Secretary has access to asterisked items below. It's primary purpose is to provide link to various maintenance programs. It allows director and secretaries to execute following: Check status of group submittals * Process and post Descriptor-Image * Process and post Review-Feedback * Send reminder s * Send posting confirmation s * Update Group Text file in www/dsgxx Show group activity log Generate random passwords View program documentation Return to Index page. Called by: Access directly via URL Calls: Entry point for maintenance programs Inputs: Group and round number and forms for data to launch other programs Outputs: Just calls other programs, no direct outputs Program name: maintenance_submittal_status.php Description: Program outputs a list of members who have and have not submitted images and reviews along with list of group members and s. Inputs: Group and round numbers passed Outputs: Displays status report

3 Program name: maintenance_ s_folder.php Description: Program outputs a list of input conformation, reminder, posting and notification computer generated s for the group. Inputs: Group and round numbers passed. files in dsgxx/ s folder. Outputs: Displays list of s that can be opened Program name: maintenance_dir_submittal_log.php Description: Program outputs a list of dates that the latest images and reviews were posted for each group. Called by: Director Maintenance portal Inputs: files in dsgxx/ s folder. Outputs: Displays list of groups with dates of postings for the latest round. Program name: maintenance_member_participation.php Description: Program outputs a list with the number of people in each group and the number that participated in the last round. It also includes some info on the group. This is used by the director to determine where to place new members. Called by: Director Maintenance portal Inputs: member list test file and image files for each group. Outputs: Displays list of groups with number of members and those participating in the latest round. Program name: maintenance_image_reminder_ .php Description: Send to remind group members who have not submitted images to do so. Inputs: Director or secretary s maintenance portal with form inputs Outputs: Sends s Program name: maintenance_image_reminder_content.html Description: Sample reminder that can be viewed from maintenance portal if want to see content. Outputs: Displays sample reminder

4 Program name: maintenance_descriptors_images.php Description: After images and descriptors have been uploaded by members, this program is run from the maintenance portal. This creates the rndxx folder and im_name.html files. The round number is entered so that if images for later rounds have been uploaded, they will be ignored. If multiple images or descriptors have been uploaded, they overwrite to older version so that only the latest one remains. It is okay to run the program multiple times if data has changed or new data is added. Review confirmation log that is generated. Also, check group home page to verify data integrity after the images have been posted. Inputs: Group and round numbers passed Outputs: Writes html files that display the images and descriptors for the round Program name: maintenance_images_posted_ .php Description: Generates notifying group members that images have been posted on the website. with form inputs Calls: director-data.txt Inputs: Director or secretary s maintenance portal with form inputs Outputs: Sends s Program name: maintenance_image_posted_content.html Description: Sample images-posted notification that can be viewed from maintenance portal if want to see content. Outputs: Displays sample image posted Program name: maintenance_review_reminder_ .php Description: Send to remind group members who have not submitted reviews to do so. Inputs: Director or secretary s maintenance portal with form inputs Outputs: Sends s.

5 Program name: maintenance_review_reminder_content.html Description: Sample review reminder that can be viewed from maintenance portal if want to see content. Outputs: Displays sample reminder Program name: maintenance_reviews_visual_feedback.php Description: After reviews and visual feedback have been uploaded by members, this program is run from the maintenance portal. It create the reviews html and vf html files. The reviews text files are left in the reviews folder so that the program may be rerun if info is changed or added. If multiple versions of the reviews and visual feedback are uploaded, they will overwrite so that only the latest version will be used. Thumbnails of the images are created and stored in the reviews/thumbnails folder. A thumbnails folder is created if it does not exist. The images, descriptors, reviews txt and html files, thumbnails and visual feedback are deleted for all rounds that are not one of the 4 latest rounds. These files used to be moved to the Saves folder, so you may find old data in these folders which may be purged. Check review confirmation log and group home page to verify data integrity after posting reviews. Look for escape characters and other problems in the reviews html files. Inputs: Group and round numbers, pswd Outputs: Builds reviews and visual feedback html files for each maker Program name: maintenance_reviews_posted_ .php Description: Program to send s to makers after reviewss are posted. Also copy to secretary and conformation to director Calls: director-data.txt Inputs: Director or secretary s maintenance portal with form inputs Outputs: Sends Program name: maintenance_review_posted_content.html Description: Sample reviews-posted notification that can be viewed from maintenance portal if want to see content. Outputs: Displays sample reviews posted

6 Program name: maintenance_group_text_file.php (Obsolete replaced by programs below) Description: A members txt file is in each dsgxx folder that contains information about the group including the names and addresses of the group members, commentator and secretary and the number of images. This program helps maintain this data. It is only available on the director s maintenance portal. To change a name or address, just edit data in the form. To delete a member, check the box. To add a new member, put name and in any of the blank boxes. General program flow is to execute the complete program each pass with whatever data is available. After form is submitted, the form-action goes back to beginning of the program and starts over. Values exist for the variables in the POST statements. The if statement is now false, thus the else is executed and the rest of the program is executed. Assumes there are no titles following the last name (Sr, Jr, PhD...) Inputs: Group number Outputs: Revised member txt file Program name: maintenance_update_member-group_data.php maintenance_member_list.php maintenance_member_list_export_inst.php maintenance_member_list_sort_name.php maintenance_member_list_ .php maintenance_member_list_sched.php maintenance_member_list_psa.php Description: The dsg_members_list.txt file is now the master member database. It contains not only the info to generate the members txt file, but other group and member data. This series of programs allows this database to be maintained and provides various displays of the data for the directors. The dsg_member_list.txt file is in the root directory and contains information about each group including the names and addresses of the group members, commentator and secretary, frequency of rounds and the number of images which are used to generate the group txt file. The maintenance_update_member-group_data.php program helps maintain this data. It is only available on the director s maintenance portal. To change a info, just edit data in the form. To delete a member, delete group number. To render a group member inactive, place a C, M or R in front of the group number. To add a new member, put name and in any of the blank boxes. General program flow is to execute the complete program each pass with whatever data is available. After form is submitted, the form-action goes back to beginning of the program and

7 starts over. Values exist for the variables in the POST statements. The if-statement is now false, thus the else is executed and the rest of the program is executed. Assumes there are no titles following the last name (Sr, Jr, PhD...) Called by: Director maintenance portal Inputs: Group number Outputs: Revised member txt file The remaining programs provide various looks at the database. Visit the director s portal for a description. Program name: maintenance_encrypt_password.php Description: Can generate random passwords and use SHA-1 algorithm to encrypt group password and provide 20 digit hash value to be copied into.access file for group Outputs: Password and associated 20 digit hash value Program name: dsg_member_list.txt Description: Database in tab delimited text file that contains all info on groups and members. It is the master database that used for all programs. Called by: maintenance_update_member-group_data.php Outputs: Generates group txt file and is queried by member list programs Program name: group_xx_log.txt Description: Contains a log of all recent activities. It is located in the activity_log folder in the root directory. Called by: maintenance_director_portal.php Outputs: Provides trouble shooting data

8 Program name: director-data.txt Description: Contains directors name and . Can be updated when director changes. Called by: maintenance_images_posted_ .php Outputs: Provides director info to programs via require Program name: pid-dsg-stylesheet.css Description: css stylesheet used by most of these programs Called by: uses link statement Outputs: Specific style definitions