maintenance mobile user installation guide · 2010-06-11 · maintenance mobile user installation...

Exor Corporation Limited

The Global Leader in

Infrastructure Asset Management

Maintenance Mobile

User Installation Guide

Exor Leading the way in Infrastructure Asset Management Solutions...

Page 1

1. Quality Assurance Statement

Document Details

File: MaintenanceMobile_User_Install_Guide_1.3.doc

Prepared by: Craig Pay

Manual Name: Maintenance Mobile User Installation Guide

Reviewed by:

Version: 1.3

Approved for issue by:

Date of Issue: March 2010

Product Manager: Craig Pay

File Name: C:\Documents and Settings\Craig Pay\My Documents\My Mobile Docs\Maintenance

Mobile\MaintenanceMobile_User_Install_Guide_1.3.doc

Document Version Control

Revision Date By Page Description

1.0 June 2006 CP

1.1 August 2006 CP Appendix A removed (referred to changes from previous ePAQ software). Screen grabs changed to reflect updates to software.

1.2 March 2009 CP Appendix D: Defects Rules, added.

1.3 March 2010 CP Screenshots updated throughout. Removed references to Pocket PC 2002 throughout. Section 5.2: FTP Settings. Section re-written, content added for upload and download settings. Appendix B: Various keys removed or added. Appendix E: Determe Your Windows Mobile version, added.


Page 2

2. Contents

1. Quality Assurance Statement ...................................................................................................................... 1

2. Contents ....................................................................................................................................................... 2

3. Requirements ............................................................................................................................................... 3

4. Installing Maintenance Mobile ...................................................................................................................... 4

4.1 Desktop Installation (default) ............................................................................................................... 4

4.2 Device Installation (optional) ................................................................................................................ 8

5. Running Maintenance Mobile for the First Time ........................................................................................ 11

5.1 Basic Settings .................................................................................................................................... 11

5.2 FTP Settings ...................................................................................................................................... 12

5.3 Storage Card Settings (optional) ........................................................................................................ 16

Appendix A: Establishing an ActiveSync Partnership ........................................................................................ 19

Appendix B: Maintenance Mobile Registry Keys ............................................................................................... 20

C.1 Application Settings Key .......................................................................................................................... 20

C.2 Microsoft SQL CE Key ............................................................................................................................. 25

Appendix C: Maintenance Mobile Files and Folders ......................................................................................... 27

Appendix D: Defects Rules ................................................................................................................................ 28

D.1 Introduction .............................................................................................................................................. 28

D.2 Rules Overview ........................................................................................................................................ 28

D.3 Default Screen Layout and Hidden Fields ............................................................................................... 30

D.4 Example rules.ini File ............................................................................................................................... 31

D.5 Distributing Your rules.ini File .................................................................................................................. 32

Appendix E: Determine Your Windows Mobile Version ..................................................................................... 33


Page 3

3. Requirements

This document requires Maintenance Mobile 4.2.0.

Maintenance Mobile is designed for PDA laptop mobile devices running the Microsoft Windows Mobile operating system (see below for supported versions).

Maintenance Mobile requires Microsoft .NET Compact Framework 1.0 SP3 or higher on your mobile device.

Whilst some versions of Pocket PC and Windows Mobile are shipped with a version of .NET Compact Framework already installed, it may not be the latest. If in doubt please download and install .NET Compact Framework 1.0 SP3 from here:

http://www.microsoft.com/downloads/details.aspx?FamilyID=a5a02311-194b-4c00-b445-f92bec03032f&DisplayLang=en

To determine the version of Pocket PC or Windows Mobile on your device refer to Appendix E: Determine Your Windows Mobile Version.

Maintenance Mobile supports:

• Windows Mobile 5.0 for Pocket PC

• CE .NET 5.0

• Windows Mobile 6.x Professional and Classic


Page 4

4. Installing Maintenance Mobile

4.1 Desktop Installation (default) Desktop installation involves running an EXE installer on a desktop PC connected to your mobile device using Microsoft ActiveSync. The Maintenance Mobile software is automatically copied to your mobile device and installed.

For desktop installation you will require the following:

1. Microsoft ActiveSync must be installed on a desktop PC and you must have a full or guest partnership established with your mobile device.

2. You will need a copy of the Maintenance Mobile desktop installer copied to your desktop PC (MaintenanceMobile_PPC.exe).

Before installing Maintenance Mobile make sure that your mobile device is connected to your desktop PC using Microsoft ActiveSync and that a full or guest partnership has been established (for further help refer to Establishing an ActiveSync Partnership).

Now that your mobile device is connected to your desktop PC using ActiveSync, double-click the MaintenanceMobile_PPC.exe file to begin the installation. You should see the following screen:


Page 5

Select 'Next' to proceed to the License Agreement screen:

Agree to the license agreement and select 'Finish' to continue. You should now see the following Add/Remove Programs (App Manager) screen:


Page 6

When Maintenance Mobile has finished copying to your mobile device you will see the following screen:

Select 'OK' to close the desktop installer and check your mobile device.

You should see a prompt on your mobile device similar to the following confirming whether you should install the software and you may also be prompted for a location to install the software to (Maintenance Mobile may be installed to any location on your mobile device). After you have made your selection select 'Install' to begin installing the software:

�

Note: The above screen may vary depending on the version of operating system you have installed on your device.


Page 7

Once the installation has completed the following screen will be displayed and you may select 'OK' to finish:

You have now successfully installed Maintenance Mobile!


Page 8

4.2 Device Installation (optional) Device installation involves running a CAB installer on your mobile device. The CAB file must be copied to your mobile device either using Windows Explorer and Microsoft ActiveSync, or it must have been previously copied to a storage card that is inserted into your device.

For device installation you will require the following:

1. You will need a copy of the Maintenance Mobile device installer copied to your mobile device (MaintenanceMobile_PPC.CAB).

If you intend to copy the CAB file to your mobile device, make sure that your device is connected to your desktop PC using Microsoft ActiveSync and that a full or guest partnership has been established (for further help refer to Establishing an ActiveSync Partnership).

Once you have the CAB file on your mobile device, navigate to the Programs folder on your mobile device (Start > Programs) and select the File Explorer icon:

�


Page 9

In this example we have previously copied the CAB installer to a storage card which we have now inserted into the device. Using File Explorer on your mobile device, navigate to the location where you have copied your own CAB installer:

�

Using your stylus select the Maintenance_PPC file to begin installation:

�

Note: The above screen may vary depending on the version of operating system you have installed on your device.


Page 10

Once the installation has completed the following screen will be displayed and you may select 'OK' to finish:

You have now successfully installed Maintenance Mobile!


Page 11

5. Running Maintenance Mobile for the First Time

When you run Maintenance Mobile for the first time you might need to change your configuration, as detailed below. Ask your systems administrator for your Maintenance Mobile settings.

5.1 Basic Settings After installing Maintenance Mobile navigate to the Programs folder on your mobile device (Start > Programs) and click the Maintenance Mobile icon:

�

The first time you run Maintenance Mobile you might want to check your settings. Navigate to Tools > Options > Settings from the Maintenance Mobile menu:

�


Page 12

5.2 FTP Settings In order to use the Send & Receive feature to send completed inspections to an FTP server, as well as downloading new inspections, you will need to configure your FTP settings.

To begin configuring your FTP settings navigate to Tools > Options > Settings from the Maintenance Mobile menu.

You will need to configure your Meta Download, Routes Download and Routes Upload as follows.

Select the Meta Download tab and you will see the default settings configured in the application:

�

Enter your own Meta Download FTP settings:

�


Page 13

Select the Routes Download tab and you will see the default settings configured in the application:

�

Enter your own Routes Download FTP settings:

�


Page 14

Select the Routes Upload tab and you will see the default settings configured in the application:

�

You will now need to select either ‘Upload Routes to server’ or ‘Upload Routes to desktop PC’:

�


Page 15

If you selected ‘Upload Routes to server’ then enter your own settings:

�

If you selected ‘Upload Routes to desktop PC’ then enter your own settings:

�

Once you have finished entering your FTP settings click the OK button to return to the main screen.


Page 16

5.3 Storage Card Settings (optional) If you intend to use a storage card (such as an SD or CF memory card) to store your data files (including your database), then you will need to configure your Storage Card settings.

To begin configuring your Storage Card settings navigate to Tools > Options > Settings from the Maintenance Mobile menu:

�

Select the Files tab and you will see that by default a storage card is not selected:

�


Page 17

Select the 'Store data files on storage card' checkbox then use the drop-down menu to see which cards have been recognised by the application:

�

Select the storage card you wish to use then select the OK button to save your settings:

�


Page 18

If you are prompted to create either a new data files folder or new database; select 'Yes' to return to the main application screen

�


Page 19

Appendix A: Establishing an ActiveSync Partnership

You can tell if ActiveSync is installed if you have this icon: next to your clock (usually located in the bottom right hand corner of your screen).

To begin establishing an ActiveSync partnership, connect your mobile device to your desktop PC and the following screen should appear:

Select the 'Cancel' button and your mobile device will be connected using a Guest partnership as follows:

Your mobile device is now connected to your desktop PC using a Guest partnership. You should also see this

icon: next to your clock.


Page 20

Appendix B: Maintenance Mobile Registry Keys

There now follows a list of registry keys and values used by the Maintenance Mobile application. Each registry value includes a complete description including any hard-coded default data values and any appropriate ranges of alternate values.

Two registry keys are created by the application: HKEY_LOCAL_MACHINE\Software\Exor\Maintenance is used to store application data and HKEY_LOCAL_MACHINE\Software\Microsoft\SQLCE 2.0 is created to support the SQL CE files included in the installation.

The standard Maintenance Mobile desktop and device installers do not automatically create all registry values in HKEY_LOCAL_MACHINE\Software\Exor\Maintenance during installation. Registry values are created by the application as and when they are required during runtime.

For certain registry values, a default data value is hard-coded into the application which is used if a registry value is not present. For these registry values, manually creating a value and assigning a data value overrides the hard-coded value. A suitable registry editor for Windows Mobile devices is 'PHM Registry Editor'.

Note: Editing your registry may damage your device or corrupt software installed on your device. Exor Corporation Ltd cannot be held responsible for any such damage.

C.1 Application Settings Key Key: HKEY_LOCAL_MACHINE\Software\Exor\Maintenance

Value: AllowClose

Type: DWord

Default Data: 0

Description: The Windows Mobile operating system will close down applications if it decides they are no longer required. With this value set to 0 the operating system cannot close down the application without the user manually existing the application. Setting this value to 1 allows the operating system to close down the application without user intervention.

Value: DatabaseName

Type: String

Default Data: "MMGR"

Description: This value specifies the filename of the SQL CE database (e.g. MMGR.SDF) that the application will use. If the application detects that this database is not present when the application is started, then a new database will be created. The database is create/located at the folder location as specified in the DataFilesFolder registry value.


Page 21

Value: DataFilesFolder

Type: String

Default Data: "\DCD Files\MMGR"

Description: This value specifies the folder where the data files (routes and inspections files) are located. It also specifies where the database is located (see the DatabaseName value above). A number of sub-folders are present in the data files folder. If the application detects that this folder or any of its sub-folders are not present when the application is started, then new folders will be created.

Value: Default

Type: String

Default Data: ""

Description: This value is not used by the application.

Value: DownloadUploadSuffix

Type: String

Default Data: ""

Description: This value specifies a wildcard to be used for downloading or uploading files during a Send/Receive.

Value: DownloadWarning

Type: DWord

Default Data: 100

Description: This value specifies the maximum size in kilobytes of files that will be automatically downloaded without warning during a Send/Receive. For files that are about to be downloaded that are larger than this value, a warning will be displayed to the user.

Value: ExportOnlyCompleted

Type: DWord

Default Data: 0

Description: This value specifies whether only completed routes (i.e. routes with no incomplete Sections) will be exported.

Value: FirstRun

Type: DWord

Default Data: 0

Description: This value determines whether this is the first time that Maintenance Mobile has been run, and if so it sets various registry keys such as Download / Upload Folder, Download / Upload Username and Download / Upload Password. It then sets itself to a value of 1.

Value: FontSize

Type: DWord

Default Data: 8

Description: This value determines the size of fonts (in points) used in the application.


Page 22

Value: GPSComPort

Type: String

Default Data: "COM8"

Description: This value specifies the COM port used by Maintenance Mobile to listen for GPS signals.

Value: GPSTimeout

Type: DWord

Default Data: 30

Description: This value specifies the length of time in seconds that Maintenance Mobile will wait for a response from the GPS unit.

Value: MetadataFilename

Type: String

Default Data: "EDIF.PED"

Description: This value specifies the name of the metadata filename to be loaded.

Value: MetaDownloadFolder

Type: String

Default Data: "Maintenance/download"

Description: This value specifies the name of the FTP folder where the metadata filename is downloaded from.

Value: MetaDownloadFTPAddress

Type: String

Default Data: "84.22.180.58"

Description: This value specifies the URL address of the FTP server where the metadata file is downloaded from.

Value: MetaDownloadPassword

Type: String

Default Data: "tryme"

Description: This value specifies the password used to log on to the FTP server as specified in the MetaDownloadFTPAddress value. See also the MetaDownloadUsername value.

Value: MetaDownloadUsername

Type: String

Default Data: "epaq"

Description: This value specifies the username used to log on to the FTP server as specified in the MetaDownloadFTPAddress value. See also the MetaDownloadPassword value.


Page 23

Value: NoDial

Type: DWord

Default Data: 0

Description: This value specifies whether the application will 'dial' the default internet connection on the mobile device prior to a Send/Receive. Setting this value to 1 disables this feature.

Value: NoDownloadMetaIfNewer

Type: DWord

Default Data: 0

Description: This value specifies whether metadata files with a newer date/time than the current metadata file on the device will be downloaded. Set this value to ‘1’ to disable checking for newer metadata files.

Value: NoMandatoryDefectPriority

Type: DWord

Default Data: 0

Description: This value specifies whether defect priorities are required. By default this value is set to zero, meaning that defect priorities are mandatory. Set this value to ‘1’ to allow defects to be saved with no priority.

Value: PrePend

Type: DWord

Default Data: 0

Description: This value specifies whether the inspector’s initials will be added to exported (or uploaded) completed inspection files.

Value: RoutesDownloadFolder

Type: String

Default Data: "Maintenance/download"

Description: This value specifies the name of the FTP folder where Routes files are downloaded from.

Value: RoutesDownloadFTPAddress

Type: String

Default Data: "84.22.180.58"

Description: This value specifies the URL address of the FTP server where Routes files are downloaded from.

Value: RoutesDownloadPassword

Type: String


Description: This value specifies the password used to log on to the FTP server as specified in the RoutesDownloadFTPAddress value. See also the RoutesDownloadUsername value.


Page 24

Value: RoutesDownloadUsername

Type: String


Description: This value specifies the username used to log on to the FTP server as specified in the RoutesDownloadFTPAddress value. See also the RoutesDownloadPassword value.

Value: RoutesUploadDeskopFolder

Type: String

Default Data: ""

Description: This value specifies the share name of the folder on the desktop PC where exported inspections files are uploaded to.

Value: RoutesUploadFolder

Type: String

Default Data: "Maintenance/Upload"

Description: This value specifies the name of the FTP folder where Routes files are uploaded to.

Value: RoutesUploadFTPAddress

Type: String

Default Data: "84.22.180.58"

Description: This value specifies the URL address of the FTP server where Routes files are uploaded to.

Value: RoutesUploadPassword

Type: String


Description: This value specifies the password used to log on to the FTP server as specified in the RoutesUploadFTPAddress value. See also the RoutesUploadUsername value.

Value: RoutesUploadUsername

Type: String


Description: This value specifies the username used to log on to the FTP server as specified in the RoutesUploadFTPAddress value. See also the RoutesUploadPassword value.

Value: SISCode

Type: String

Default Data: "ALL"

Description: This value specifies the value of the SIS Code to be exported as part of an ‘I’ line in an exported completed inspections file.


Page 25

Value: StorageCard

Type: String

Default Data: ""

Description: This value specifies the name of the storage card being used to store data files (including the database). For this value to be used, then the StoreDataOnStorageCard value must be set to a value of 1.

Value: StoreDataOnStorageCard

Type: DWord

Default Data: 0

Description: This value specifies whether data files (including the database) should be stored on a storage card inserted into the mobile device (i.e. SD or CF memory card). Setting this value to 1 specifies that a storage card is being used - in which case the StorageCard value must also be correctly populated with the name of the storage card (e.g. "\Storage Card").

Value: UpdateInterval

Type: DWord

Default Data: 10

Description: This value specifies the number of data rows as an interval at which the status bar on the application screen is updated. For example, if 500 metadata entries are being loaded into the database then the status bar will be updated for every 10 metadata entries that are loaded. Increasing this value will improve performance during a Load Metadata.

Value: UseWorkItemCodeAsSISCode

Type: DWord

Default Data: 10

Description: This value specifies whether the first Work Item code should be used instead of the SIS Code when exporting inspections files (see SISCode above).

C.2 Microsoft SQL CE Key Key: HKEY_LOCAL_MACHINE\Software\Microsoft\SQLCE 2.0

Value: BldNum

Type: DWord

Default Data: 20301

Description: The value is used by Microsoft SQL CE.

Value: MajorVersion

Type: DWord

Default Data: 2



Page 26

Value: MinorVersion

Type: DWord

Default Data: 0



Page 27

Appendix C: Maintenance Mobile Files and Folders

The standard desktop or device installer creates the following folders on the mobile device:

\Program Files\Maintenance

\Windows\SQLCE 2.0

The following files are copied to the mobile device:

\Program Files\Maintenance\click.wav

\Program Files\Maintenance\SapphireFTP.dll

\Program Files\Maintenance\Maintenance.exe

\Program Files\Maintenance\system.data.common.dll

\Program Files\Maintenance\system.data.sqlserverce.dll

\Program Files\VersionHistory.txt

\Windows\sscemw20.dll

\Windows\SQLCE 2.0\ssce20.dll

\Windows\SQLCE 2.0\ssceca20.dll

\Windows\StartUp\Maintenance.lnk

In addition the following file may be created by the application:

\Program Files\ Maintenance\MyText.txt


Page 28

Appendix D: Defects Rules

D.1 Introduction In 2008/2009, additional functionality was incorporated into the Maintenance Mobile product to support bespoke requirements for the DRD (Department for Regional Development), Northern Ireland.

DRD planned to use Maintenance Mobile as a replacement for an existing Huskey based solution, however a gap analysis identified two areas where additional functionality would be required in the Maintenance Mobile product to ensure a functional replacement:

1. Additional data fields would be required on the defects screen.

2. Additional business logic would be required on the defects screen to automatically populate and/or select drop-down menu options (often based on values selected or entered into the new fields mentioned above).

Instead of spinning-off a separate product it was decided that the above requirements would be incorporated as an option into the standard Maintenance Mobile product. In order to do this without presenting the new functionality to other Maintenance Mobile customers, an optional data file would be used to selectively turn features on or off. This soft data file would have the added advantage that it could be edited by the customer in the future to allow for changes in the rules without necessarily requiring hard-coded changes be made to the Maintenance Mobile product itself.

D.2 Rules Overview To enable defects rules you must create a plain text file called rules.ini in the same folder on your mobile device as your Maintenance Mobile program runs from (usually \Program Files\Maintenance).

Your rules.ini file can contain two different types of action, either a Control action or a Rule action. For example:

Control,TrafficVolume add N - None

Control,Activity=IN

Rule,Depth>100,Category=CAT1

Rule,Depth>50,Depth<101,Category=CAT2

Control actions govern the appearance of controls or the data listed for a control when the Defects screen is first displayed. For example, you could set a control to be Disabled (greyed-out and locked from the user changing the value) or you could make a control which is by default hidden become Visible or you could add a series of values to a drop-down Combo control.

Rule actions can be used to set values in controls as values are changed. For example, if a user enters a value into one field you can use a Rule action to set the value in another field.

Control actions are formatted as follows:

Control,[field] [visible/enabled state]

Control,[field] add [value]

Control,[field]=[value]

A Control,[field] [visible/enabled state] action will set the Visible or Enabled property of a control.

A Control,[field] add [value] action will add a value to a Combo control. Note that all the text after the ' add ' will be added to the Combo control including spaces (for example: 'N - None').


Page 29

A Control,[field]=[value] action will set the value of a control (TextBox or Combo) to that specified. This type of action is often used with a Control,[field] [visible/enabled state] action to set the value as well as making the control Disabled.

Rule actions are formatted as follows:

Rule,[condition],[condition],[condition],...,[action]

Any number of conditions can be applied to each rule, for example:

Rule,[condition],[action]

Rule,[condition],[condition],[action]

Rule,[condition],[condition],[condition],[action]

[condition] can be formatted as any of the following:

[field] contains [value]

[field] doesn't contain [value]

[field]=[value]

[field]>[numeric value]

[field]<[numeric value]

[field] starts with [value]

[action] can be formatted as any of the following:

[field]=[value] will set the value of a field if the condition(s) was/were matched.

[field] [enabled state] will set the field to Enabled or Disabled if the condition(s) was/were matched.

[field] is the name of the field as it appears in the adjacent label. It includes both the control (for example the TextBox control itself) as well as the label. See 'D.3 Default Screen Layout and Hidden Fields' for more information.


Page 30

D.3 Default Screen Layout and Hidden Fields A number of fields on the defects screen are hidden by default. For example, the following shows the default defects screen (i.e. when no rules.ini file is present):

And the following shows the defects screen with all of the hidden fields displayed:

When referring to a [field], for example with a rule like Rule,Depth>100,Category=CAT1, the field name is

generally the same as the text in the adjacent label. In this example Depth>100 refers to the field 'Depth

(mm)'. Note that spaces should be omitted, so the 'Traffic Volume' field should be referred to as 'TrafficVolume'.

Other fields are: Activity, Defect, Notifiable, Dimension, Priority, Category, Chainage, InventCode, XSP, Environment, TrafficVolume and Depth.

Note that when a field is referred to, for example a Control action to make the Chainage field Invisible - only one line is required in the rules.ini file to change the visibility of both the label and the TextBox itself.


Page 31

D.4 Example rules.ini File The following is a copy of the rules.ini file as initially supplied to DRD:

Control,Notifiable Visible

Control,Environment Visible

Control,TrafficVolume Visible

Control,Depth Visible

Control,Priority Disabled

Control,Category Disabled

Control,Environment Disabled

Control,TrafficVolume Disabled

Control,InventCode Invisible

Control,XSP Invisible

Control,Dimension Visible

Control,Chainage Invisible

Control,Environment add R - Rural

Control,Environment add U - Urban

Control,Environment add N - None

Control,TrafficVolume add H - High

Control,TrafficVolume add M - Medium

Control,TrafficVolume add L - Low

Control,TrafficVolume add N - None

Control,Activity=IN

Rule,Depth>100,Category=CAT1



Rule,Depth>0,Depth<21,Category=

Rule,Depth=0,Category=CAT4

Rule,Environment contains Urban,TrafficVolume contains High,Category starts with

CAT1,Priority=R1


CAT2,Priority=R1


CAT3,Priority=R2

Rule,Environment contains Urban,TrafficVolume contains Medium,Category starts

with CAT1,Priority=R1





Rule,Environment contains Urban,TrafficVolume contains Low,Category starts with

CAT1,Priority=R1


CAT2,Priority=R2


Page 32


CAT3,Priority=R3

Rule,Environment contains Rural,TrafficVolume contains High,Category starts with

CAT1,Priority=R1


CAT2,Priority=R2


CAT3,Priority=R2

Rule,Environment contains Rural,TrafficVolume contains Medium,Category starts






Rule,Environment contains Rural,TrafficVolume contains Low,Category starts with

CAT1,Priority=R2


CAT2,Priority=R3


CAT3,Priority=R4

Rule,Category=,Priority=

Rule,Defect contains EDGE DETERIORATION,Category Enabled

Rule,Defect doesn't contain EDGE DETERIORATION,Category Disabled

D.5 Distributing Your rules.ini File The Send/Receive process in Maintenance Mobile has now been updated to include the downloading of a rules.ini file from the FTP server.

If your administrator places a rules.ini file in the FTP download folder as configured in Tools > Options > Settings > FTP on your device then each time a Send/Receive is performed on the device the rules.ini file will also be downloaded to the user's device.

This functionality allows for the distribution of updated rules.ini files without having to manually copy a file to each individual device.


Page 33

Appendix E: Determine Your Windows Mobile Version

You can use the Help > About screen in Street Works Mobile to check the version of your operating system.

You can also check Windows Mobile by navigating from the Start menu to Settings > System > About.

�

Use the following to determine the operating system version of your mobile device:

1. 4.XX.X (Build XXXXX): Pocket PC 2003

2. OS 5.X.XXX (Build XXXXX.X.X.X): Windows Mobile 5.0

3. OS 5.2.XXXXX (Build XXXXX.X.X.X): Windows Mobile 6.x