opt bus inspection system administrator manual

OPT Mobile Bus Inspection System

Administrator Manual 1.0

OPT Mobile Bus Inspection System: Administrator Manual

OPT Mobile Bus Inspection User Management System: Administrator Manual Last Updated 7/5/11

Copyright © 2009 The City of New York All Rights Reserved.


Revision History

Name Date Reason For Changes Document/ApplicationVersion

Abby Omotoso 8/17/09 Initial document 1.0


Table of Contents

1 Introduction......................................................................................................... 1-1 1.1 System Definitions....................................................................................... 1-1 1.2 Documentation Purpose ............................................................................... 1-1 1.3 Intended Audience ....................................................................................... 1-1 1.4 References.................................................................................................... 1-1

2 System Overview................................................................................................. 2-2 2.1 Product Scope .............................................................................................. 2-2 2.2 System Requirements................................................................................... 2-3

3 System Maintenance ........................................................................................... 3-1 3.1 Giving a User Access to the Client System ................................................. 3-1

3.1.1 Creating a New User Account ........................................................... 3-1 3.1.2 Giving a User Access to the Client System ....................................... 3-6 3.1.3 Giving a User Access to Table Variables .......................................... 3-9 3.1.4 Adding an Entry for a User in the Global Bay Form Builder.......... 3-13

3.2 Deleting Inspection Data............................................................................ 3-18 3.3 Working with Reports................................................................................ 3-21

3.3.1 Viewing an Activity Report on the Applications Page.................... 3-21 3.3.2 Creating Reports .............................................................................. 3-22

3.4 Using the Recycle Bin .............................................................................. 3-23

Table of Contents 1


Introduction 1-1

Section 1. Introduction

This introduction provides a definition of the OPT Mobile Bus Inspection System. In addition, this section contains an overview of this manual. This section of the documentation also includes other project information for the system.

1.1 System Definitions

The OPT Mobile Bus Inspection System has three parts:

1. The OPT Mobile Bus Inspection Client System: This is a mobile application that OPT inspectors use on a mobile device to record observations made after a detailed visual inspection of school buses that transport Pre-K and school-aged children.

2. The OPT Mobile Bus Inspection User Management System: This is a web application that Administrators use to create and manage user accounts for the OPT Mobile Bus Inspection Client System.

3. The OPT Mobile Bus Inspection Form Builder: Also known as the Global Bay Form Builder. This is a desktop application that Administrators use to do the following for the OPT Mobile Bus Inspection Client System: create forms and add user accounts.

1.2 Documentation Purpose

The purpose of the OPT Mobile Bus Inspection System Administrator Manual is to describe the following in detail:

• The operating environment of the OPT Mobile Bus Inspection Client System, User Management System, and Form Builder.

• The user account creation tasks that an Administrator must perform to give users access to the client system.

1.3 Intended Audience

The intended audience for this document consists of Administrators who must perform user and data management tasks for the OPT Mobile Bus Inspection Client System and support system users.

1.4 References

For additional information about the OPT Mobile Bus Inspection User Management System, please see GBmobile_Web_Application.pdf posted here:optdev on 'flscluster\Deptfolders'\Project Documentation\OPTMobileBusInspectionSystem\Manuals.


Section 2. System Overview

This section outlines the scope of the OPT Mobile Bus Inspection System. In addition, this section describes the user types of the system and the system requirements.

2.1 Product Scope

1. The OPT Mobile Bus Inspection Client System allows OPT inspectors to do the following:

• enter inspection observations • take pictures of inspection observations• view violations that are issued as a result of the inspection observations• synchronize inspection data with the server

2. The OPT Mobile Bus Inspection User Management System allows Administrators to do the following:

• create user accounts • edit user account information• create reports on inspection data• delete report and inspection data

3. The OPT Mobile Bus Inspection Form Builder (Global Bay Form Builder) allows Administrators to do the following:

• create forms for the OPT Mobile Bus Inspection Client System• add user accounts for the OPT Mobile Bus Inspection Client System

System Overview 2-2


2.2 System Requirements

1. The system requirements for running the OPT Mobile Bus Inspection Client System on a mobile device are as follows:

• Windows 32 OS (Desktop/Tablet/Vista)• Win CE 5.0/CE.Net 4.1• Windows Mobile 5• PPC 2002/2003

2. The system requirements for running the OPT Mobile Bus Inspection User Management System are as follows:

• Any J2EE compliant application server such as Apache Tomcat• IE 6 or higher

3. The system requirement for running the Global Bay Form Builder is as follows:• Java Runtime Environment J2RE 1.4.2

System Overview 2-3


Section 3. System Maintenance

This section of the Administrator Manual contains the information required to support the system in the production environment.

3.1 Giving a User Access to the Client System

Giving a user access to the OPT Mobile Bus Inspection Client System involves 4 steps in 2 different applications:

Using the OPT Mobile Bus Inspection User Management System:

1. Create a new user account.2. Give the user access to the OPT Mobile Bus Inspection Client System.3. Give the user access to table variables in the OPT Mobile Bus Inspection Client System.

Using the Global Bay Form Builder:

4. Add an entry for the user to the g_aryUserName array declaration.

The 4 steps are described in detail below.

3.1.1 Creating a New User Account

To create a new user account for the OPT Mobile Bus Inspection Client System:

1. Go to: http://165.155.104.59:8080/ap41/login.do2. Log into the OPT Mobile Bus Inspection User Management System.

System Maintenance 3-1


3. Click Setup.

4. Click Users.

5. Click Create.



6. Type in or select the user’s information:a. Type in the user’s First Name.b. Type in the user’s Last Name.c. Type in the User Name: This should be the user’s email address.d. Select the user’s Role: User (Inspector) or Administrator.e. Status: Select Active or Suspended.f. Show Records: Select All (The user can see inspections added by any user.) or

Associated (The user can see only the inspections that he or she uploaded to the server.)

7. Select the user preferences:a. Select the user’s Preferred Language.b. Select the users’ Time Zone.c. Select the user’s Date Format.d. Select the user’s Time Format.

8. Complete any other desired fields.9. Click Save.

a

bc

d

9

a

bc

d

e

f



A message similar to the following will appear: “Could not deliver the welcome message to user [email protected]. Please change password for this user and notify him of his password.”

Note Currently, the system is not set up to automatically email users their user name and password. You must manually send an email to users to inform them of their login credentials.

10.Click Change Password.

11.Enter the user’s login credentials:a. In the New Password box, type in the user’s password.b. In the Verify New Password box, type in the user’s password again.c. Choose the Secret Question that the user will have to answer when submitting a

request for a password reset. d. In the Answer for Secret Question box, type in the answer to the Secret Question

that you selected.

Notes 1. The password is case sensitive.2. Special characters are allowed in the password.3. The password cannot be more than 20 characters long.

12.Click Save.

bc

d

12

a



The account is created and the user is added to the user list in alphabetical order as shown below.

Note The user now has access to only the OPT Mobile Bus Inspection User Account Management System and will have access to these features: Change Password and Reports. To give the user access to the OPT Mobile Bus Inspection Client System, complete the steps listed below under Giving a User Access to the Client System.



3.1.2 Giving a User Access to the Client System

To give a user access to the OPT Mobile Bus Inspection Client System that will be used on a handheld device:

1. Click Applications.

2. In the Application Name column, click on the version of the client system to which you want to give a user access.



3. Click Add User.

4. On the left side of the screen, select the user who should have access to the OPT Mobile Bus Inspection Client System. You can use Ctrl + click to select multiple users.

5. Click

4

5

.



The user(s) will be added to the list of Selected Users on the right side of the screen.6. Verify that Synchronize application data is selected. 7. Click Save.

7

6

The user is added to the list of users associated with the selected application.

Note The user now has access to the OPT Mobile Bus Inspection Client System, however, the user does not have access to the table variables in the system. To give the user access to the table variables in the system, complete the steps listed below under Giving a User Access to Table Variables.



3.1.3 Giving a User Access to Table Variables

To give a user access to the table variables in the OPT Mobile Bus Inspection Client System:


2. Click Table Variables.



3. Click on the Edit link to the left of the table variable to which you want to give a user access.

4. Click Add User.



5. On the left side of the screen, select the user who should have access to the table variable. You can use Ctrl + click to select multiple users.

6. Click

5

6

.

The selected user(s) will be added to the list of Selected Users on the right side of the screen.7. Click Save.

7



The selected user(s) will have access to the table variable that you chose. The user is added to the user list in alphabetical order as shown below.

8. You can then repeat Steps 3-7 to give users access to additional table variables.



3.1.4 Adding an Entry for a User in the Global Bay Form Builder

The final step required in order to give a user access to the OPT Mobile Bus Inspection Client System is to add an entry for the user to the g_aryUserName array declaration in the Global Bay Form Builder.

Note In order for you to add the entry in the Global Bay Form Builder, your Administrator account must:

• Have access to the version of the Client System to which you are granting a user access. (For more information, please see Giving a User Access to the Client System on Page 3-1.)

• Have the help desk install the Global Bay Form Builder on your PC.

To add an entry for the user to the g_aryUserName array declaration in the Global Bay Form Builder:

1. Launch the Global Bay Form Builder.2. Click Tools > Preferences.

3. Verify that your User Name and User Password are entered.4. Click OK.

3

4



5. Click File > Load.

6. Select the application version to which you want to give a user access. In the example shown below, DOE OPT Bus Inspections_V3 is selected.

7. Click Load.

6

7



The application project will open.8. In the Objects window, click on the root folder of the application.

9. Click on the Properties tab.10.Click on the Script button.

The script will appear on the right side of the screen.11.Click inside the Script window.

9

11

10



12.Press Ctrl + F to search for the g_aryUsername array declaration.13.In the Find What box, type g_aryUserName.14.Click Find.

13

14

The application will find and highlight g_aryUserName.15.Add an entry for the new user after the last entry in the array:

a. Type , after the last entry.b. On the line after the last entry, type the new user’s user name and ID number

separated by a comma. (The user’s ID number should be one digit greater than the previous ID number.) For example, if the previous ID number were 015, you would type “[email protected]","016".

c. Verify that these characters appear at the end of the array: };.

ab

c



16.Click Save Application.

17.Click OK when this message appears:

The user will now be able to access the OPT Mobile Bus Inspection Client System.



3.2 Deleting Inspection Data

You can delete the inspections in any version of the OPT Mobile Bus Inspection Client System. You can delete entire inspections or only certain fields within particular inspections.

To delete inspection data:


2. Click Mass Delete Application Data.



3. From the Application Name list, choose the version of the OPT Mobile Bus Inspection Client System whose inspection data you want to delete.

4. If applicable, select specific fields to delete.5. If applicable, apply filter conditions to the data that you want to delete. For example, you can

apply a filter to delete inspections that were created before a particular date. 6. Click Next.

6

5

4



7. Select one ore more inspection records to delete. To delete all of the inspection records in the selected version of the system, do not select any inspection records.

8. Click Delete.

8

7

9. Click OK when this message appears.

The deleted records will be moved to the Recycle Bin from which you can restore or purge them. (For more information about using the Recycle Bin, please see Using the Recycle Bin on Page 3-23.



3.3 Working with Reports

Users and Administrators can create and view reports.

Note Users might have access to reports on only their inspections based on the rights given to them in their user account.

3.3.1 Viewing an Activity Report on the Applications Page

When users and Administrators first log into the system, they will see an activity report on the number of inspections (records) uploaded by each user as shown in the illustration below. You can access this report by clicking on the Applications tab.

The data is displayed as follows:

• Application Name: Name and version of the Client System with which the user uploaded the inspections.

• Uploaded Date: Date on which the user uploaded the inspection.• Records Uploaded: Number of inspections that the user uploaded.• Uploaded By: User name of the Inspector who uploaded the inspections.



3.3.2 Creating Reports

You can create reports on inspections, then export the reports to an Excel or .csv file.

To create, edit, delete, or export reports:

1. Click Reports.

2. You can then do either of the following:a. Click on a previously created report to view, edit or export it.b. Click on Create New Custom Report to create a new report.

For more information about creating reports, please see GBmobile_Web_Application.pdf posted here:optdev on 'flscluster\Deptfolders'\Project Documentation\OPTMobileBusInspectionSystem\Manuals.

b

a

a



3.4 Using the Recycle Bin

When you delete inspection or report data, that data is moved to the Recycle Bin. You can restore or purge the data from the Recycle Bin.

To restore or purge data from the Recycle Bin:

1. At the top right of the screen, click Recycle Bin.

2. Select one or more items.3. Click Restore or Purge.

2

3


opt bus inspection system administrator manual

Technology

system definitions

system overview

system requirements

system maintenance

inspection data

mobile device

mobile application

user access