Exor Corporation Limited

Transcription

1 Exor Corporation Limited Structures Mobile User Installation Guide The Global Leader in Infrastructure Asset Management

2 1. Quality Assurance Statement Document Details File: Structures_Mobile_User_Installation_Guide_1.0.doc Manual Name: Structures Mobile User Installation Guide Version: 1.0 Date of Issue: Prepared by: Craig Pay Reviewed by: Approved for issue by: Product Manager: Craig Pay May 2006 File Name: C:\Documents and Settings\Craig Pay\My Documents\My Mobile Docs\Structures\Structures_Mobile_User_Installation_Guide_1.0.doc Document Version Control Revision Date By Page Description 1.0 May 2006 CP Page 1

3 2. Contents 1. Quality Assurance Statement Contents Requirements Installing Structures Mobile Desktop Installation (EXE) Device Installation (CAB) Running Structures Mobile for the First Time Loading Metadata (mandatory) Basic Settings (mandatory) FTP Settings (optional) Storage Card Settings (optional) Appendix A: Changes to Structures Mobile Appendix B: Establishing an ActiveSync Partnership Appendix C: Structures Mobile Registry Keys C.1 Application Settings Key C.2 Microsoft SQL CE Key Appendix D: Structures Mobile Files and Folders Page 2

4 3. Requirements Structures Mobile requires Microsoft.NET Compact Framework installed on your mobile device (version 1.0 SP3 is recommended). Pocket PC 2000 and 2002 devices do not include the.net Compact Framework and you must therefore download and install the.net Compact Framework for Structures Mobile to function correctly. Pocket PC 2003 and Windows Mobile 2005 devices do include the.net Compact Framework, however as the version installed on the device may not be the latest version, it is advisable to download and install the latest.net Compact Framework. The latest version of the.net Compact Framework is available here: f92bec03032f&displaylang=en Page 3

5 4. Installing Structures Mobile 4.1 Desktop Installation (EXE) Desktop installation involves running an EXE installer on a desktop PC connected to your mobile device using Microsoft ActiveSync. The Structures 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 Structures Mobile desktop installer copied to your desktop PC (if your mobile device is Pocket PC 2000/2002 you will need Structures_PPC_2002.exe; if your mobile device is Pocket PC 2003/Windows Mobile 2005 you will need Structures_PPC.exe). Before installing Structures 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 Appendix B: Establishing an ActiveSync Partnership). Now that your mobile device is connected to your desktop PC using ActiveSync, double-click the Structures_PPC.exe or Structures_PPC_2002.exe file to begin the installation. You should see the following screen: Page 4

6 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 5

7 When Structures 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 (Structures 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 6

8 Once the installation has completed the following screen will be displayed and you may select 'OK' to finish: You have now successfully installed Structures Mobile! Page 7

9 4.2 Device Installation (CAB) 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 Structures Mobile device installer copied to your mobile device (if your mobile device is Pocket PC 2000/2002 you will need Structures_PPC_2002.CAB; if your mobile device is Pocket PC 2003/Windows Mobile 2005 you will need Structures_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 Appendix B: 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 8

10 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 Structures_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 9

11 Once the installation has completed the following screen will be displayed and you may select 'OK' to finish: You have now successfully installed Structures Mobile! Page 10

12 5. Running Structures Mobile for the First Time When you run Structures Mobile for the first time you will need to perform some basic configuration, as detailed below. 5.1 Loading Metadata (mandatory) Your systems administrator should have supplied you with a METADATA.CSV file. Before you start Structures Mobile for the first time you should copy your METADATA.CSV to your device. Before you begin to load metadata on to your device ensure 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 Appendix B: Establishing an ActiveSync Partnership). Once you are ready to proceed, use Windows Explorer on your desktop PC to navigate to your mobile device: Page 11

13 Using Windows Explorer navigate to the \Program Files\Structures folder on your mobile device: Copy and paste the METADATA.CSV file provided by your systems administrator into this folder: Page 12

14 Once the file has completed copying you should see the METADATA.CSV file located in the correct \Program Files\Structures folder: You are now ready to load the Metadata on your mobile device. On your device run Structures Mobile and select the Tools > Load > Metadata menu option: Page 13

15 If you have copied the METADATA.CSV file to the correct location on your mobile device you will then see the Metadata being loaded. This may take some time (10-15 minutes): You have now successfully loaded Metadata into Structures Mobile! Page 14

16 5.2 Basic Settings (mandatory) After installing Structures Mobile (see Section 3 Requirements) navigate to the Programs folder on your mobile device (Start > Programs), and select the Structures Mobile icon: The first time you run Structures Mobile you should select an 'Inspectors Name'. Navigate to Tools > Options > Settings from the Structures Mobile menu: Page 15

17 On the Settings screen select your 'Inspectors Name'. Select the OK button in the top right corner to save your settings and return to the main application screen: 5.3 FTP Settings (optional) 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 Structures Mobile menu: Page 16

18 Select the FTP tab and you will see the default settings configured in the application: Enter your own FTP settings and select the OK button in the top right corner to return to the main application screen: Page 17

19 5.4 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 Structures Mobile menu: Select the Files tab and you will see that by default a storage card is not selected: Page 18

20 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 19

21 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 20

22 Appendix A: Changes to Structures Mobile 3.0 Structures Mobile version 3.0 has now been fully migrated to a.net platform. Because this required complete redevelopment of the software a large number of changes and enhancements have been included in this version, as detailed below: 1. Improved GUI. The graphical user interface (GUI) has had a major overhaul with improved navigation and an improved look-and-feel. The number of screens that have to be navigated has been reduced with greater levels of information displayed per screen - for example: The starting screen now displays Inspections rather than having to navigate to a different screen. The Inspection details screens can be easily navigated between without delay using a 'tab control'. In addition, general error handling has been improved resulting in a lower likelihood of error messages being displayed, coupled with greater levels of meaningful information displayed when an error does occur. Finally a number of menus on the main application screen now replace additional screens and/or buttons. 2. Improved Installer. The desktop (EXE) installer features various minor enhancements. A description of the application, its version number and an EULA (end-user license agreement) are now displayed prior to installation. In addition, the appropriate metadata.xml file is now bundled inside the installer. 3. Support for Pocket PC 2003 and Windows Mobile The application now supports all Microsoft mobile operating systems up to and including Windows Mobile This includes full support for portrait and landscape views. 4. New Database. The database used with the previous version of Exor Mobile software (Pocket Access.CDB) has now been replaced with SQL CE (.SDF). This removes the previous record limit (approximately 15Mb in size) as well as improving performance. There is now no theoretical limit on the number of records that can be loaded, only a 2Gb database file size limitation. In addition, database compaction is now supported and activated whenever a large number of records is deleted (it is also available via a menu option). 5. Multi-threading. The application now supports multi-threading for processor-intensive, long-duration activities such as loading or sending/receiving data. This allows the application to continue to operate with no interruption in screen display/update. 6. Silent Start-Up. The application now starts 'silently' with no interaction required from the user to reach to main application screen. Message boxes requiring user interaction are only displayed if an error occurs. 7. SD/CF Card Support. The application now fully supports SD and CF memory cards with an easy-to-use dropdown menu allowing for a user to select from any memory card detected by the device. Switching from main memory to memory card (or vice-versa) automatically creates new database files and data folders. 8. Start-Up on Soft-Reset. The application now automatically starts on a soft reset of the device. Page 21

23 9. Today Screen Icon. An icon is now displayed at the bottom of the Today Screen allowing the application to be maximized if it is minimized or if the user otherwise shifts focus to the Today screen. The main application screen now features a minimize icon (x) to allow the application to be minimized without exiting. 10. Operating System Cannot Close Application. The Pocket PC operating system automatically shuts down applications if it deems that other applications have priority. The application now blocks this attempt and keeps running unless the user decides to exit. 11. Metadata Moved. The metadata file (PRISM.DSC) has now been renamed to METADATA.CSV and has been moved from the default DCD folder (\DCD Files\STR) to the default program folder (\Program Files\Structures). 12. HTML Help. The application now features standard Windows Mobile HTML Help (navigated from the application's lower toolbar menu: Help > Index...). The Help Index supplies information to help end-users operate the application. 13. Improved FTP. FTP sending and receiving has been improved and fully automated (with all navigation screens removed). The application will also now 'auto-dial' a default connection to the Internet prior to a send/receive. 14. [minor] Program Name. The filename of the application has now changed to Structures.exe. 15. [minor] VB Runtimes. The 'Microsoft VB Runtimes for PPC' are no longer required. 16. [minor].net Compact Framework. The application now uses.net Compact Framework (CF). All devices from Pocket PC 2003 and later include version 1.0 of the.net Compact Framework. The latest version of the.net CF is 1.0 SP [minor] Registry. The registry key now used by the application is \HKLM\Software\Exor\Structures. 18. [minor] Icon Transparency Fixed. The background around the middle of the program icon is no longer transparent (it is now white). Page 22

24 Appendix B: Establishing an ActiveSync Partnership You can tell if ActiveSync is installed if you have this icon: right hand corner of your screen). next to your clock (usually located in the bottom 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 23

25 Appendix C: Structures Mobile Registry Keys There now follows a list of registry keys and values used by the Structures 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\Structures 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 Structures Mobile desktop and device installers do not automatically create all registry values in HKEY_LOCAL_MACHINE\Software\Exor\Structures 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\Structures 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: "STR" Description: This value specifies the filename of the SQL CE database (e.g. STR.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 24

26 Value: DataFilesFolder Type: String Default Data: "\DCD Files\STR" Description: This value specifies the folder where the data files (CSV 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: DownloadFolder Type: String Default Data: "Structures/download" Description: This value specifies the folder on the FTP server that stores files to be downloaded 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: FirstRun Type: DWord Default Data: 0 Description: This value determines whether this is the first time that Structures 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: FTPServerAddress Type: String Default Data: " " Description: This value specifies the URL address of the FTP server used during a Send/Receive. Value: InspectorsName Type: String Default Data: "" Description: This value specifies the name of the inspector. This value is appended to inspections when they are uploaded to the server. Page 25

27 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: Password Type: String Default Data: "tryme" Description: This value specifies the password used to log on to the FTP server as specified in the FTPServerAddress value. See also the Username value. 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: 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: 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: UploadFolder Type: String Default Data: "Structures/upload" Description: This value specifies the folder on the FTP server where files are uploaded during a Send/Receive. Page 26

28 Value: Username Type: String Default Data: "epaq" Description: This value specifies the username used to log on to the FTP server as specified in the FTPServerAddress value. See also the Password value. C.2 Microsoft SQL CE Key Key: HKEY_LOCAL_MACHINE\Software\Microsoft\SQLCE 2.0 Value: BldNum Type: DWord Default Data: Description: The value is used by Microsoft SQL CE. Value: MajorVersion Type: DWord Default Data: 2 Description: The value is used by Microsoft SQL CE. Value: MinorVersion Type: DWord Default Data: 0 Description: The value is used by Microsoft SQL CE. Page 27

29 Appendix D: Structures Mobile Files and Folders The standard desktop or device installer creates the following folders on the mobile device: \Program Files\Structures \Windows\SQLCE 2.0 The following files are copied to the mobile device: \Program Files\Structures\click.wav \Program Files\Structures\SapphireFTP.dll \Program Files\Structures\Structures.exe \Program Files\Structures\system.data.common.dll \Program Files\Structures\system.data.sqlserverce.dll \Windows\sscemw20.dll \Windows\SQLCE 2.0\ssce20.dll \Windows\SQLCE 2.0\ssceca20.dll \Windows\StartUp\Structures.lnk Page 28