IsoMetrix. Service Pack System Enhancements

Transcription

1 IsoMetrix Service Pack System Enhancements Released 30 May 2016

2 DISCLAIMER No part of this document/manual may be reproduced or transmitted in any form without the prior written permission of. Whilst. has endeavoured to include accurate and up to date information on Management Systems, it makes no representations and gives no warranties about the accuracy or suitability of the information contained in this document. Under no circumstances whatsoever shall Metrix be liable for any direct or indirect damages whether in contract or in delict arising out of or in connection with the use of this document/manual. Copyright. All rights reserved. Service Pack Page 2

3 TABLE OF CONTENTS... 1 EXECUTIVE SUMMARY... 4 DOCUMENT PURPOSE... 4 IMAGE UPLOAD CONTROL... 4 Overview... 4 Implementation Detail... 4 Requirements Known Limitations Exclusions TABLE OF FIGURES Figure 1: Image Upload Control on a Module Template... 5 Figure 2: Image Upload Control Properties... 6 Figure 3: Record displaying an image upload control on the layout... 8 Figure 4: Empty image upload control with placeholder image... 8 Figure 5: Record displaying populated image upload control... 9 Figure 6: Image upload control displaying a larger image with the incorrect aspect ratio... 9 Figure 7: Image upload control displaying a smaller image Figure 8: Windows Browse Popup allowing users to select an image Figure 9: Image upload control displaying loading indicator Figure 10: File size exceeds the maximum allowed validation message Figure 11: Mandatory image upload control Figure 12: Selection required validation message displayed for unpopulated mandatory image upload control Figure 13: Delete icon displayed in an image upload control on mouse over Figure 14: Error message that is displayed if Adobe Flash is not installed on the users machine Figure 15: Dropdown allowing users to configure the Windows Browse box to display invalid file types Figure 16: Error message that is displayed when a user attempts to upload an invalid file Service Pack Page 3

4 EXECUTIVE SUMMARY In Service Pack there is one new enhancement to IsoMetrix viz. the image upload control. The image upload control allows users to upload an image into the allocated space on the form such that say a photo of a stakeholder or a company s logo can be stored along with the other information captured on the record. DOCUMENT PURPOSE The reason for this document is to explain the new feature that has been implemented in IsoMetrix Version IMAGE UPLOAD CONTROL Overview Version 3.11 contains 2 controls that can be used in conjunction with images. The image control allows users to upload an image into the control on the module template and displays the configured image on every single record. This is a static image that cannot be changed from the front end. The links control allows users to upload documents into it and includes images among the list of documents that are supported. These images are not displayed directly on the record and require a user to select them in order to view them. Version 3.12 has introduced a new image upload control that combines logic from each of these controls. The image upload control allows users to upload an image into it using a record s form view. The system then displays the image that has been uploaded into it thus allowing a different image to be displayed on each record. Implementation Detail The image upload control has been implemented using the logic similar to that used to implement the other controls in the system. Users are consequently able to perform the following actions when working with this control: Add the control to a module template o Users are able to add this control to a module using the same logic that is used to add other controls to a module template Service Pack Page 4

5 Figure 1: Image Upload Control on a Module Template o The control contains the following properties: Service Pack Page 5

6 Figure 2: Image Upload Control Properties Table 1: Image Control Property Details Name Description Type Allowed Values Default Value Displays the name of the Type Control Type Textbox N/A Image Upload Control Size Position Label Tooltip Displays the Control dimensions in the following format: (width x height) Displays the position of the Control on the Layout in the following format (xcoordinate : y-coordinate) Textbox Textbox Displays the name that is allocated to the control element Textbox Freetext Allows users to configure the tooltip that will be displayed when the control is hovered on Textbox Area The values in this field change when a user resizes the Control (114 x 152) The values in this field change when a user drags the Control to a different location. Freetext Default x-coordinate value: 0 Default y-coordinate value: Depends on the location of the previous Control [ Image Upload Control NUM ] where number is automatically incremented each time a user adds an additional Control of the same type Service Pack Page 6

7 Read-only on Add Read-only on Edit Max File Size (MB) Border Border Colour Background Colour Add Validation Allows users to define if the control is Read-only when users add new records Allows users to define if the control is Read-only when users edit existing records Allows users to configure the maximum size of the image file that users are allowed to upload into the control. If configured correctly, this option prevents users from uploading really large files into this control Allows users to define the thickness of the border line that appears around the control Allows users to define the colour of the border line Allows users to define the background colour of the control. The background is displayed when the aspect ratio of the image does not match the aspect ratio of the control Defines whether a Control is mandatory when new records are added Checkbox Checkbox Textbox Dropdown Dropdown Dropdown Dropdown Selected Deselected Selected Deselected Deselected Deselected Integer Numeric values 2 None 1px 2px 3px None Black Gray Silver Maroon Red Purple Fushia Green Lime Olive Yellow Navy Blue Teal Aqua Black White Black Gray Silver Maroon Red Purple Fushia Green Lime Olive Yellow Navy Blue Teal Aqua White Not Required Required Not Required Service Pack Page 7

8 Edit Validation Visible on Add Visible on Edit Defines whether a Control is mandatory when existing records are edited Allows users to define if the Control is visible when users add new records Allows users to define if the Control is visible when users edit existing records Dropdown Checkbox Checkbox Not Required Required Selected Deselected Selected Deselected Not Required Selected Selected View the image upload control on a record o The image upload control is displayed as a control on the record layout Figure 3: Record displaying an image upload control on the layout o The image upload control displays an empty Image placeholder icon when there is no image populated into the control Figure 4: Empty image upload control with placeholder image o The image that is populated into the image upload control is displayed in the control directly on the record Images that have been uploaded into the image upload control are loaded last Service Pack Page 8

9 Users are able to interact with a record before the images have finished loading Figure 5: Record displaying populated image upload control o The System implements the following logic in order to determine how an image will be displayed in the image upload control If the dimensions of the image > than the dimensions of the image upload control: The system FITS the image into the allocated space This may result in blank space around the image if the aspect ratio of the image does not correspond with the aspect ratio of the allocated space Figure 6: Image upload control displaying a larger image with the incorrect aspect ratio If the dimensions of the image < than the dimensions of the image upload control: Service Pack Page 9

10 The system CENTRES the image in the allocated space There will be blank space around the image Figure 7: Image upload control displaying a smaller image Upload an image into the control o A user is required to click on the image upload control in order to trigger the image upload action o The system responds by presenting the user with a Windows Browse box allowing the user to select an image to upload into the control The Windows Browse box filters out invalid files and displays only the image files users are allowed to upload into the control o Figure 8: Windows Browse Popup allowing users to select an image The image upload control supports all the major web image types.png.jpg.jpeg.bmp Service Pack Page 10

11 o o.tiff.gif Users are only allowed to upload a single image into an image upload control The system displays a loading indicator when uploading large images Figure 9: Image upload control displaying loading indicator o If the image the user selects exceeds the Max File Size configured for the control the system will cancel the upload request and display a validation message informing the user that the file size exceeds the allowed limit Service Pack Page 11

12 Figure 10: File size exceeds the maximum allowed validation message o If the image upload control has been configured to be mandatory the system marks the control as mandatory and requires users to upload an image before saving the record The mandatory control is marked using a red line on the left hand side of the control Service Pack Page 12

13 Figure 11: Mandatory image upload control The system displays a validation message if a user attempts to save a record without uploading an image into a mandatory image upload control Service Pack Page 13

14 Figure 12: Selection required validation message displayed for unpopulated mandatory image upload control Change the image that is displayed in the control o A user is able to trigger a new image upload action by clicking on an image upload control that already has an image populated into it o The system responds by presenting the user with a Windows Browse box allowing the user to select a new image to upload into the control o The system replaces the existing image with the new one Delete an image from the control o Users are able to access the delete image option when hovering on the control o The system responds by displaying the delete icon on the right hand top corner of the image o Selecting the delete icon removes the image from the control Service Pack Page 14

15 Figure 13: Delete icon displayed in an image upload control on mouse over Reference the control o The Image Upload Control can be referenced from and included in Bespoke Reports Requirements The image upload control has the following requirements: IE9 and IE10 require Adobe Flash to be installed in order for the image upload control to function as designed The system displays an error message if Adobe Flash is missing informing the user that they need to install it in order for the form to work correctly o This error message is displayed when a user hovers over the image upload control Service Pack Page 15

16 Figure 14: Error message that is displayed if Adobe Flash is not installed on the users machine Known Limitations The image upload control has the following known limitations: IE9 does not take into account the Max File Size settings that has been configured and allows users to upload any image size into the control IsoMetrix will not allow users to upload files that are larger than the maximum file size allowed by the environment settings o If users wish to increase the size of files to be uploaded to the IsoMetrix site to a value that is higher than that allowed by the environment settings, the following settings need to be adjusted accordingly: Web.config -> maxrequestlength= IIS settings -> Requests filtering set Maximum allowed content length (bytes) to for 1GB upload o For more information refer to the following website: Even though IsoMetrix has configured the Windows Browse box to filter out invalid files, thus displaying only the image files users are allowed to upload into the control, users are able to get round this limitation by selecting one of the other options available in the dropdown located beside the File name field o The following options will allow users to view and select files that should not be uploaded into the image upload control: All Files (*.*) HTML (*.htm;*.html) Service Pack Page 16

17 Figure 15: Dropdown allowing users to configure the Windows Browse box to display invalid file types o The System displays an error message should a user attempt to upload an invalid file type into the control Service Pack Page 17

18 Figure 16: Error message that is displayed when a user attempts to upload an invalid file Exclusions The image upload control has been excluded from the following areas in the System: Search Options Search Results Notification Templates System Reports Triggers o Conditions Area o Actions Area Set Value Process Flow o Conditions Area Replicator Service Pack Page 18

19 Metrix Software Solutions has a dedicated support desk which is open weekdays from 8am to 5pm South African time. IsoMetrix Support Desk: support@isometrix.com Ideally all users should report problems to their Site Administrator who should then contact the support desk. The support desk will provide feedback to the Site Administrator who can then follow up with the user. Please contact the support desk if you experience a problem when using IsoMetrix. If you get an error page it is ideal to take a screen shot (select Print Screen or PrtSc on your keyboard), paste it into a Word Document and then it through to IsoMetrix. An confirming that your call has been logged with a unique reference number will be sent to you. Quote this reference number at any time when dealing with the support desk. You will be updated on progress with your call and any fixes will be sent directly to your IT department. If you do not receive your unique reference number from us within two hours, please phone us as there could be a problem with the delivery or receipt. A report will be sent to you once a month with all issues raised and how they were resolved. If you are unhappy with the support you are receiving, please do not hesitate to contact: Lucille Hallowes: lh@isometrix.com We hope you enjoy these new features! Service Pack Page 19