Installing the EasyLobby / WinDSX Integration - DSX Access ...

Installing the EasyLobby / WinDSX IntegrationEasyLobby, Inc.Company Map Field – If set to “Default”, the trigger will the name from the “CompanyDefault” field (below) as the company to assign to the card in WinDSX. Set this to“Company” to use the company of the employee being visited as the company. Set this to“Category” to use the EasyLobby visitor category (from the category drop down on thevisitor form) as the company, or “Clearance” to use the clearance value from theclearance drop down. Set it to “User Defined 1” to use the value of the user defined 1field as the company.Company Default – If the “Company Map Field” is set to “Default”, the trigger willalways use this value as the company assign to the card in WinDSX. The initial value isblank.Location Group – This field must be set to the number of the location group to use in theWinDSX system. The default value is ‘1’. This value must be an integer.Output Linking Level – This field is optional and can be set to the output linking levelassigned when a visitor card is created. The default blank value specifies that no outputlinking level is assigned in WinDSX. If non-blank, this value must be an integer.DSX UDF Index – This field must contain the User Defined Field # of the field wherethe EasyLobby visitor id is to be stored in WinDSX. The default value is 7. This valuemust be an integer.DSX Record Type – Set this to specify whether the cardholder record will be set to be avisitor or a standard employee record.Output Directory – This field must contain the path to the database folder of theWinDSX installation where the import files are written (this is typically the mainprogram installation folder, C:\WinDSX). If you want to run the EasyLobby database ona different server than the WinDSX import service, then you must share the“C:\WinDSX” folder from the WinDSX system and, on the EasyLobby database server,save the .txt files to that share instead.Send Photo – Check this box to send the visitor photo, if there is one, to WinDSX.Photo Directory – If Send Photo is checked, this field contains the path to the directorywhere the photo files will be written. You may click the Browse button to browse to andselect a directory.Utility ButtonsThe selections in this section describe the behavior of the buttons at the bottom of theconfiguration utility.Help – Displays the help document in WordPad.10/1/2009 Page 4

Installing the EasyLobby / WinDSX IntegrationEasyLobby, Inc.Factory Settings – Will reset all the settings on the current form to the factory settings.Note that these settings will not be saved to the trigger file unless you click the “SaveSettings” button.Save Settings – Will save all the current trigger parameter settings and windowscredentials to the current script file (as indicated by the “Integration Trigger Script” fieldat the top of the form).Remove Trigger – Removes the trigger from the EasyLobby database. Note that thisfunction uses the script file called “RemoveTrigger.sql” from the config utilityinstallation folder.Install Trigger – Will save the current settings and install the trigger to the EasyLobbydatabase as selected in the “Target Database” section.Exit – Quit the applicationVI) Format of the Integration Trigger SQL Script FileNote: Normally you will use the EasyLobby WinDSX Configuration utility to install theintegration trigger, as described in the section above. This section documents the formatof the trigger script file should you need to edit it directly and install it manually.To manually install the integration solution, you edit and run the script file called“TriggerWinDSX.sql”, which adds a trigger to your EasyLobby 9.0 database. This triggerruns after the Check In, Check Out and Delete actions in EasyLobby SVM, and isresponsible for moving the visitor information to the WinDSX system.Before running the TriggerWinDSX.sql script you will need to set some specific optionscontrolling the behavior of the integration. You don’t have to worry about getting theconfiguration exactly right the first time, as you can always edit the script and load itagain.You may edit the TriggerWinDSX.sql script with Notepad or similar text editor. Afteryou open the script in Notepad, locate the line that reads “[Start Variables Section]” alittle way down in the file. You may edit any of the variables between the [Start VariablesSection] comment and the [End Variables Section] comment. The following describes thevariables and their behavior:@USE_PROXCARD – Set this to 0 if you wish to use barcodes printed on theEasyLobby badges, or 1 (the default) if you will use prox cards to give to some or all ofyour visitors. Note that when using prox cards, visitor records are only transferred toWinDSX when the prox card field of the visitor form is populated with a numeric value.@ACCESS_LEVEL_MAP_FIELD – The default is a blank string (‘’), in which casethe trigger will use the access level in the @ACCESS_LEVEL_DEFAULT variable asthe access level to assign to the cardholder in WinDSX. Set this to 'CATEGORY' to use10/1/2009 Page 5

Installing the EasyLobby / WinDSX IntegrationEasyLobby, Inc.the EasyLobby visitor category (from the category drop down on the visitor form) as theaccess level in WinDSX, or 'CLEARANCE' to use the clearance value from the clearancedrop down. Set this to 'COMPANY' to use the company of the employee being visited asthe access level. Set it to 'USERDEF1' to use the value of the user defined 1 field as theaccess level.@ACCESS_LEVEL_DEFAULT – Used when @ACCESS_LEVEL_MAP_FIELDvariable is blank (‘’). In this case, the trigger will always use this value as the access levelto assign to the visitor (cardholder) in WinDSX.@COMPANY_MAP_FIELD – The default is ‘COMPANY’, which uses the companyof the employee being visited. When a blank string (‘’) the trigger will use the companyin the @COMPANY_DEFAULT. Set this to 'CATEGORY' to use the EasyLobby visitorcategory (from the category drop down on the visitor form) as the company in WinDSX,or 'CLEARANCE' to use the clearance value from the clearance drop down. Set it to'USERDEF1' to use the value of the user defined 1 field as the company.@COMPANY_DEFAULT – Used when @COMPANY_MAP_FIELD variable is blank(‘’). In this case, the trigger will always use this value as the company to assign to thevisitor (cardholder) in WinDSX.@DSX_LOCATION_GROUP – This variable must be set to the number of the locationgroup to use in the WinDSX system. The default value is '1’.@DSX_OLL – This variable is optional and can be set to the output linking levelassigned when a visitor card is created. The default value of ‘’ (empty string) specifiesthat no output linking level is assigned.@DSX_UDF – This variable must contain the UDF # of the field where the EasyLobbyvisitor id is stored.@DSX_VISITOR – Set this variable to ‘1’ to specify that the cardholder record added tothe DSX database is a visitor, otherwise set it to ‘0’.@DSX_OUTPUT_DIR – This variable must contain the path to the database folder ofthe WinDSX installation (this is typically the main program installation folder,C:\WinDSX). If the EasyLobby database is running on the same system as WinDSX,then the default value of 'C:\WinDSX' would be correct (note that this path must be in 8.3name format).For each check in (or check out) in EasyLobby that will result in a cardholder recordbeing created (or deleted), a .txt file will be created in this folder. This file contains theinformation that tells the WinDSX import service the information about the cardholderand card. Once WinDSX has processed to information in the import file it will delete it.10/1/2009 Page 6

Installing the EasyLobby / WinDSX IntegrationEasyLobby, Inc.If you want to run the EasyLobby database on a different server than the WinDSX importservice, then you must share the “C:\WinDSX” folder from the WinDSX system and, onthe EasyLobby database server, save the .txt files to that share instead. In this case youmust determine the proper 8.3 format path to the share, and set this variable accordingly.@USE_PHOTO – The default value is 0, set this variable to 1 to enable transfer of thevisitor photograph to WinDSX.If you set @USE_PHOTO to 1, there is some further setup required. Transfer of photosrequires the SQL Server utility file textcopy.exe, which must be located in the SQLServer Binn folder (typically C:\Program Files\Microsoft SQL Server\80\Tools\Binn).This is typically present in full SQL Server installs but not in MSDE installs. If this file isnot present on your system, we have provided it with the solution files in the folder calledIntegration Files. Copy this file to the Binn folder of your SQL Server or MSDEinstallation. The utility textcopy.exe also requires the DLL file called ntwdblib.dll. SQLServer typically installs this file into the Windows System32 folder. If this file is notpresent on your system, copy it either to the System32 folder or to the Binn folder.@PHOTO_TEMP_DIR – Set to a directory on the server to hold the temporary imagefiles. The images are placed here before the import into WinDSX and then removed whenthe visitor is checked-out or deleted (although the images are only needed until afterWinDSX has processed the cardholder add operation). The path in this variable must bein 8.3 filename format.Providing a proxy accountYou must supply the credentials of an account with enough privileges on the WinDSXsystem to be able to write out the .txt import files or photos. You set these accountcredentials toward the bottom of the trigger script. You will see the following lines ofcode:EXECUTE xp_sqlagent_proxy_account N'SET', N'', N'', N''GOYou must replace , and withthe appropriate values for your account. The domain name can be the name of the localsystem or the name of your domain. The account and password are the same as those youwould use to log in to the system.VII) Manual Loading of the Integration Database TriggerNote: Normally you will use the EasyLobby WinDSX Configuration utility to install theintegration trigger, as described in the section V above. This section describes how toinstall the trigger manually.10/1/2009 Page 7

Installing the EasyLobby / WinDSX IntegrationEasyLobby, Inc.After modifying the script, you run the script to load the trigger and associated storedprocedures into the EasyLobby9 database. Note that if you need to change one of theparameters, you may edit the script and run it again without any problem.If you are using Microsoft SQL Server for the EasyLobby database, run the MS QueryAnalyzer tool, sign in as “sa”, load the “TriggerWinDSX.sql” script and execute it byclicking the right-pointing green triangle icon on the toolbar or by choosing the Query |Execute menu command.If you are using the EasyLobby MSDE you can use the MSDE OSQL utility, typicallyfound in the C:\Program Files\Microsoft SQL Server\80\Tools\Binn folder. You must runOSQL from the DOS command prompt. Note that with OSQL, you will need to use the“sa” account and password (default is “doorman”) assigned when you installed theEasyLobby MSDE. The command line is:> OSQL –U sa –P doorman –S [server]\EASYLOBBY –i [path]TriggerWinDSX.sqlNote that the arguments to this command are case sensitive. You must replace the valuesfor password and server. You must also supply the [path] to the trigger file unless it is inthe Binn directory, in which case you can omit the path.VIII) Operation of the SolutionWhen a visitor is checked in using EasyLobby SVM, the trigger in the EasyLobby9database is executed which generates the import .txt file. WinDSX checks for new importfiles every 15 seconds and when if finds the new file it creates a new cardholder and cardin WinDSX. The card number will be either the custom id or the prox card number fromthe EasyLobby visitor record, depending on the configuration of the solution.Note that when using prox cards, the cardholder record is only created when the proxcard field is populated in the EasyLobby visitor form. EasyLobby has support for twoUSB attachable prox card scanners: The RF Ideas pcProx device and the Hirsch HIDdevice. These can be used to scan the card number directly into EasyLobby, and also thecard can be scanned for check out.When using barcodes, EasyLobby offers two options for how the barcode number isgenerated. You can set these options in the Edit | Program Options, Defaults tab.The default setting, “Auto Increment Custom Id”, will create an id number that increasesby one with each visitor. This number is generated by taking the visitor record id andadding the site id number plus 100. Thus, if the site id is 101, and the record id is 1, thenthe custom id number will be 101101. This number will increase by one for each newvisitor.If you would like to confine your custom id numbers to an assigned range, change thissetting to “Generate custom id in range” and set the numeric values for the range of ids10/1/2009 Page 8

Installing the EasyLobby / WinDSX IntegrationEasyLobby, Inc.that you would like to assign to visitors. EasyLobby will map the visitor record id intothis range of numbers, wrapping when it reaches the top.When a visitor is checked out in EasyLobby SVM, the trigger is also executed, whichgenerates a .txt file that, when imported, deletes the visitor and badge from the WinDSXdatabase.If a visitor record is deleted in EasyLobby SVM before the visitor has been checked out,this action also causes the trigger to remove the cardholder and card from WinDSX.IX) Technical SupportFor more information or support on this solution, please contact EasyLobby, Inc. atsupport@easylobby.com or at 781-455-8558.10/1/2009 Page 9