part 1 introduction to xportal2005 client 2

xPortal2005 Client v1.2 Quick User Guide

Table Of Content

Part 1 Introduction to xPortal2005 Client 2

1.1 Starting and Logging In to xPortal2005 Client..................................... 2

Part 2 Staff Record 4

2.1 Adding Staff Record.......................................................................... 4

2.2 Staff Door Accessibility Control...........................................................7

2.3 Set Auto Lock Release Time Zone......................................................12

2.4 Finger Print Template Management...................................................16

Part 3 Reporting 20

3.1 Transaction Reporting .....................................................................20

3.2 Attendance Schedule........................................................................21

3.3 Daily Attendance..............................................................................22

3.4 Monthly Attendance..........................................................................24

Copyright © 2007 MicroEngine1


MicroEngine® xPortal2005 Software Quick User Guide

xPortal2005 Client Quick User Guide(Only for xPortal2005 v1.2 and above)

1 Introduction to xPortal2005 Client

MicroEngine xPortal2005 is an Integrated Security Access Management System. It was designed to provide a powerful, high security and reliable access control system. xPortal2005 was written based on Microsoft .Net platform that provides feature rich and stable access control system. With this platform, it also allows future expandability of the system. xPortal2005 is divided into a Server and Client application. The xPortal2005 Client is the main application at control and manage the device (e.g. controller, door) and user (Software User and Card Holder) settings. The functions of xPortal2005 Client are listed as follow:

● Communicate the with controllers in the system.● Download and upload data between controllers and software.● Database management.● Activity monitoring.● Alarm Monitoring.● Transaction reporting.● Integrating Floor Plan display system.● Configuring Security Mode (Card Only, Card + PIN, PIN Only, Door Function Inhibit Control).● Controller Settings such as Time Sets, Time Zone, Holiday Dates, Door Access Schedules,

Floor Zones, Floor Access Settings.● Software User Level Control.● Who's Still IN Reporting.

In conclusion, the xPortal2005 Client is a tool to control and manage the settings of the devices and user of your access control system. By the way, the device setup must be done within the xPortal2005 Server application. 1.1 Starting and Logging In to xPortal2005 Client

1. Double click xPortal2005 Client icon from Windows Desktop.

2. Click xPortal2005 Server shortcut from Start | Programs | MicroEngine | xPortal2005 | xPortal2005 Client. The software will show the login screen as below:



3. If you are starting xPortal2005 Client for the first time, you need to setup the server connection setting by specifying the Server IP Address. Click the "Connection Setup" from the Login menu. The Server Connection menu as below will be shown.

4. Select “Same Computer” if the xPortal2005 Client is installed on same computer as

xPortal2005 Server application. If xPortal2005 Server resides on another PC, you can enter the server IP address under “Identified by IP Address”. Alternatively you can choose “Identified by Computer Name” and click the “Browse Computer Name” button to select the server by computer name. You do not need to change the Port Number.

5. Click OK to save settings.6. You can log in to xPortal2005 Client using one of the default UserIDs below:

UserID 1 : xPortal2005Password 1 : xPortal2005

User ID 2 : ManagerPassword 2 : Manager1

You also can log in using own User ID if one has been created.



2 Staff Record

2.1 Adding Staff Records



1. Click Data Setup | Access Data Setting | Staff Records to open the Staff Detail Setup menu.2. Click “Add” button. Menu below will be shown:

3. Enter the information of the Staff as described below:

Fields Length Description

Token Type (selection) A token may vary from proximity card to ID number that representing the staff's identity in access control operations. Token types are listed as below:

· Proximity Card· ID number (6 digit pin input)· Mifare Card· MyKad

Noted: For Token type is depend on which model of Finger Print Reader use.

Verification Mode (selection) This staff will access on any doors is checked against:

· By Door - follow the door's current operating mode

· Token only - present the token only

· Token + PIN - present token, then followed by 4 digit PIN

· Token + Finger Print - present token, then verified by finger print as well

· Token + PIN + Finger Print - present token, enter 4 digit PIN, then place finger print for verification

· Finger Print Only - place finger only

· Finger Print + PIN - place finger, then enter PIN



Allow 1:N Finger Print Identification

Enable this staff to access a door by using finger print only. (Note: This option only applicable for finger print controller)

Card No/ID No 6 int The last 6-digit Card Number of staff's proximity card. ID No - 6 digit number that need to be entered

Staff No 12 char Unique Staff ID.

Staff Name 50 char Staff's Name.

Branch (selection) Branch of the staff attached to.

Division (selection) Division of the staff.

Department (selection) Department of the staff located to.

Job Title (selection) Designation of the staff.

Att. Door Group (selection) A preset Door Group that will be take account when calculating staff's attendance.

Door Access Code (selection) Assign a preset Door Access Level to determine at which day and what time the staff can access particular door

Floor Access Code (selection) Attach a preset Floor Access to the staff in order to control his accessibility to certain floors only.

Shift Code (selection) A preset Work Schedule of the staff.

Super Card Y / N Define whether is this a Super Card. A Super Card Staff can toggle the Inhibit mode of the door.

Activate Y / N Whether enable/disable the card.

Vehicle No 10 char Vehicle's plat number of the staff.

Parking Lot 10 char The number of staff's parking lot.

Customer ID 15 char Customer ID.

Date of Creation (date) Creation date of the staff record.

Start Date (date) Activate date of the card.

End Date (date) Expire date of the card.

Remarks 1-3 50 char Comment / notice about the staff.

Assigned By (auto assigned) System User code who create this staff record (not editable).

Assigned Date (auto assigned) Create date of this staff record (not editable).

Unassigned By (auto assigned) System User code who delete this staff record (not editable).

Unassigned Date (auto assigned) Staff record deletion date.

Get Image 160px X 130px Load a staff's picture (support .bmp and .jpg format only).

Clear Image N/A Remove the staff's picture from the system.

4. After you have entered all the necessary fields, click OK to confirm and save settings.5. A "Record Added!" message will be shown. Click OK to continue.6. The software will automatically send User setting (install card) to all controllers.7. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Staff Detail Setup menu.

2.2 Staff Door Accessibility Control

Staff accessibility to the doors in the system depending on the Door Access Level assigned to them. It can be controlled according to the following criteria:

● Which door?● What day?● What time?



Example:

● There are 4 doors in the company that have access control. (eg. Door 1, Door 2, Door 3 and Door 4)

● Normal staffs can only access Door 1 and Door 4.● They are only allowed to have access on normal working days and hours. (eg. Working days:

Mon – Fri, Working hours: 8:30am to 5:30pm)

To create a new access level according to this criteria you only need to answer the three questions above.

Which Door?

Ans: Door 1 and Door 4 only.

Door Access No. : 002Door Access Code : Norm StaffDoor Access Description: Access level for normal staffs

Door Can access?

Sun Mon Tue Wed Thu Fri Sat Hol

Door 1 YesDoor 2Door 3Door 4 YesWhat Day?

Ans: Monday to Friday


Door Can access?


Door 1 Yes Yes Yes Yes Yes YesDoor 2Door 3Door 4 Yes Yes Yes Yes Yes Yes

What Time?

Ans: 08:30-17:30 (8:00am to 5:00pm)


Door Can access?


Door 1 Yes 08:30-17:30 08:30-17:30 08:30-17:30 08:30-17:30 08:30-17:30

Door 2Door 3



Door Can access?


Door 4 Yes 08:30-17:30 08:30-17:30 08:30-17:30 08:30-17:30 08:30-17:30

With the information above, you can start creating a new Time Set, Time Zone and Door Accessibility Schedule by following the steps below:

Creating New Time Set

1. Open the Time Set Setup menu from Data Setup | Access Data Setting | Time Set. The menu as below will be shown.

2. Click Add button to create a new Time Set. An Add Time Set menu will be shown.

3. Enter the information of the Time Set as described below:

Fields Description

Unit No An unique Time Set address number. (range from 002-255)

Code A short name that describes the Time Set.

Description Longer description for the Time Set.

Interval #1-3 1 interval supports time interval within one day (24 hours). All Start Time and End Time is in 24 hours format.



4. After you have entered all the necessary fields, click OK to confirm and save settings.5. A "Record Added!" message will be shown. Click OK to continue.6. The software will automatically send the Time Set setting to all controllers.7. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Time Set Setup menu.

Creating New Time Zone

1. Open the Time Zone Setting menu from Data Setup | Access Data Setting | Time Zone. The menu as below will be shown.

2. Click Add button to create a new Time Zone. An Add Time Zone menu will be shown.

3. Enter the information of the Time Zone as described below:

Fields Description

Time Zone An unique Time Zone address number. (range from 002-255)

Code A short name that describes the Time Zone.

Description Longer description for the Time Zone.

Time Set Represent a preset Time Set Unit No. Its interval setting will change in corresponding to the Time Set selection.



4. After you have entered all the necessary fields, click OK to confirm and save settings.5. A "Record Added!" message will be shown. Click OK to continue.6. The software will automatically send the Time Zone setting to all controllers.7. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Time Zone Setting menu.

Creating New Door Accessibility Schedule

1. Open the Door Accessibility Setup menu from Data Setup | Access Data Setting | Door Accessibility Schedule. The menu as below will be shown. The upper list shows all the Door Access Level, and its respective door accessibility configurations are displayed at the bottom.

2. Click Add button to create a new Floor Access. An Add Floor Accessibility menu will be shown.



3. Enter the information of the Door Access as described below:

Fields Description

Door Access No An unique Door Access number. (range from 002-255)

Code A short name that describes the Door Access Level.

Description Longer description for the Door Access Level.

Enable If you enable it, the system will check its accessibility time and day for card that had been assigned with this Door Access Level.

Start/End Date Activation date range of this Door Access Level.

4. Put a check at the door that the staff can access.5. You can also assign a Time Zone for the door by clicking at the value as shown below:

6. After you have configure all the door accessibility and Time Zone, click OK to save settings.7. A "Record Updated !" message will be shown. Click OK to continue.8. The software will automatically send the updated Door Access setting to all controllers.9. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Door Accessibility Setup menu.

Assigning Door Accessibility to Staff

1. Click Data Setup | Access Data Setting | Staff Records to open the Staff Detail Setup menu.2. Highlight the staff record that you are going to assign a new Door Access Level and click the

“Modify” button.3. Click the Door Access Code button and change the Door Access Code to a suitable one as

below:

4. Click OK to confirm changes.5. A "Record Updated !" message will be shown. Click OK to continue.6. The software will automatically send the updated Door Access Level for the staff to all

controllers.7. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Staff Details Setup menu.



2.3 Set Auto Lock Release Time Zone

To set the door to run the function Auto Lock Release Time Zone. It can controlled according to the following criteria:

● Which door?● What day?● What time?

Example:

● Set Door 1 Monday to Friday 8am to 5pm and Saturday 8am to 1pm. Sunday and Holiday full day lock.

Step1: Creating New Time Set

4. Open the Time Set Setup menu from Data Setup | Access Data Setting | Time Set. The menu as below will be shown.

5. Click Add button to create a new Time Set. An Add Time Set menu will be shown.

6. Enter the information of the Time Set as described below:

Fields Description



Unit No An unique Time Set address number. (range from 002-255)

Code A short name that describes the Time Set.

Description Longer description for the Time Set.

Interval #1-3 1 interval supports time interval within one day (24 hours). All Start Time and End Time is in 24 hours format.

4. After you have entered all the necessary fields, click OK to confirm and save settings.5. A "Record Added!" message will be shown. Click OK to continue.6. The software will automatically send the Time Set setting to all controllers.7. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Time Set Setup menu.

Step 2: Creating New Time Zone

1. Open the Time Zone Setting menu from Data Setup | Access Data Setting | Time Zone. The menu as below will be shown.

2. Click Add button to create a new Time Zone. An Add Time Zone menu will be shown.

3. Enter the information of the Time Zone as described below:



Fields Description

Time Zone An unique Time Zone address number. (range from 002-255)

Code A short name that describes the Time Zone.

Description Longer description for the Time Zone.

Time Set Represent a preset Time Set Unit No. Its interval setting will change in corresponding to the Time Set selection.

4. After you have entered all the necessary fields, click OK to confirm and save settings.5. A "Record Added!" message will be shown. Click OK to continue.6. The software will automatically send the Time Zone setting to all controllers.7. After downloading all the settings, it will display a report of data being sent. Click Close to

return to Time Zone Setting menu.

Step 3 : Apply Time Zone to Auto Lock Release Time Zone function.

1. Open the Door Setup menu from Data Setup | System Setting | Door. The menu as below will be shown.

2. Select the Door you need to change edit then click 'Modify'. The menu as below will be shown.



3. Click on the Auto Lock Release TZ button, the Time Zone Setting interface will show. The menu of Time Zone Setting show as below:

4. Select the time which need to apply to the door then Click OK. 5. After that it will back to the Edit Door interface. Click OK. It will update to the controller.



2.4 Finger Print Template ManagementIf the software user want to enroll a user's template to other controller units, the user must enroll his/her finger at any GT-1200 controller. Then the software user has to retrieve the template's data from the controller and save its details using the xPortal2005Client software.

To retrieve users' template from a controller, please perform the steps as below:

1. Open the Send Card Setting menu from Device Comm l Send User Setting. The menu as below will be shown.

2. Check the Door Controller which the software user wants to retrieve the users' template from. (Note: Only one controller is permitted)

3. Uncheck All Card and set Card Holder Selection if only template for the selected users need to be retrieved.

4. Select Sort Order to sort the staff records by the selected field.5. Click Get Template button. 6. The software will automatically send the Get Template Command to the selected door

controller.



7. After retrieving all the settings, it will display a delivery report of data being sent.

8. Click Close to dismiss the report window. A summary of communication retrieval result will be displayed.



9. Click Close to dismiss the report. A Get Template Retrieval Result will displayed.

Above is an example Get Template Retrieval Result window. Following are the descriptions of the user interface:

1. Staff's Template Data Status – Display a conclusion of the status for user's template data. The stsatus message is descried as below:

■ Same – All of the user's template data that is stored in the controller is exactly the same as the data in the software database

■ Different data, PENDING confirmation – The template data in the controller is different with the data that is stored in the software. The software user is required to check the template details at the bottom of the grid in order to confirm whether the templates need to be updated.

2. Overwrite All User Template Data – Check this box if the software user wish to update all the template data of the selected user with the retrieval result from the controller.

3. Overwrite All Template Data – This option enable the software user to update template data of all user with retrieval result from the controller.

4. Retrieval Result - Display summary of template details that are retrieved from controller.

5. Details of Each Template from Retrieval Result - Summarize the details (template index, finger name and template data's status) of each template in the controller. If the status is different, that means the template data that stored in the controller is different from the data that saved in the database. The software user can check the "Overwrite" checkbox to update the selected template with the retrieval result.

6. Overwrite the Selected Template - Check this box to update the selected template with the data retrieved from controller



7. Current Retrieval Info - Display information about the retrieval task: i. )From Controller - which controller you have performed the retrieving process from. ii.) Retrieved By - the software user who is currently logged on.

8. Existing Database Result - Display template details that is stored in the software database.

9. New Result - Display the final result of the template details that will be saved into software database. The default new result is as the existing database result. The new result being displayed will be reflected if you check or uncheck any "Overwrite" checkbox.

Following is the example if a template data is chosen to be updated:



3 Reporting

3.1 Transaction Reporting In this Transaction Reporting function, you can specify the search condition and then create a report.The report will be generated and displayed using xPortal2005 Report Viewer. The report viewer allows you to print the report you have created.

Transaction Review and Report Printing

1. Click Reports | Event Report | Transaction Reporting. The window as below will be shown.

2. Select From Date Time and To Date Time to specify the date and time range that you wish to view the records.

3. Uncheck the condition checkbox and select the data that you want to restrict on.4. Click Get button to list all transaction records that meet the searching criteria you have

chosen. The xPortal2005 Report Viewer will be opened as a new window.5. Click "Print..." button to activate the printing feature. A Print menu will be shown. Click OK to

print the report.6. Click Close button to dismiss the xPortal2005 Report Viewer window to return to View

Transactions menu.



3.2 Attendance Schedules

To generate a staff attendance report, we must setup the attendance schedule first. The setting in the attendance schedule will reflect the flags (Early In, Late In, Early Out Lunch, Late Out Lunch, Early In Lunch, Late In Lunch, Early Out, Late Out, OT, Absent, Non-Working, On Leave, InComplete, InComplete Lunch) in the Daily Attendance Report and Monthly Attendance Report as well.

Set your attendance schedule.• Click Report | Staff Attendance Report | Attendance Schedule. The window as below will be

shown.

Field Description

Code A short name that describes the Shift.

Description Longer description for the Shift

Start Working Time The start of working time.

End Working Time The end of working time.

Lunch Start Lunch starting time

Lunch End Lunch end time



Field Description

Lunch Start Capture Begin The start time to capture lunch out record.

Lunch Start Capture End The end time to capture lunch out record. The staff who not flashed the card within the Capture period it will get incomplete lunch record for the day.

Lunch End Capture Begin The start time to capture lunch in record.

Lunch End Capture End The end time to capture Lunch In record. The staff who not flashed the card within the period won't have incomplete lunch attendance record for the day.

OT Claims? If activate the OT Claim, then the OT hours will be calculated and displayed in the attendance report.

Min Work Time The minimum working hours that must be satisfied by the staff.

Is Flexi Set the flag whether the working time is flexible as long as the staff satisfied the normal working hours.

Trans Coverage Start Time The time which set for the starting time to cover the transaction for attendance

Working Hour Formula Formula for calculate the attendance

Lunch Break Formula Formula for calculated the lunch time

OT formula Formula for calculated the OT

In Grace Time This is the time allowance that the staff can come late and before their late in period being deducted from their work hour.

Out Grace Time Define the minimum excess time that a staff must stay in office before the time will be considered as OT.

Deduct Late Out Grace Time Specify whether to deduct the out grace time or not.

OT Round Down The minimum round down unit for OT in terms of minutes.

Click add for create a new attendance schedule, after enter all the necessary field click OK and it will generate a new attendance schedule. After create a attendance schedule, it need to apply to staff so just assign the shift code correctly to the staff at the Staff Records.

3.3 Daily Attendance

Note: Before go to Daily Attendance menu, make sure go to Data Setup | System Setting | Door, then you will get the Door Setup menu. Please set the door you wish to as an attendance door under the column Is Attendance Capturing Door.

1. Open the Daily Attendance menu from Report | Staff Attendance Report | Daily Attendance then the window will shown as below:



2. Before can view the attendance report, the report must rebuild first. It no need to rebuild for second time if need to view the same report. Click the “Rebuild Daily” it will pop-up a window show at below.

3. Select the correct date click OK then it will start rebuild. At the Latest Event List will show Daily Attendance Rebuild Started. Until it finish it will pop-up show Daily Attendance Rebuild Finish.

4. After finish rebuild, back to the Daily Attendance click the "Open" button to view the attendance records. Following is the example screenshot:



5. For the full report, click on th Get/Preview then it will pop-up a window for you to choose the correct date to view report.

6. In the report viewer, the report can export to PDF, HTML and EXCEL format.

3.4 Monthly Attendance

1. Open the Monthly Attendance menu from Report | Staff Attendance Report | Monthly Attendance then the window will shown as below:



2. Before can view the monthly attendance report, the report must rebuild first. Monthly attendance report is base on the daily attendance report and summaries it. It no need to rebuild for second time if need to view the same report. Click the “Rebuild Monthly” it will pop-up a window show at below.

3. Select the correct month then click OK, it will start rebuild. At the Latest Event List will show Monthly Attendance Rebuild Started. Until it finish it will pop-up show Monthly Attendance Rebuild Finish.

4. After finish rebuild, back to the Monthly Attendance Report click the "Open" button to view the attendance records. Following is the example screenshot

5. For the full report, click on th Get/Preview then it will pop-up a window for you to choose the correct date to view report.

6. In the report viewer, the report can export to PDF, HTML and EXCEL format.


part 1 introduction to xportal2005 client 2

Documents