View page - JavaScript

1. General information

1.1. Description of the control

JavaScript is a control that allows any javascript code to be embedded in the body of the view page. The javascript code will be automatically executed when the view page is loaded, and it is possible to debug it directly in the web browser in the javascript console (e.g. in Google Chrome, the javascript debugging console is displayed using the keyboard shortcut “CTRL+Shift+J”).

• The code runs when the browser loads the corresponding place of the page – i.e. before the controls placed below exist. After an ajax update of the view page it does not run again. In the FULLAJAXMODE() mode, on the other hand, it runs only after the whole page has loaded and again after each ajax update; values inserted by the server remain from the first load.
• Calling an external function through the “ngef.aspx” page is allowed only if the text “ngef.aspx?Identifier” is written literally in quotation marks in the code. A detailed description is provided in the separate guide External functions.
• Variables and functions used in the code are evaluated by the server and their values are inserted without escaping – details are provided in the separate guide JavaScript functions.

1.2. Create a new control

The new javascript can be created as follows from the view page using the toolbar with controls:

• First, clicking on the view page determines the position in which the new javascript should be placed. This will highlight the selected position with a gray horizontal line. Then just click on “JavaScript” in the toolbar of the view page, fill in the attributes of the new control in the newly opened dialog, and then save. This will insert a new javascript at a pre-selected location on the view page.
• If the required position is not determined before inserting a new javascript, the new javascript will be inserted at the end of the view page.

1.3. Edit or delete a control

• For each existing control, a pencil icon appears to the left of the control on the view page to change or delete the control's settings.
• Individual controls can be moved vertically on the view page using the Drag&Drop method. Moving consists of grabbing the control, preferably behind its name, and then dragging it to the desired location on the view page.
• Controls can be moved only with the “Drag&Drop” check box located above the toolbar with controls selected. For security reasons, this check box is cleared after each login to the application, so that a control is not moved by accident.

2. List of tabs in the control settings dialog

• General – Setting general properties
• Help – Javascript editor help
• Rights – Rights settings
• Administration – Setting other properties

2.1. “General” tab

2.1.1. Name

• The name of the control.
• The drop-down list offers the name “display()”. If the code of the control is empty, selecting it inserts the template of the “display()” function into the code.

2.1.2. Variables and functions

• Drop-down list with a selection of variables, javascript and server functions that can be used inside javascript code.
• A detailed description of the variables is provided in the separate guide Variables.
• A detailed description of javascript functions is provided in the separate guide JavaScript functions.
• A detailed description of the server functions is provided in the separate guide Server functions.

2.2. “Help” tab

• Overview of the keyboard shortcuts of the javascript code editor. The tab is displayed only when the code editor is enabled.

2.3. “Rights” tab

2.3.1. Rights

• Rights define a list of user groups and users who have permission to display the control on the view page.
• For a new control, the rights are prefilled from the control at the position selected before inserting it; if no position is selected, from the rights of the view page.

2.3.2. Replace rights to other controls

• The “Replace rights to other controls” feature is used to unify rights across the entire view page for controls that are related in terms of rights.
• Thanks to the “Show...” link, it is possible to display a list of all controls on the view page, including the settings of the rights of these controls. A check box is displayed for each control to select it. When the control is saved, the same rights are then set for the selected controls.
• An alternative for unifying rights within the entire view page is the overview of the rights settings of all controls, displayed by the “Show summary...” link on the “Rights” tab in the view page settings.

2.4. “Administration” tab

• The “Administration” tab is only displayed for existing controls.

2.4.1. Location

• Select the view page on which the control is located.
• The drop-down list contains the view pages located in the same application and in the same category as the view page on which the control stands. For a view page without a category, it offers only view pages without a category. For a new control, it contains only the current view page.

2.4.2. Dictionary

• The dictionary displays a list of calls of the “alert” and “confirm” javascript functions and of the “COLORLEGEND” server function used throughout the NET Genium installation.
• Dictionary search is used to design the correct form of user messages and to maintain the consistency of nomenclature throughout the application.

2.4.3. Change tracking

• Change tracking displays a detailed report with all changes made to the javascript code by individual users.

2.4.4. Compare

• The “Compare” button is used to compare the javascript code on the “General” tab with another version of the code, which the administrator inserts into the text field on the “Administration” tab.
• After pressing the button, a comparison table with two columns is displayed:
  • General – values displayed on the “General” tab,
  • Administration – the corresponding values from the “Administration” tab.
• If the values in the same item differ, the system highlights the difference in red text.
• A textual summary of discrepancies (e.g., “General is not equal to Administration”) is displayed in a dialog.

2.4.5. References

• The “References” button is used to display the JavaScript content from the “General” tab, in which all occurrences of “el(BT123)”, “bt_Click(BT123)”, “button_Enable(BT123)”, and “button_Disable(BT123)” are replaced with corresponding links that allow quick access to the settings of the button referenced in these four JavaScript functions.

2.5. “Save”, “Save and continue editing”, “Copy”, “Delete”, and “Close” buttons

• “Save” button – Saves changes to the control settings.
• “Save and continue editing” button – Saves changes to the control settings and keeps the settings dialog open for further modifications.
• “Copy” button – Creates a new copy of the current control with identical settings, but with a newly generated unique identifier.
• “Delete” button – Permanently deletes the control.
• “Close” button – Closes the control settings dialog without saving changes.