eXFORMA User Help Documentation
Welcome to the eXFORMA User Help Manual!
This guide is meant to introduce and direct you in using eXFORMA’s Custom Area. It is important to take note that this help documentation is using the basic custom area as a template, and that the custom area which you use may look slightly different as it may be customized to fit your organization’s needs and aid you in completing specific tasks. However, this guide still serves as a very useful aid in learning the basics of the eXFORMA custom area and its many standard features.
The first screen available to end-users in eXFORMA is the login screen. From the login screen you will be presented with 4 options:
Entering your username and password
Requesting a username and password
Proceeding to the eXFORMA Adminstrative login screen
Viewing the public calendars
Entering your username and password will take you into the custom area, which will be the focus of this help documentation. In order to request a username and password to login, simply click the ‘Need a login? Click here’ link and fill out the simple ‘Login Request’ form. If you would simply like to view the public calendars available, then select the Calendar link, which will direct you to the public Calendar of your choosing. For more information on Calendar, please refer to the Calendar section of this guide below.
If you are an eXFORMA administrator, then you cannot login to this section. You should select the ‘eXFORMA Login’ link, which will direct you to the eXFORMA Admin login area. Please refer to the eXFORMA Adminstrator Guide for more information.
Upon logging in, you will be presented with the main eXFORMA screen where your pending tasks are displayed to you. This screen can be divided into 3 major sections which will be discussed below.
- Top Menu Bar
- Left Side Bar
- Main Working Screen
Top Menu Bar
The top menu bar provides you with the ability to navigate between different applications available to you using tabs which are customized by a custom area administrator. It also contains the Logout button which logs you out of the system and returns you to the login screen, and the Print button which calls the browser print function to print the page you are currently on.
The tabs which are available vary greatly depending on the permissions which you have access to, but two tabs are common across all users: Work Items and Calendar.
Selecting Work Items simply navigates your main working screen to your task list which is already displayed to you upon logging in. If you are working in other parts of eXFORMA and would like to go back and check if you have any tasks waiting for you, simply select the Work Items tab and you will be returned to this screen.
Selecting Calendar will display the calendar application on your main working screen. This application is further discussed below in its own section, so please refer to that section for more information.
The other tabs available to you from on the top menu bar will take you to the corresponding application on your main working screen, and will change the options available to you on your left side bar. There are a wide range of applications available to eXFORMA users, which serve a wide array of different purposes. Although these applications may be extremely varied in purpose, navigating your way around them is mostly the same, and will be discussed below in the Left Side Bar and Main Working Screen sections.
Left Side Bar
The left side bar changes depending on the section of eXFORMA you are in. There are three different sections which change the left side bar for eXFORMA users: Work Items, Application Tabs, or Calendar.
At the main Work Items page, which is displayed to you when you first login, you can see two menus here which can be accessed by clicking the double-down arrows next to the name – File Summary and Tools.
The File Summary menu shows you a list of all current tasks that you have to complete. It divides the tasks into statuses, dependant on the process it is associated to. This allows you to filter out tasks and separate them according to your needs by selecting the little number next to the task. When a task is filtered, you will be able to view more information on the task list which is specific to the task you have selected.
The Tools menu allows you to view/edit your user profile. If you have custom area administrative privileges then you will also see the custom preferences option, which allows you to add/change the tabs available to custom area users.
If you select one of your Application Tabs then the Left Side Bar will change to show you four menus which are specifically related towards the application you selected: Knowledge Center, CategoryName, Form Submissions, and Tools.
The Knowledge Center gives you access to documents available for the selected tab. These documents can be saved and viewed by selecting them from the list.
The next menu changes according to the name of the category which the tab is pointing to. In the case of the image here, the category name which contains the forms which you will be working with is GroveWare. Regardless of the name that appears here, the function is the same. This menu lists the forms available to you in that selected category. The form you select from this list will be displayed to you in the Main Working Screen.
The Calendar tab will also change the left side bar and give you more options. For more information please see the Calendar section below.
Main Working Screen
The main working screen is the area where you can complete forms and tasks, view submissions, calendars, options, etc. This is the place where you will be doing most of your work. The Top Menu Bar and Left Side Bar are used to navigate you to specific locations which are displayed to you here on the main working screen.
To fill out a form, simply type or click in the required information and click the submit button on the bottom. Forms vary widely depending on its purpose, but the submission process remains mostly the same. Once you have clicked submit, simply confirm your submission details and information by scrolling along the Preview Submission page, then click Confirm Submission on the bottom of the page. This should take you to the Submission Complete page, where you can view your submission details once more.
You can navigate to view your submissions using the Left Side Bar as is described above. The e-form submissions page presents you with the following information and options:
- Submission Details – displays date of submission and author of submission
- Description – displays select information found in the submission
- Revision – shows which version number the submission is currently at. If a form is edited and re-submitted, then this number increases and displays the new submission details and description associated with the revision. To view old revisions, simply select which revision number you would like from this pull-down.
- View – displays the currently selected revision of the form with all the information and none of the elements being displayed. Useful for printing purposes.
- Edit – Allows user to edit the submission and add/remove information from the fields. This creates a new revision.
The calendar available to users is accessible through the Calendar tab on the Top Menu Bar. Selecting this tab will change the Left Side Bar to display the calendar options to you. These include:
- Event Search – Search for existing events on all calendars for which you have permission to
- Calendar Select – pull-down has list of accessible calendars, and allows you to select whether to view the selected calendar in yearly, monthly, weekly, or daily view.
- Month Selection – select which month you would like to view for the current calendar. If you wish to view a day’s events, select the day from the side bar calendar to display it on the main working screen.
When you enter the calendar, the main working screen will display upcoming events to you. The top of the screen displays your sub-calendars for quick navigation, followed by tabs which allow you to browse today’s, this week’s, this month’s, and this year’s events on the main calendar. This is followed by a short list of the events, displaying its title, time, date, location, and which calendar it is located in. For a quick list of what events are coming up on a specific sub-calendar, you can view the lower part of this page which will display to you a link for the more immediate events for each, with the most immediate on top.
In order to switch to calendar view, simply select the name of the sub-calendar you wish to view on the sub-calendars section, or select Switch to Calendar View located right above the sub-calendars section. The calendar section displays the selected calendars events in a monthly view at first. A more detailed weekly or daily view can be viewed as well by selecting week on the left hand side or selecting the specific day you would like to see more information on.
Installing and Configuring MobiTask
MobiTask can now be predominately configured from the web by an administrator and those settings synced out to the users in the field to make managing the application even easier.
Like with the Group and User permissions systems eXFORMA can be used to set a variety of MobiTask parameters. These are accessible by clicking the ‘Settings’ link under the Mobile column on both the Group and User Administration pages.
There are a range of parameters that can be set by using this interface. Click in the ‘Parameter Name’ field to display a list of available parameters.
The table can be used as a reference for currently available control parameters.
|Parameter||Description||Default value||Possible values|
|service_host||Base URL of eXForma. This parameter will change URL for profile not for user!||http://demo.GroveWare.com||URL|
|cat_form_id||Comma delimited list of form categories||1,3|
|cat_edocs_id||Comma delimited list of edocs categories||2|
|items_show||List of icons to show||Empty (Everything is visible by default)|
|items_hide||List of icons to hide||Empty (Nothing is hidden)||tasklist, accounts, eforms, edocs, reports,
transfers, help, settings, sync
|user_change_disabled||When true only last successfully logged in user can login to MobiTask||false||true/false|
|user_delete_onchange||Delete previous user’s data when new user successfully logins in||false||true/false|
|autologin_enabled||Show ‘Remember Me’ checkbox on the login page.||false||true/false|
|auto_login||It’s ‘Remember Me’ checkboxes value. It’s not necessary to change this parameter!||False||true/false|
|always_authentification||Ask for username/password on each sync/submit||false||true/false|
|demo_mode||Skip authorization, use demo/demo as username/password.||true (For the first installation only! After any change in Settings it will be turned to false)||true/false|
|log_level||Level of debug messages||4 (info)||2 (debug), 8 (error), 4 (info), 6 (warn)|
|cleardb_enabled||Show/hide reset buttons in Settings/Reset DB||true||true/false|
|firstlogon_settings||Not supported yet||true||true/false|
|accept_license_flag||For the first run when the flag is false MobiTask shows license agreement.||false||true/false|
|service_exforma||URL for Exforma service||jboss-net/services/Exforma|
|service_edocs||URL for EDocs service||jboss-net/services/EDocs|
|service_file_upload||URL for file upload service||eforma/secure/upload.do|
|service_file_download||URL for file download service||eforma/fileservice|
|fLeaveSentSubmissions||Delete submission after its successful submission when this flag is false||true||true/false|
Update: long shortcut label support
- set title_color for the first login with new color
- pulldown: list of values can show multi-line values (if size is set to more than 1). size property limits number of lines visible
- new mobile settings: titlebar_color (default=MobiTask blue), icon_color (default=gray), icon_accent_color (defaulted to titlebar_color)
- bug fix: dbconnector was clearing bonded data on error
- minor bug fix: On task list active sort button was shown as white on white
- groupButton: background colour property, onClickAction, counter
- popDlg – adjustments for actions
- sentence – clickEvent, custom style property
- custom shortcut images from settings
- button: button as action, form buttons
- calendar: min/max properties
- connector: property mapping
- new element properties: visible, hidden, enabled, disabled etc. (see FormObject)
- new special variables: $_title_, $_formchanged_, $_backlabel_
- bug fixed with switching between as4 and wf9 jbosses
- shortcuts on the main screen
- Actions! (see Script)
- bug fixed: obLoad dbconnectors are now delayed until form fully loads and renders
- titlebar_color mobile parameter, also applies to emphasized buttons
- doSync, doUpload, doSyncUpload actions
- changed sync procedures
- Sentence, Button have references now. And it’s possible to map dbconnector output directly into sentences.
Please update your MobiTask for Windows.
Important to test:
- Sync forms/tasks and upload submissions
- onLoad dbconnectors
New features description
$_formchanged_ (read/write) – returns 1 or 0.
$_title_ (read/write) – returns the title of the form $_backlabel_ (read/write) – returns the label of Cancel (Back) button $formid, $formId (read only) – current formId $_sqlerror_ (read only) – error message of last executed dbconnector $_sqlrows_ (read only) – number of rows returned by the last execution of a dbconnector $_sqllastid_ (read only) – generated id by the last executed dbconnector. Experimental, not fully supported yet.
$_sqlrowsaffected_ – total number of affected rows $userId – username $rownum – row number in repeat $rowpos – dot delimited (if nested) position of row in repeat(s).
$_cr_, $_lf_ – CR and LF characters. May be useful in SQL statements.
Now it’s possible not only to set values of elements on form but also to change it’s properties with DB Connectors. Properties are mapped with . (dot) after reference in DB Connector’s mapping. For example:
select 1 disable_lastname from dual
List of properties supported:
General: visible, hidden – visibility of a field. (‘1′, ‘yes’, ‘true’ => true, anything else => false) enabled, disabled – enable or disable a field required – required labelStyle – defines label style of a field. Style is defined in HTML format: font-weight: bold; color: #FFFFFF; fontStyle: italic; text-decoration: underline;
Sentence: textstyle – Sets style of sentence (same format as for labelStyle)
GroupButton: label, buttonlabel – sets text on Group Button counter – sets value of Group counter (listitem type only) pencolor, countercolor – sets color of counter groupcolor – sets background color of listitem group
Calendar: mindate, min – sets min value for date selector maxdate, max – sets max value for date selector
Elements and events supported by MobiTask:
Form – onLoad, onCancel, onSubmit
Button – onClick
Textfield, Pulldown, Radiobutton, Checkbox etc. – onChange, onBlur, onKeyUp, onClick, onFocus
Note: Button element has now additional property ‘Hidden’. No needs in hidden tables for those Action buttons.
sendPreview(formId): - sends form as submission with formId without submitting (closing the form)
showPreview(): - opens form with mobile template (xhtml)
openForm(formId[, 'ref1', 'val1'][, 'ref2', 'val2']…): - replaces current form with new one and sets it’s references with values
Ex: openForm(123, ‘ref1′, ‘val1′); openForm(123, ‘ref1′, ’1′, ‘ref2′, ‘$(myref2)’);
pushForm(formId[, 'ref1', 'val1'][, 'ref2', 'val2']…): - opens new form on top of the current one (pushes new form to the form’s stack)
popForm([‘actions’[, 'ref1', 'val1'][, 'ref2', 'val2’]…]): - closes current form and pushes values to the previous form from stack and then calls the list of actions (comma-delimited list)
Ex: popForm(); popForm(‘act1,act2’); popForm(‘act1′, ‘ref1′, ‘val1′ …); popForm(”, ‘ref1′, ‘val1′, ‘ref2′, ‘val2′ …);
showDialog(‘Title’, ‘Message’[, ‘dialogtype’[, ‘icon’[, ‘firstHandler’[, ‘secondHandler’[, delay[, 'Details']]]]]]): - shows dialog message
dialogtype – OK | OKCANCEL | YESNO | PROGRESS | BUSY
icons – ADD | ALERT | CANCEL | CLEAR | CLOSE | DELETE | EDIT | HELP | INFO | MORE | SAVE
firstHandler – list of actions to execute on the first button (OK, YES)
secondHandler – list of actions to execute on the second button (CANCEL, NO)
delay – timeout in seconds to auto close the dialog (executes OK for OK, CANCEl for OKCANCEL, NO for YESNO dialog types)
Details – longer message hidden under Details button
doDBConnectors(document.showform, ‘connectors’, ’none’): - executes list of DB Connectors (old style, web-compatible)
doConnectors(‘connectors’, ‘errorHandler’, ‘successHandler’); - executes list of DB Connectors (comma-delimited) and calls actions on error or on success
(Not supported on web)
errorHandler – list of actions to execute on error. An error stops further execution of connectors in the list
successHandler – list of actions to execute when all connectors are finished successfully
doActions(‘actions’): - executes list of actions
doActionsWhen(‘value’, ‘whenVal1′, ‘handler1’,[ 'whenVal2', 'handler2’,] …[‘handlerOther’]): - executes actions with condition. When value (as String) equals ‘whenVal1’ then call actions from handler1.
When value equals ‘whenVal2’ then call actions from handler2 etc. Otherwise call actions from handlerOther.
Ex: doActionsWhen(‘$(id)’, ‘’, ‘notFoundAction’, ‘foundAction’); doActionsWhen(‘$(type)’, ‘1’, ‘action1’, ‘2’, ‘action2’, ‘3’, ‘action3’, ‘otherAction’);
doActionsWhen(‘$(id)’, ‘’, ‘’, ’idNotEmptyAction’);
Hint: Use SQLlite mobile statements to generate actions selector with more complicated conditions.
showTables(‘hideshowList’): - hides or shows tables from the list. It’s a comma-delimited list of table numbers. Tables prefixed with ! will be hidden.
Ex: showTables(‘1,!2’); – show table 1, hide table 2
doSync(‘errorActions’, ’successActions’); - calls system’s Sync procedure (with messages and optional authentication). Sync only (forms, tasks, tables). No submission uploads.
doUpload(‘errorActions’, ’successActions’); - same as sync but it uploads submissions. No forms, tasks, tables synchronization.
doSyncUpload(‘errorActions’, ’successActions’); - syncs and uploads with two parallel processes.
playTone(frequency, duration); - plays a simple sine tone with given frequency (Hz) and duration (ms).
playMusic(‘musicScript’); - plays a melody using GW Basic play command notation. See http://hwiegman.home.xs4all.nl/gw-man/PLAY.html
* Music language supported (GW Basic):
* The single-character commands in PLAY are as follows:
* A-G [#,+,-]
* A-G are notes. # or + following a note produces a sharp; – produces a flat.
* Any note followed by #,+,or – must refer to a black key on a piano.
* L(n) – Sets the length of each note. L4 is a quarter note, L1 is a whole note, and so on. n may be from 1 to 64.
* Length may also follow the note to change the length for that note only. A16 is equivalent to L16A.
* NS: MF Music foreground. PLAY and SOUND statements are to run in foreground. That is, each subsequent note or sound is not started until the previous note or sound is finished. This is the initial default.
* NS: MB Music background. PLAY and SOUND statements are to run in background. That is, each note or sound is placed in a buffer allowing the BASIC program to continue execution while music plays in the background. As many as 32 notes (or rests) can be played in background at one time.
* MN Music normal. Each note plays seven-eighths of the time determined by L (length).
* ML Music legato. Each note plays the full period set by L.
* MS Music staccato. Each note plays three-quarters of the time determined by L.
* NS: N(n) Play note n. n may range from 0 to 84. In the 7 possible octaves, there are 84 notes. n set to 0 indicates a rest.
* O(n) Octave 0 sets the current octave. There are 7 octaves (0 through 6). Default is 4. Middle C is at the beginning of octave 3.
* P(n) Pause. P may range from 1-64.
* T(n) Tempo. T sets the number of L4s in a minute. n may range from 32-255. Default is 120.
(period) – A period after a note increases the playing time of the note by 3/2 times the period determined by L (length of note) times T (tempo). Multiple periods can appear after a note, and the playing time is scaled accordingly. For example, A. will cause the note A to play one and half times the playing time determined by L (length of the note) times T (the tempo); two periods placed after A (A..) will cause the note to be played at 9/4 times its ascribed value; an A with three periods (A…) at 27/8, etc.
Periods may also appear after a P (pause), and increase the pause length as described above.
Executes a substring, where string is a variable assigned to a string of PLAY commands.
Because of the slow clock interrupt rate, some notes do not play at higher tempos; for example, 1.64 at T255. These note/tempo combinations must be determined through experimentation.
n A greater-than symbol preceding the note n plays the note in the next higher octave.
<n A less-than symbol preceding the note n plays the note in the next lower octave.
NS = Not Supported
WQ – square wave form
WS – sine wave form
For Example: t220 l4 wq ml d8e8 f# mn aa.b8 af#d.e8 f#f#ed e2.p16 ml d8e8 f# mn aa.b8 af#d.e8 f#f#e#e# d1 p16 ws g2g2 bb2b aaf#d e2. wq ml d8e8 f# mn aa.b8 af#d.e8 f#f#ee d1=