hrMecca
 
Our Product

Screen XML Tags

Screen XML tags control all aspects of the the screen's behavior. They can be used to set up access security, limiting who has access to a screen or who can read, write or delete records on a screen. Screen titles, width and height and reporting characteristics are also configured using the screen XML tags. A full list of all of the available screen tags and what they do follows.

[ back to Screen Configuration section ... ]

  • AccessSecurity - The AccessSecurity attribute applies at the screen as well as the field level. When this attribute is set up at the screen level, it can prevent certain user groups from accessing the screen. This parameter works in conjunction with the AccessSecurity XML parameters.
  • AllowUnchangedSave (True or False) - Before the user can save any data, they are usually required to have changed one of the fields on the screen. If the screen has some kind of calculation logic or other functionality that might need to be run without changing any data, then set this attribute to True. When it is true, the user will be able to load the screen and press the Save icon (the left most icon that looks like a floppy disk) without changing any data.
  • AuditCurrentRecordOnly (True or False) - On MultiRecord and System screens, when the Audit dialog is invoked to review data changes, all of the changes for all of the history records will be presented. For screens with lots of records, this can result in a very busy Audit dialog. Setting this attribute to True will cause the Audit dialog to only display date changes for the current history record and not all history records.
  • AvailableToAuditReport (True or False) - The system has an Audit Report dialog where the user can report on data changes. One of the filters on this dialog allows the user to elect to report on changes for a specific screen or for all screens. If the AvailableToAuditReport attribute is set to False, then the screen will not appear in this screen drop down filter.
  • AvailableToDataQuery (True or False) - The system has an integrated data query capability that allows the user to report on the data contained within the system. The integration is aware of field, screen and organizational level security, ensuring that the user does not see any screens, fields or groups of employees that they are not allowed to. In edit mode, where new data queries are created, a dialog exists that allows the user to select from all of the screens defined within the system those fields that are to be reported on. If the AvailableToDataQuery attribute is set to False, then the screen will not appear in this dialog. This feature is useful for keeping the data query tool focused on the screens that commonly need reported on and thus easy to use. Note that the default value is False.
  • CallJSPartSelected (True or False) - This attribute is used to configure the hrMecca administration system to call client side javascript when a participant is selected by the user from the Icon Bar. For this to work properly, the CallJSPartSelected attribute needs to be true AND the load javascript logic for the screen needs to execute a SetScreenData.setJS() command.
  • CopyFrom - When this attribute is set, the system will create a screen that is copy of the screen that is referenced in the CopyFrom attribute. This attribute, while not commonly used, is useful if there is a need to have two separate tables/screens with exactly the same database/screen layout.
  • DialogReadWriteDatabase (True or False) - Typically, Dialog screen types do not have an underlying database table associated with them and consequently do not read and write to any database. If this attribute is set to true, then the system will create a database table for the dialog and will read from this table when the dialog is loaded and will write to this table when the Proceed button on the dialog is pressed.
  • DataQuerySortOrder - When the user is editing data queries, the screens that are displayed in the dialog where fields are selected for reporting on will be displayed in an order that is driven by the numeric value provided by this attribute. Using this attribute allows the screens that are most often reported on to be at the top of the list box that user select fields from.
  • DeleteAccessSecurity - This attribute controls whether or not the user can delete existing records. It works in conjunction with the AccessSecurity XML parameters.
  • DisplayHeight - For Dialog screen types, the DisplayHeight attribute determines the height of the dialog. For MultiRecord and System screen types, it determines the height of the detail area of the screen where the data input controls live.
  • DisplayName - The DisplayName contains the screen title that is displayed to the user at the top of the screen.
  • DisplayWidth - For dialogs (ScreenType=”Dialog”), the DisplayWidth attribute determines the width of the dialog. For screens, the DisplayWidth determines when the screen will stop “shrinking” and instead display a horizontal scroll bar.
  • HistoryFastLoad - MultiRecord and System type screens have functionality that allows the user to click on a specific history field and, when the record clicked on is displayed above in the detail area of the screen, the input focus will be on the field that was clicked on in the history section. There is also functionality that displays all of the fields that are not detailed in the history section in hover text. This functionality has a performance impact when hundreds of history records are displayed. For screens that have hundreds of history records, setting HistoryFastLoad to true will speed performance considerably.
  • ImplementorOnly (True or False) - When this attribute is set to True, then the screen will only be available to users who are setup in the Implementor XML.
  • MaxRecordsToDisplay - Because System type screens are not oriented towards employees, they can sometime contain a lot of records. The MaxRecordsToDisplay attribute will set a limit on the maximum number of records that are displayed. If a screen is presented to the user where the records exceed this limit, the system will only display the number of records in this attribute. The system will also display a message to the user indicating that there are more records but that they were not displayed.
  • Name - The Name attribute is used through out the system. The name determines the database table name that holds the data for the screen. Also, any reference to the screen will use the Name attribute. All Javascript commands that access data will access the data using this name.
  • NewAccessSecurity - This attribute controls whether or not the user can create new records. It works in conjunction with the AccessSecurity XML parameters.
  • NoCancel (True or False) - This attribute only applies to Dialog type screens. When it is set to True, no Cancel button will appear on the Dialog.
  • NoProceed (True or False) - This attribute only applies to Dialog type screens. When it is set to True, no Proceed button will appear on the Dialog.
  • PrintScreenCustomItemSection - Sometimes it is desirable to have a completely custom item section of the Print Screen report while retaining all of the header and footer information from the standard report. When this attribute is set, the “” section of the XML JFreeReport file that it references will used to create the report.
  • PrintScreenOrientation (Portrait or Landscape) - When the Print Screen icon (the icon that looks like a printer) is clicked on, a nicely formatted report will be created detailing all of the data on the current screen. If there screen is a MultiRecord or System type screen, there may be a lot of data to report on, causing the data to run off of the right hand side of the report. Setting the orientation to Landscape will flip the page orientation so that there is more horizontal space to work with.
  • PrintScreenReport - When the user clicks on the Print icon, a nicely formatted report is automatically created detailing the data on the screen as well as in the banner at the bottom of the screen. If there is too much data on the screen to fit on the report that is automatically generated or the data needs to be formatted differently, then this attribute can be set to the name of the JFree Report will be used instead of the generic one used for all Print Screen reports.
  • ProceedClose (True or False) - This attribute only applies to Dialog screen types. When the Proceed button is pressed on a Dialog, a new dialog will be launched once the proceed operation has completed indicating the status of the proceed operation. This would be something like a “Calculation has completed” or “Report has been generated” type message. When this attribute is set to “True”, the dialog that launched the status dialog will automatically close when the status dialog is closed. For example, it may make sense for a calculation dialog to chain to a form letter generation dialog once the calculation has completed. Setting the ProceedClose attribute to True on the calculation dialog would allow the chain to take place seamlessly. Otherwise, the user would have to close the calculation dialog before it would chain to the form letter generation dialog.
  • PullFrom - The PullFrom attribute allows you to use or inherit a screen definition from another client. This is handy or situations where have multiple clients that share some or all screens. Rather that having to define the screen in each client XML configuration file, you can define it once in a master XML file and have each client “pull” it from this file.
  • ReadWriteFrom - This attribute allows one client to read and write data from a screen on another client’s database.
  • SaveAccessSecurity - This attribute controls whether or not the user can save existing records. It works in conjunction with the AccessSecurity XML parameters.
  • SearchScreen (True or False) - The employee search area of the Icon bar allows the user to input a SSN, name, partial name or employee number. When a name is entered, the system needs to know which screen the FirstName and LastName fields reside on. Setting the SearchScreen attribute to True on the screen where first and last name live allows the system to know which screen they reside on.

[ back to Screen Configuration section ... ]