Global Features
The Global Features Guide will instruct you on how to setup and use the core application tools in eTime Xpress.
eTime Xpress
Global Features Guide
(For versions 7.008.000 and above)
Table of Contents
1. Overview
This document describes how to use the global features found in eTime Xpress. Global features share a common design and interface so once you learn how to use a global feature, you should be able to apply that tool wherever it appears in eTime Xpress.
2. Lookups
The lookup is the main search tool for finding information in eTime Xpress. The lookup contains configuration options which allow you to customize what information is presented.
Most lookups in eTime Xpress are configurable allowing multiple search layouts to be defined, saved and reloaded.
To configure a lookup, click on the lookup icon ( ) corresponding to a data object (i.e. Employee, Customer or Site lookups). For illustration, the Employee lookup window is shown in the figure below.
Lookup Window
Toolbar | Description |
Layout Selector | Select lookup layout. Layouts followed by "*" are system defined lookup layouts. |
Results Tab | Description |
Lookup Browser | Displays search results. To customize the browser view, right click and select Configuration. |
View Tab | Description |
Filter Selector | Select record filter and the field filter parameters will be displayed. You may update the values of field filters to run ad hoc searches. |
Filter Manager | Define custom record filter. |
Refresh | Run search based on selected filter and field parameters. |
Configuration Tab | Description |
Save | Save lookup configuration. |
Add | Add lookup layout. |
Delete | Delete lookup layout. |
View/Hide Layouts | Users may customize which layouts will appear in their layout selection list. |
Set current layout as your default layout | Set the selected layout as your default lookup layout. |
Apply | Apply lookup layout. |
Lookup Layout | Select lookup layout. Layouts followed by "*" are system defined browser layouts. |
Browser Layout | Select browser layout to be applied under Results tab. Layouts followed by "*" are system defined browser layouts. |
Filter | Select record filter. |
Window width | Specify window width. |
Window height | Specify window height. |
Show Filter Description | Check-off to display filter parameter description. |
3. Browsers
The browser is the main display tool for viewing information in eTime Xpress. The browser contains configuration options which allow you to customize how information is presented.
Most browsers in eTime Xpress are configurable allowing multiple layout views to be defined, saved and reloaded.
To configure a browser, right click on a browser (i.e. Employee, Customer or Site browsers) and select Configuration. The Configure Browser View window should appear similar to the figure below.
Configure Browser View
Toolbar | Description |
Close | Close window. |
Save | Save browser configuration. |
Add | Add browser layout. |
Delete | Delete browser layout. |
View/Hide Layouts | Users may customize which layouts will appear in their layout selection list. |
Set current layout as your default layout | Set the selected layout as your default browser layout. |
Apply | Apply browser layout. |
Layout Selector | Select browser layout. Layouts followed by "*" are system defined browser layouts. |
Display Tab | Description |
Column Movable | Check-on to enable movable column feature. |
Column Resizable | Check-on to enable resizable column feature. |
Available Columns | List fields that can be displayed. |
Selected Columns | List the order of fields to be displayed in columns. |
Sort Tab | Description1 |
Sort Fields | List the field sort order with ascending/descending property. |
Update | Update sort order. |
Field | Define record sort order based on fields and ascending/descending property. |
Browser Filter | Description |
Enable Browser Filter | Check-off to enable the Browser Filter feature. If enabled, a search bar will appear above the browser allowing user definable searches according to the filter criteria defined. The Browser Filter feature can be used to define your most common search being run for that browser. |
Browser Filter Query | Specify the field criteria which you want to filter on. Each field is joined by an 'And' condition. |
Operator | Specify the matching condition to be applied to each field criteria. |
About Tab | Description |
Layout Name | Layout name/description. |
Created by | List user that created layout. |
1 Sort is available in certain browsers only.
4. Filters
The filter tool in eTime Xpress allows you to define customized searches. Filtering can be applied to create customized lookups, browser views, schedule views, business rules and more.
For example, a filter can be created to match a specific group or type of employees, customers, sites or shifts.
4.1. Creating Filters
Filters are created using the Filter Manager and can be run by clicking the filter icon ( ) found throughout the application. Separate filters are required to be created for data object type.
The Filter Manager will look similar to the screen below.
Filter Manager
Annotation | Description |
(1) Filter List | List of filters. |
(2) Field Filters | List of field criteria. Each field criteria is joined by an "And' condition. |
(3) Operator | Matching condition to applied. |
(4) Value | Field value(s) to be matched. |
(5) Filter Details | Text description of filter parameters. |
To create a filter:
Click the Add Filter button.
Enter a Code and Description.
Click the Add Field button to define filter criteria. If multiple fields are defined, an 'AND' relationship is applied between each field.
Using the Operator pull-down, select the matching condition to be applied on the field. The selection of operators will vary by the field selected.
In the Value field, enter the field values(s) to be matched.
Click the Save button to save the filter.
Note: If you are creating multiple filters with similar properties, use the Copy filter option to clone a filter and then update as required.
4.2. Field Operators
The following operators can be used when entering filter conditions for search criteria:
Operator | Description |
Equal to | Use for an exact record match. |
Not equal to | Use for records that don't have the value you enter. |
Less than | Use for results that are less than the value you enter. |
Less than or equal to | Use for results that match or are less than the value you enter. |
Greater than | Use for results that exceed the value you enter. |
Greater than or equal to | Use for results that match or exceed the value you enter. |
Between | Use for results that match or are within the range of values you enter. |
Not between | Use for results that are outside of the range of values you enter. |
Starts with | Use when you know what your value starts with, but not the exact text. |
Does not start with | Use when you know what your value starts with, but not the exact text and want to exclude it. |
Is like | Use for fields that include your search string but might also include other information. |
Is not like | Use for fields that exclude your search string but might also include other information. |
Is one Of | Use for a record match to one of the values you enter. |
Is not one Of | Use for records that don't match the values you enter. |
4.3. Universal Filters
When a filter is created, by default it can be applied in the Company Branch it was created. Universal filters are filters that are published for use in all Companies and Branches.
To publish a filter as a universal filter:
From the Filter Manager, select the filter you want to define as a Universal Filter.
Click the About tab.
Check "All Company Branches".
Click the Save button.
To unpublish a filter as a universal filter:
From the Filter Manager, select the filter you want to unpublish as a Universal Filter.
Click the About tab.
Uncheck "All Company Branches".
Click the Save button. The unpublished Universal filter will only be available in the Company Branch where it was updated to the non-universal status.
Special care should be taken when updating a universal Filter to be non-universal. In Companies and Branches where the filter is no longer available, the filter rule will default to 'All Records'.
4.4. Filter Security
Filters are governed by the following security rules:
User Type | Filter Security |
Non-Administrator | Can select and apply any available filters. |
Administrator | Can select and apply any available filters. |
4.5. Filter Formulas (Advanced)
Filter Formulas is an advanced feature in eTime Xpress that allows more complex filter expressions to be defined.
Filter formulas require a basic knowledge of Progress functions and eTime Xpress table structures. It should only be used when necessary as incorrectly written formulas may have a significant negative impact on system performance.
It is recommended that you contact Celayix support before implementing any filter formulas. (Note: Formula reviews are not part of standard maintenance and may require additional fees)
To create a filter formula:
From the Filter Manager, select the filter you want to define a formula.
Click the About tab.
In the Formula text box, define your custom filter formula. Click the Select Field button for a list of allowable fields that can be defined in the filter formula.
If both a standard field filter and filter formula are defined, the search is processed as a compound statement joined by an 'AND' relationship. To apply an 'OR' expression to the compound statement, begin the filter formula definition with 'OR'.
Click the Check Syntax button to validate the formula defined.
Click the Save button to save the filter formula. When a filter formula is defined for a filter, the description "Custom formula defined" will appear in Filter Details under the General tab.
5. Attachments
The attachment feature allows you to import external files such as Word, Excel, PDF etc. documents directly into the eTime Xpress database.
When importing files into eTime Xpress, an attachment window should appear similar to the following:
Attachment Window
Feature | Action |
Up One Level | Display the contents of the parent folder. |
Export | Export attachment from database to a local or network drive. |
Import | Import attachment into database. |
Open | Export attachment from database into a temporary folder on your local PC and open it by a designated program. |
Delete | Delete attachment from database. |
Search | Search attachments using filtering criteria. |
Feature | Action |
Rename | Rename attachment. |
5.1. Organizing Attachments
By default, attachments are saved into the system folder designated for that eTime Xpress feature. For example, attachments relating to Employee 1, 2, 3, 4… for Employee Incidents are all saved under the Employee Incidents system folder.
Custom subfolders can be created under each system folder to organize attachments in a manner that is logical for your organization (i.e. Employee, Customer or Site Names or IDs).
5.2. Attachments - FAQs
The following are common questions about using attachments in eTime Xpress:
Question | Answer |
How do I update and save an attachment? | Method 1: Export the attachment, update, save and re-import back to database. |
What happens when I make changes to the local temporary file? | When an attachment is opened, it is exported to a local temporary directory. By clicking discard, the temporary copy of the attachment will be deleted. |
Is there a limit to the size of file that can be imported? | Files cannot exceed the remaining quota limit for the database. |
What is the file quota limit? | The total of all attachments imported into the database must not exceed 1GB (250MB for eTime Xpress ASP users). |
What do I do if I've exceeded by quota limit? | Other attachments must be deleted from the database before new attachments can be imported. |
Why can't I delete a folder? | A folder cannot be deleted if it contains files or subfolders. |
The system says the file already exists but I don't see any duplicate files? | By default, the system displays only attachments related to the data object you are viewing (i.e. customer, site or employee) and hides attachments for other data objects. |
6. Data Exchange
eTime Xpress supports the ability to exchange data with 3rd party applications such as accounting, payroll, HR or CRM applications. Using a delimited file, data can be imported or exported to/from eTime Xpress.
When data is imported or exported to/from eTime Xpress, the system will apply the security permissions belonging to the user running the process - records not matching a user's security permissions will not be imported/exported.
6.1. Supported Data Objects
The following data objects and exchange methods are supported:
Data Object | Import (Add) | Import (Update) | Export | Batch |
Employee Information (Employee > File) | √ | √ | √ | √ |
Employee Qualifications(Employee > Employee Qualifications > File) | √ | √ | √ | √ |
Customer Information(Customers > File) | √ | √ | √ | √ |
Site Information(Customers > File) | √ | √ | √ | √ |
Branch Services(Administration > Company/Branch > Branch Codes > Branch Services) | √ | √ | √ | √ |
Branch Locations | √ | √ | √ | √ |
Shifts Details(Visual Scheduler > File) | √ | √ | √ | √ |
Shift Distribution | - | - | √ | √ |
Shift Counters(Visual Scheduler > Tools > Shift Counter > Setup > File) | √ | - | - | - |
Employee Volunteer (Availability) Information | √ | √ | √ | √ |
Employee Time Off | √ | √ | √ | √ |
Branch Codes | √ | √ | √ | √ |
6.2. File Formats
eTime Xpress supports the import/export of variable length delimited file formats. Delimited files can be created by many products including Microsoft® Excel, dBASE®, and FoxPro®, or prepared file using a basic text editor.
The following general guidelines should be followed when creating delimited files:
Each record is one line. A record separator may consist of a line feed (ASCII/LF=0x0A), or a carriage return and line feed pair (ASCII/CRLF=0x0D 0x0A), however line-breaks can be embedded so a record may span more than one line;
Fields are separated by a comma (,), semi-colon (, pipe (|), space or tab (only one delimiter can be specified per file);
Leading and trailing space-characters adjacent to comma (,), semi-colon (, pipe (|) or tab field separators are ignored;
Fields with embedded field separators must be delimited with double-quote characters (i.e. if a comma separator is selected, fields which contain the comma character must be surrounded with double-quote characters);
Fields with embedded double-quote characters must be delimited with double-quote characters, and the embedded double-quote characters must be represented by a pair of double-quote characters;
Fields with embedded line breaks must be delimited by double-quote characters;
Fields with leading or trailing spaces must be delimited by double-quote characters;
Fields may always be delimited by double-quote characters, whether necessary or not;
The first record in the delimited file is not required to have the field names in each of the columns.
Example Delimited Files
For illustration, the examples below show records with comma separated fields (CSV).
Guidelines | Examples |
Fields are separated by commas. | 1997,Ford,E350<CR/LF> |
Fields are separated by commas. | 1997,Ford,E350 |
Fields with leading and trailing spaces or tabs, adjacent to commas, are trimmed. | 1997, Ford , E350 |
Fields with embedded commas must be delimited with double-quote characters. | 1997,Ford,E350,"Super, luxurious truck" |
Fields with embedded double-quote characters must be delimited with double-quote characters, and the embedded double-quote characters must be represented by a pair of double-quote characters. | 1997,Ford,E350,"Super ""luxurious"" truck" |
Fields with embedded line breaks must be delimited by double-quote characters. | 1997,Ford,E350,"Go get one now |
Fields with leading or trailing spaces must be delimited by double-quote characters. | 1997,Ford,E350," Super luxurious truck " |
Fields may always be delimited by double-quote characters, whether necessary or not. | "1997","Ford","E350" |
6.3. Importing Data
eTime Xpress allows external information to be imported from a properly formatted delimited file. Import options can be run under File > Import from the main screen applicable to the data object.
When data is imported, it is subject to the same error checks like any other data that is entered directly into eTime Xpress.
6.3.1. Import Features
The import process requires the selection of data fields that are to be imported and their order. Depending on the data object, you will be presented with some or all of the features listed below.
Field Import Selection | Description |
Company/Branch Selector | Select the company/branch data records to be exported. |
File Name | Specify the file name and location of the import file. |
Delimiter | Specify field separator used in the import file. |
Enable Update | If data record exists, overwrite fields with field information defined in the import file. |
Import | Runs import of data records. |
Available Fields Browser | Displays available fields that can be imported including required (Req'd) and unique fields. |
Import Field Order Browser | Displays ordering of fields to be imported |
Data Import Example
For illustration, the steps below show how to import Employee information. The process is similar for importing other data objects.
To import Employees:
From the menu bar in the Employee main screen, click File > Import. The Employee Import screen should appear as shown in the figure below. The browser called Available Employee Fields contains a list of all of the Employee fields that may be imported, including fields that are required and/or must be unique.
Create the delimited file containing your Employee information using an export tool found in your 3rd party application or spreadsheet. Save the resulting delimited file to a directory that is accessible from eTime Xpress.
In eTime Xpress, click the Open button (
) in the Employee Import screen to bring up a file dialog box. Browse to where you saved the delimited file and select it for import.
In the Available Employee Fields browser, add the fields you are importing in the order they appear in the delimited file. You can modify the field order by using the Remove, Move Up, and Move Down buttons. Make sure that the last field is one that will always have a value. E.g. do not choose email address if some employees will not have an email address. Tip: a good rule of thumb is to put one one the mandatory fields as the last field in the file.
Specify the delimiter used to separate fields.
Check off the 'Enable Update' option if existing fields should be overwritten with the field information found in the import file.
Click the Import button to start the Import process.
Imported records are subject to the same error checks like any other data that is entered directly into eTime Xpress. Any import errors will be displayed in a report. Review the report and make the necessary modifications to the import record(s). Retry importing the corrected record(s), as required.
Employee Import Screen
Note: The most common cause of Import failure is a mismatch between the delimited file layout and the Import Field Order definition. Please ensure that all Req'd fields are defined in the delimited file and there are no duplicates of Unique fields.
6.3.2. Saving Import Definitions
Import definitions (delimiter type, enable update and import field order) can be saved to a XML formatted file. The import definitions XML file can be loaded when running future imports saving the work of manually recreating the import settings every time you import records. The import definitions XML file can also used in the batch import process.
To create an Import Definition XML File:
From import screen, click File > Create Import Definition XML File. A file dialog box should appear.
Browse to where you want to save the XML file and specify a file name and .XML file extension.
Click Save.
To load an Import Definition XML File:
From import screen, click File > Load Import Definition XML File. A file dialog box should appear.
Browse to where you saved the XML file and select it.
Click Open.
6.3.3. Batch Import Processing
The Batch Import Process automatically runs the import process.
Note: The Batch Import Process feature in eTime Xpress is licensed separately and requires additional network and script configuration. If you wish to purchase the Batch Processing Engine, please contact your Celayix Software Sales Representative.
6.4. Exporting Data
eTime Xpress allows information to be exported to a delimited file for use in other 3rd party applications. Export options can be run under File > Export from the main screen applicable to the data object.
6.4.1. Export Features
Generally, the export process requires the selection of data records followed by data fields that are to be exported. Depending on the data object, you will be presented with some or all of the features listed below.
Record Export Selection | Description |
Company/Branch Selector | Select the company/branch data records to be exported. |
Started From/To | Filter based on Start date, if applicable. |
Filter | Define custom record filters. By default, all data records will be displayed. |
Refresh | Search for data records based on specified filters. |
Mark Record as Exported | Track exported records. |
Include Exported Data | Check Off to include previously exported records. |
Export Data | Save data record selection and proceed to data field selection. |
Available Data Browser | Displays results of data search. |
Export Data Browser | Displays data records selected for export. |
Field Export Selection | Description |
Export File Name | Specify the file path, export file name and file type extension. |
Delimiter | Specify field separator. |
Available Fields Browser | Displays available fields that can be exported. |
Export Field Order Browser | Displays ordering of fields to be exported. |
Export | Runs export of data records and fields. |
Data Export Example
For illustration, the steps below show how to export Employee information. The process is similar for exporting other data objects.
To export Employees:
From the menu bar in the Employee Main screen, click File > Export. Select the Standard Export Format and click OK. The Employee Export screen should appear as shown in the figure below.
Employee Export Screen
Specify Started From/To dates, if applicable. If no dates are specified, All dates will be found.
Check-off "Mark Records as Exported", if required.
Check-off "Include Exported Employees", if required.
Select a custom filter, if required. By default, no filter will be applied. To define a custom filter, click the filter icon (
).
Click the refresh button to search for Employees. A list of Employee matching your filter criteria will be displayed in the Available Employee browser.
From the Available Employees browser, select the Employees you want to export using the Add, Add All, Remove and Remove All buttons.
In the Available Fields browser, add the fields you are importing in the order they should appear in the delimited file. You can modify the field order by using the Remove, Remove All, Move Up, and Move Down buttons.
You can use the Add Text and Skip options to customize your export file to conform to specific format requirements of other 3rd party applications. Add Text will insert a user-defined text column and Skip will insert a blank field in the specified location for each record.
Specify the Export File Name or click the Open button (
) to bring up a file dialog box. Browse to where you want to save the delimited file. Specify a file name and extension.
Specify the delimiter to be used to separate fields.
Click the Export button to export the selected data records and fields to the delimited file.
6.4.2. Saving Export Definitions
Export definitions (field filter, Mark Records as Exported, Include Exported Employees, Export Field Order, Export File Name, Delimiter) can be saved to a XML formatted file. The export definitions XML file can be loaded when running future exports saving the work of manually recreating the export settings every time you export records. The export definitions XML file can also used in the batch export process.
To create an Export Definition XML File:
From import screen, click File > Create Export Definition XML File. A file dialog box should appear.
Browse to where you want to save the XML file and specify a file name and .XML file extension.
Click Save.
To load an Export Definition XML File:
From import screen, click File > Load Export Definition XML File. A file dialog box should appear.
Browse to where you saved the XML file and select it.
Click Open.
6.4.3. Batch Export Processing
The Batch Export Process automatically runs the export process.
Note: The Batch Export Process feature in eTime Xpress is licensed separately and requires additional network and script configuration. If you wish to purchase the Batch Processing Engine, please contact your Celayix Software Sales Representative.