GNOSYS PRO 0.7. user guide

Transcription

1 GNOSYS PRO 0.7 user guide

2

3 Author Guido M. Re Date September 2016 Reviewer Chad Barksdale Date September

4

5 Contents 1 Get Started System Requirements Windows ios devices Android devices User Registration Download and Install Install on Windows Install on ios Trust FuelFX distribution Install on Android Trust Unknown Sources Change Password Get Familiar With GNOSYS Login Initial Data Synchronization Home Screen Manage Your Account Procedure Organization Folder Structure Folder Representation Folder Navigation Procedures Procedure Options Download a Procedure Archive a Procedure Find a Procedure Keyword Search Location Search Visual Search Run a Procedure 29 5

6 4.1 Overview Main Menu The Step Activity Supporting contents Augmented Reality Video Online Video Link PDF D Model Input fields Photo Signature Proceed to the Next Step Multiple Options Reporting to GNOSYS Server Real-time Procedure Information Feedback Warning Procedure Summary

7 1 Get Started

8 1.1 System Requirements This section outlines the minimum set of requirements to utilize the full range of GNOSYS capabilities. NOTE: A network connection is mandatory in order to register, install and login. Ensure your device (PC or Mobile) has access to a network Windows Operating System: Memory (RAM): Disk space: Processor: Graphics Card: Monitor resolution: Windows 7 and above 4.00 GB 350MB to install the software + additional space to store procedures 2GHz 1GB Video RAM minimum 1200 x 800 pixels A camera must installed and enabled for Augmented Reality (AR) enabled experiences and visual search functionality ios devices Operating System: ios 9.2 Device: iphone 5S and above, ipad 3rd generation and above Memory: 300 MB for the software + additional space to store procedures Android devices Operative system: Memory: Android and above 300 MB for the software + additional space to store procedures 8

9 1.2 User Registration New users are added by invitation only. New users will receive an invitation from The link provided in the invitation will direct the new user to the registration page, shown below. Complete the form and select Register to finalize registration. Once the information is verified and saved on the server, an auto-generated from will be sent. This process may take a several minutes. NOTE: When opening the registration page, the field may be auto-populated. The confirmation provides another web link to confirm the password. Once this step is complete, registration for GNOSYS is complete. 9

10 1.3 Download and Install After registering, an will be sent to the address used with a link to the downloadable version of GNOSYS. After the download is complete, follow the prompt to select the platform used to run GNOSYS and the automatic download will begin. You can find the web page with all the downloadable version of GNOSYS also at the following link: Install on Windows Follow the instructions below to install GNOSYS on Windows. Double click on the GNOSYS installer to open the setup wizard. Follow the setup wizard steps to install GNOSYS on your Windows Machine. Once installation is complete, click on the GNOSYS icon on the desktop or select it from the Programs list to launch GNOSYS. NOTE: Make sure you launch GNOSYS as Administrator Install on ios Select GNOSYS for ios from the webpage. A notification will appear before installing. Click on Install and GNOSYS will automatically install on the device. 10

11 Trust FuelFX distribution If your device does not accept apps distributed outside of the Apple App Store, you cannot install GNOSYS. Once the installation is complete, a message may appear when you first run the app. Follow the sequence of pictures below to trust the FuelFX distribution: Go to Settings General. Scroll to the bottom and select Device Management. In Device Management, select FuelFX, Inc. Then, select Trust FuelFX, Inc. Again, select Trust. 11

12 1.3.3 Install on Android Follow the instructions below to install GNOSYS on Android. Select GNOSYS for Android from the web page. Select OK if a warning message appears on your screen. The app will be visible in the Notification Center once the download has completed. Select the GNOSYS notification to install the app. 12

13 Trust Unknown Sources If your device does not accept apps distributed outside of the Google Play Store, you cannot install GNOSYS. Follow the sequence of pictures below to trust this distribution of the app. Tap the SETTINGS button to unblock the installation. Tap OK to enable the install. Uncheck the Allow this installation only box to prevent further interruptions to the installation of apps that do not originate from the Google Play Store. Select INSTALL to begin the install process After the app is installed, the app may be opened. 13

14 1.3.4 Change Password Click the link below to change a password: 14

15 2 Get Familiar With GNOSYS

16 2.1 Login Login is required each time GNOSYS is launched. The username is the address that you provided during registration. The drop-down menu button on the username field provides you a list of all the users that successfully logged in on the device. This is used as a shortcut to login. NOTE: Your device must be connected to a network. 16

17 2.2 Initial Data Synchronization After a successful log in, GNOSYS must sync data between the remote GNOSYS server and the local device. Part of this data is: A folder structure for the procedure A list of the procedures available on the device A list of users in your working group The time to complete this mandatory set of operations varies according to the internet connection speed and the amount of data to sync. Once the sync is finished, you will be redirected to the GNOSYS main screen. (a) During syncing (b) Sync complete 17

18 2.3 Home Screen The main screen allows the selection all the principle features offered by the GNOSYS platform. The four buttons in the middle of the interface open different drop down menus that are briefly described below: CREATE Enables all the authoring/editing functionalities: Author new: generates a new empty procedure. New from template: feature not supported in version 0.6. Edit existing: allows for selecting an existing procedure and edit it. RUN MANAGE Shows the list of procedures associated with the selected GNOSYS account that may be run. Enables administrative functions: View progress: shows all the procedures that are currently being run by the users in the selected group. Log files: lists all reports of successfully completed procedures. SHARE Enables GNOSYS social features: Invite users: allows you to invite new users to join your working group in GNOSYS. Assign procedures: enables communication to other users on which procedure to run. Upload procedure: gives the ability to update procedures on the server with the selected modified local copies. 18

19 2.4 Manage Your Account The user name in the top left corner of the Home Screen provides access to the user account settings. Select the user name to access the drop down menu, shown in the image below. The My Settings button opens the user account setting page. Reset button for password Switch for the preferred unit 19

20 20

21 3 Procedure Organization

22 3.1 Folder Structure Procedures shared within the working group are organized in a common space on the server. This space can use folders to help organizing and cataloging procedures. Similar to the folder structure on a computer, the folders are organized hierarchically: a folder can contain multiple folders. Browsing through the folder structure every time a selected procedure is to be run can be accomplished by (Run button), edit (Create Edit Procedure) or upload (Share Upload Procedures) Folder Representation The list of folders is always represented before of the procedure list. The graphic element used to represent the folder indicates the name of the folder and whether or not it contains sub-folders and procedures. The icon indicates that the folder has content, while indicates an empty folder. 22

23 3.1.2 Folder Navigation The contents in the Root Folder are shown first. Browse to a specific folder by selecting it. All of the procedures and sub-folders associated to the selected folder will be listed. Once a folder is selected and opened, the first item in the list moves back to the parent folder. The path of the open folder is visible above the list. It is possible to return to the Root folder by selecting the button. 23

24 3.2 Procedures Procedures are listed after the folder and their minimal description is: Name Brief description Author Thumbnail Instant access is available to all procedures, which are locally stored on the device. Select a procedure in the list to open it (Edit or Run mode). The download icon identifies the procedures that are not locally stored. The icon, instead, identifies the outdated procedures that are locally stored. Procedures are automatically sorted in alphabetical order. However, can be reorganized by name, creation date or last modification date by simply selecting one of the three buttons shown here. Once selected, the procedures are listed in ascending order. Procedures can arranged in descending order by re-selecting the same button Procedure Options The option button possible with this menu are: opens a specific menu for the procedure with other additional actions. The minimum actions that are Enlarge the procedure box to show all the related information Delete the procedure locally stored on the device Download/Update the procedure Additional actions are possible while in the edit mode and they are described in the section??. 24

25 Download a Procedure Select the procedure to download/update on your local device. A progress icon, like the one in the image below, provides information about the percentage of completion for the download. Once complete, the procedure can be opened. NOTE: Download time will vary according the connection speed used and the size of the procedure. The procedure size can be a few kilobytes or several megabytes, in line with the complexity of the procedure, and the number (and size) of the supporting content (images, video, etc.) Archive a Procedure When selecting to archive a procedure, a pop-up warns that all the data associated to the procedure will be lost. If you press Yes, you cannot undo this operation. However, you can always download the most recent version of the same procedure from the server again. 25

26 3.3 Find a Procedure GNOSYS provides three ways to find a procedure: Keyword search Location search Image-based search Keyword search bar Visual Search Location search Search Button Keyword Search Keyword search is often the typical method to locate a procedure. To search using keywords, enter the desired keywords in the search bar and select the SEARCH button to filter the procedures. If no procedures are returned, the search button will be greyed out. Once the keywords have been entered, the search button will become active and turn gold. NOTE: The search engine filters the procedures by checking if all the keywords provided are present in the title, the description or the tags of the procedures. NOTE: The search engine is not case sensitive. The button appears in the search bar only after the search is completed. This button clears the search bar and returns to the list of procedures without any search filters applied. 26

27 3.3.2 Location Search The location search button allows for searching through GPS-enabled procedures. A procedure can have GPS information embedded, which corresponds to a location where the procedure is supposed to be used. Location search calculates the distance of the procedures according to your current geolocation and sort them by distance in ascending order. NOTE: This functionality is available only if the hardware and the software of the device supports detection of the current location. This functionality is currently not supported on PC. For mobile devices, make sure the GPS system is on. Use a reliable data connection to improve location accuracy in an indoor environment. This can either be a wireless carrier, if a data plan exists for on the device, or a local Wi-Fi network. 27

28 3.3.3 Visual Search The visual search button camera. allows searching for procedures by recognizing the environment around you, using the devices A procedure can have particular images embedded called visual keys. The visual search engine is able to find visual keys in your workspace by comparing them with the live image in your device s viewfinder (camera). In the event of successful comparison, the visual key s corresponding procedure(s) will be listed. Once the visual search button is selected, the live image in the device s viewfinder (camera) is enabled and the visual search engine is activated. The interface for the visual search is in the picture below. Live image in viewfinder Visual search status Close visual Search The status of the visual search engine changes from SEARCHING to FOUND! if at least one visual key is found. Then, the procedures with the detected visual keys are listed. NOTE: The visual search engine requires that the visual keys be clearly visible by the camera. Object distance, environment configuration, dirt and occlusion may affect recognition. 28

29 4 Run a Procedure

30 4.1 Overview The Run Mode shows the procedure that the operator has to carry out in a simple, linear and step-by-step approach. The UI for the Run Mode is briefly represented in the picture shown here: Main menu Support and collaboration tools Next step conditions Activity to carry out 30

31 4.1.1 Main Menu The Main Menu shows the basic information about the procedure being run, such as the name of the procedure and the completion percentage. Completition percentage for the procedure Home Button Procedure Name Score and countdown The score value and the countdown are not always available. They are visible only if the procedure requires those elements. The countdown is not a hard stop and the procedure can proceed even if the work was completed with time to spare. NOTE: The Home button returns the user back to the Home Screen. A notification will appear alerting the user that the procedure will be marked as unfinished and a message will be sent to the server. 31

32 4.2 The Step Activity This part of the interface includes all the necessary information to carry out the activity for the current step. Step number Text description of the activity Supporting contents NOTE: Each step is associated with a progressive number. In the event a sub-procedure is being run, additional numbers are added to define the position in the procedure. The following examples explain the numeration of the steps: Step Number Description 8 8th step of the main procedure 4.3 3rd step of the sub-procedure at the 4th step of the main procedure th step of the sub-sub-procedure at the 6th step of the subprocedure at the 5th step of the main procedure 32

33 4.2.1 Supporting contents The supporting contents (if available) are visible at the bottom of the step activity. Select a thumbnail to visualize the corresponding supporting content in a lightbox Augmented Reality Select the corresponding AR thumbnail to launch the AR experience. This will activate the camera and load the full-screen semi-transparent representation of the image target. Point the camera at the target to visualize the augmented content overlaid on the real environment. The augmented reality content is placed in the real environment and consists of: Numbered labels with text attached (AR labels) Virtual 3D models Back Button AR tag To initiate the AR experience, follow the instruction on the label associated to each tag. Select the CHECK button on the label to proceed to the next tag. Once all the tags are checked, the app automatically switches back to the Run Mode visualization. NOTE: For the best AR experience, the target must be easily readable by the AR engine. Aim the camera at the target from a reasonable distance. As general rule, the target should cover at least a quarter of the image from the camera s viewfinder in order to be detected. 33

34 Video Select the thumbnail to play the video. The video opens in a lightbox and will play automatically. Use the interface below the video to scrub along the timeline. Close play/pause button AV scrubber Online Video The light box for the online video shows the thumbnail of the video. Select the thumbnail to play the video. The video automatically plays in full screen mode on mobile devices. NOTE: If the thumbnail is not present, a generic image of a video camera is represented. NOTE: If the video is a link from YouTube, the video will open in the default web browser (or in the YouTube app, if it is installed on your mobile device). 34

35 Link The light box for the online link provides a description of the link and a button to open the link in a browser. Select the button to open the link. description for the link Button to open the web browser PDF Select the thumbnail to open the PDF within a lightbox in GNOSYS. Use the scrollbar to switch between pages. Use the pinch gesture to zoom the page. Close PDF Pages Scrollbar 35

36 D Model Select the thumbnail to open the 3D model within a lightbox within GNOSYS. The size of the model will affect the amount of time needed to display it. A text message informs you about the opening progression. Close 3D Model Zoom Reset Button Use the scrollbar on the right side of the lightbox to change the visualization size of the model. Follow the table below to rotate and pan the model. Action Mobile Desktop Rotate tap and drag the finger on the screen left click and drag the mouse Pan tap and drag with two fingers on the screen right click and drag the mouse 36

37 4.2.2 Input fields Input fields are displayed below the text description: input name Icon Input description Input field Input fields There are different kinds of input fields supported in GNOSYS. The following table lists all the inputs with their corresponding icon. Icon Input kind Description Text Single line of text. No limits on the kind of characters. Measure Numeric value of a measure Check box Input that can be only true or false Multiple options List of choices that can allow you to do also multiple selections Photo Take a photo with the device camera Signature Requires the user to sign NOTE: The input fields marked with the red text Required field must be populated before moving to the next step. 37

38 The inputs are recorded in a log file. The user can quickly view of all of the inputs by opening the input list at any time while running the procedure. The picture below shows an example of the list. Check box Text input Measure Multiple options Photo Signature 38

39 Photo The user can provide an image captured via camera as input field. The sequence below demonstrates how to use it. Press the + button The interface to take the picture appears. Take the picture. The picture is now saved in the procedure. 39

40 Signature The user can provide an electronic signature as input field. The sequence below demonstrate how to use it. Press the Signature button A lightbox to electronically sign the step appears. Provide the signature. Use the trash bin icon to clear the signature area. Use the check button is completed. when the signature The signature is now saved in the procedure. 40

41 4.3 Proceed to the Next Step The buttons on the right side of the screen are the conditions that the user has must choose in order to proceed to the next step. The image here, shows the elements present in such button: textual description icon The background color and the icon of each button is classified according four categories: Icon & color Description Positive condition Negative condition Warning condition Neutral condition Once selected, the procedure automatically progresses and the percentage of completion increases. NOTE: Select the button to revert to the previous step. 41

42 4.3.1 Multiple Options Complex procedures may have steps with multiple buttons that are selectable in order to proceed to the next step. Each button is a different variable, or condition, that has been taken into account for the procedure. The following images represent two cases with multiple conditions; each button following a specific path for the step. Multiple conditions for different responses. All are different kinds of conditions Multiple conditions to select the proper equipment. 42

43 4.4 Reporting to GNOSYS Server GNOSYS constantly communicates to the server every time it runs a procedure. Communications that GNOSYS sends are: Real-time procedure information Feedback messages Warning messages NOTE: In the event the device is not connected to a data network, some information is stored locally and sent to the server once a connection to the GNOSYS server is established Real-time Procedure Information Every time a step is completed, GNOSYS will automatically send all the information related to the finished step to the server. This information is used to keep track of the status of the work in real-time and eventually coordinate with other users. The information sent to the server is: User info User position (if GPS signal is available) Time information Step information The data provided in the input fields 43

44 4.4.2 Feedback Feedback is used to improve the activity described in the step. Feedback should be treated as a suggestion or a note that the user can provide to improve a particular activity. Selectd the image below: button to activate the Feedback lightbox as shown in the Type the feedback in the input field and press the SUBMIT button to send it to the server. NOTE: The feedback will be saved locally if a data connection to the server is not available. The feedback will be sent automatically as soon as the connection is restored Warning Warning is an immediate report of a serious problem you have encountered while performing the activity in the step. Select the button to activate the Feedback lightbox like the one in the image below: Explain the details of the warning in the input field and press the SUBMIT button to send it to the server. NOTE: The warning will be saved locally if a data connection to the server is not available. The warning will be sent automatically as soon as the connection is restored. 44

45 4.5 Procedure Summary Select the FINISH button when the last activity (step) for the procedure has been completed. The procedure summary similar to the one in the image below, will appear: Select the HOME button to return to the Home Screen. 45