UGApplications
From JACOBWiki
Contents |
Title page
TM
Applications
Getting Started Manual
[edit] Overview
This document describes the general lay out of jACOB applications as provided by Tarragon. Other developers may elect to mask or only partly use some of the elements we decribe below.
[edit] Elements of a jACOB application user screen
[edit] Screen groups
A jACOB entry screen in Tarragon’s jACOB applications consists of four main areas:
[edit] Groups within a jACOB application
[edit] Navigation / Menu
This area shows a single focus or domain of the application. Within a domain there can be one or multiple screens. In this example:
Domain: Incident Management
Screens: Incidents, Contacts, Attachments
By clicking on one of the screen menu’s you will see that the fields in the data entry area change. When you change screens the data that you entered in the previous screen will remain in tact.
Dependant on the selected theme the look (not the characteristics) of a screen may change. An example of this is the socalled outlook bar where each sreen is represented by an icon (s. Themes).
[edit] Quick Access / App. Wide Functions
This area contains a range of functions that can be activated or masked for the individual user. Position and click the right mouse button in the empty area to the right of the buttons and press the properties button.
A dialog box as shown below will appear. Tick the menu items you need.
The individual functions:
[edit] Exit
Use this button to exit the application. On exit all entries you have made during this session are automatically saved.
[edit] Clear
The clear buttons delete the contents of the relevant screens within the application.. „Clear All" deletes the contents of all screens. „Clear Domain" only deletes the contents of screens within the selected domain and „Clear Form" clears the actual screen only. Within a jACOB application these functions are important. You must clear unwanted entries from fields before doing a search, because all entries in fields in any screen (of a domain) are included in the search criteria (s. QBE)
[edit] Report
The report function enables you to create, change and show simple adhoc reports. When creating a report, first select the required data elements (s. QBE). Next press the „Create Report" button. The system changes to a create report mode.
Next, in the data entry screen, click on the labels of the fields screen that you want to use in your report. You can navigate between the screens in your domain.
After you have selected the fields, you can change their position by using the green arrows (1). By clicking the red „x" a field can be deleted from the report (2) and by clicking on the field label (3) you can change or determine the sorting order. In the field „Report name" you enter the name of the report The „private" box should be ticked if the report is for your eyes only. Otherwise leave the tick box blank.
Next save your report by clicking the „Save" button. To view or change your report click the „Report..." button.
Select a report: In the General data screen you will se a preview outline of the selected report. By using the „show" button you can see the contents of the report in an excel sheet. Changes to the report can be made by exercising the "edit" button..
At the bottom of the screen there is a section called „Scheduler Data", which enables you to subscribe to the report. Select the day(s) of the week and fill in the exact time and format in which you want to receive the report and the system will send it to you as requested.
[edit] Themes
With this button various socalled skins can be selected for the application This will change the look but not the behaviour or functionality of the application. Your selection will be saved for the user. (s. Exit)
[edit] Print Preview
This function shows the screen in printable form and allows the actual printing.
[edit] Show SQL
When this function is activated any user interaction that initiates a SQL statement, is shown in a separate window. This function aids application deverlopers or individuals who use external tools (e.g. Birt, Cognos, Crystal …) to create reports or database enquiries.
[edit] Alerts
This button is only of use when the application supports alerting. In that case, a screen showing all entered alerts is shown at regular previously determined intervals.
Select „Sent" or „Received" alerts. Click on the message that you want to see the details of and the message is opened. The delete button deletes a message (only for the user that is logged on). With the reload button you refresh the alerts. „Suspend this Dialog" suppresses the automatic display of this screen.
[edit] Send Message
The „Send Message" button is used to send messages to individuals that are recognized by the system as being users. These messages are sent as Alert (s. Alerts) or through another channel known by the system (Email, Fax, SMS …)
Select the message type. Determine if the message should be sent to all users or to selected users by name only. If by name, then search for the appropriate adressees. Prepare your message (take into account the message channel. Messages that are too long will be truncated). When you open the alert window and select „sent", your message will appear.
[edit] Password
If the application has been set up in such a way that the user can change his pass word, he/she can do so by clicking this button. If this option has not been activated a message appears stating that the function has not been implemented.
[edit] New window
Always use this button when opening a second window. Do not use the explorer function to achieve this while the latter synhronizes both windows, which is exactly what one does not want. An alternative is to start a new Internet Explorer.
[edit] Hitlist / Search Results
Search results are shown or selected here. By pressing the „Search" button in the data entry area, the table is filled and results are shown by clicking on one of the data lines. In addition all connected datalines of screens in a domain are also shown.
Other hitlist functions
Sorting
Standard sorting of this screen can be changed by clicking on the column headings. One click: Move upwards. Two clicks: move downwards. Three clicks removes the sorting. Sorting setting remains during the session.
The number of hits are shown in the top right hand corner. There is a parameter (Maxrecord, s. Admin. manual) to control the number of hits. Standard is 100 data lines. If only a count is shown in the display all the lines are shown. If the display shows a count followed by „ /?", more lines are available. The user can fine tune his search or click the middle icon to repeat the search with the system maximum. The system maximum is also a parameter. The number of hitts display is now changed and shows the maximum record set by the parameter as well as the total number of lines available.
.
With the right icon the search is repeated.
With the left icon the data are exported to Excel where the data can be further edited..
The tabs in the browser edge (bottom left) allow you to change between hitlists. Each entry group has its own list. When using the „Search" buttons the system automatically changes to the appropriate hitlist but by clicking the tabs you can also change manually.
By dragging the bottom bar (arrow), the area of operation can be increased or decreased.
[edit] Input area
The input area always consists of one or more groups. A group provides a table view.. Within a group there are data entry fields that in most cases are connected to tables. In addition the application normally includes standard buttons for he execution of either standard or application specific functions.. Standard functions include; search, new entry, change entry or delete..
There can also be context menu’s which can be accessed by clicking the right mouse button in one of the empty areas in the group.
The groups have different modes.
- Search
In this mode every entry field can be used as a search criterion. All dates that have been added in search mode constrain the search. This function is known as QBE (s. QBE)
- New
In „new" mode new data are added The standard application has been designed in such a way that input aleady visible on the screen is used as default for the new entry. If this is not wanted the „Clear" button should be pressed. - Update
In this mode changes can be made.
[edit] Data entry elements
In data entry the following elements are available:
- Text entry field
Is used for the entry of alphanumeric or numeric values
- Combobox
In update mode this is used for the selection of a list value.
In search mode this is used to select one or more search criteria. (For instance: show all data related to sales activity or customer management or order)
- Long text field
Inline Modus
Dialog Modus
On clicking a dialog box appears.
Is used to create long texts
- Date/time field
Is used to enter date and/or time. The data van be entered manually or with the aid of a calendar.
- Checkboxes
Is used for the entry of Boolean values (yes/no, 0/1)
- Foreign Fields
This feature enables the connection of data elements. (for instance connect „Order" to „Organization", in which case you fill the box with „order".)
Values can be entered manually or selected from a list by clicking on the looking glass.
The icon will change after slection of the appropriate entry.
[edit] QBE
Qbe enables you to utilize all data entry field of one or more screens as search criteria. The appication settings determine whether the fields of the screen that is visible on your computer, the screens within a domain, or all screens within anr application are taken into account .
Example: Show all sales activities for the individual called „Doering", with status assigned. Enter data as shown on the screen below and then press the search button.
Search options depend on field type. For instance in text fields use „start with", „end with" For numerical fields use „>" „<", and for date field one can use time ranges (1.1.05..1.1.06) or commands like „today", „thisyear" …
It is jACOB standard that data entries are „and" connected. An example: Show all lines concerning „sales activities" and undertaken by an individual called „Doering" and with the status „assigned".
If an „or" connection is required start the data entry with „|".
Below is a list of individual functions:
| common modifiers: | ||
| | | logical OR | Examples: john|liz or 1|2|6..10 |
| | | leading logical OR | Examples: |john or |6..10 |
| i.e. grouping logical OR | Note: Explanation see below! | |
| ! | logical NOT | Examples: !NULL or !completed |
| NULL | field is empty | Examples: NULL|new or !NULL |
| > | greater than | Examples: >8 or >d |
| >= | greater or equal than | Examples: >=1.1 |
| < | less than | Examples: <-4.5 or <0|>10 |
| <= | less or equal than | Examples: <=0 |
| text modifiers: | ||
| = | enforce exact match | Examples: =completed |
| ^ | enforce left anchored | Examples: ^SELECT |
| $ | enforce right anchored | Examples: ing$ |
| & | logical AND | Examples: error&SQL |
| * | wildcard | Examples: Bill*ates |
| ? | single char wildcard | Examples: No.??? |
| " | escape text literals | Examples: "<tag>" (interpret > and < as normal characters) |
| numerical modifiers: | ||
| .. | range | Examples: 0..100 |
| datetime modifiers: | ||
| today | date value of today | Examples: <=today-7d |
| now | timestamp value of now | Examples: >now-1h |
| .. | range | Examples: now-24h..now |
| thisy | this year range | Examples: thisy or thisy-7d (previous year range) |
| thisq | this quarter range | Examples: thisq or thisq-3m (previous quarter range) |
| thism | this month range | Examples: thisq or thisq-1m (previous month range) |
| thisw | this week range | Examples: thisw or thisw-7d (previous week range) |
| ytd | this year to date range | Examples: ytd or ytd-1y (previous year to date range, e.g. 2004-01-01..2004-05-13) |
| qtd | this quarter to date range | Examples: qtd or qtd-3m (previous quarter to date range, e.g. 2004-04-01..2004-06-03) |
| mtd | this month to date range | Examples: mtd or mtd-1m (previous month to date range, e.g. 2004-05-01..2004-05-27) |
| wtd | this week to date range | Examples: wtd or wtd-7d (previous week to date range) |
| weekx | calendar week x of this year | Examples: week1 or week1..week10 |
| [+-]xsec | add/sub x seconds | Examples: now-30sec..now |
| [+-]xmin | add/sub x minutes | Examples: now-10min |
| [+-]xh | add/sub x hours | Examples: now-13h |
| [+-]xd | add/sub x days | Examples: today-14d |
| [+-]xm | add/sub x months | Examples: today-3m |
| [+-]xy | add/sub x years | Examples: today-1y..today |
