------------------------------------------------------------------------------------ versaCAT v2.0.0 Date: 27 August 2008 Copyright 2002-2008 VersaDev Pty. Ltd. All Rights Reserved. ------------------------------------------------------------------------------------ *************************************************************** Contents *************************************************************** 1.0 System Requirements 2.0 Additional Resources 3.0 Installation Instructions 4.0 Accessing versaCAT 5.0 Password Reminder Email Template 6.0 To Enable Full - Text Knowledge Base Search 7.0 Support 1.0 System Requirements ======================= - versaSRS 4.0.0 - Windows Server 2008 / 2003 / 2000, Windows Vista, Windows XP - The Microsoft .NET Framework 2.0 - IIS 5 / 6 / 7 - ASP.Net - SQL Server 2005 / 2000, SQL 2005 Express - Microsoft Internet Explorer 6 and above 2.0 Additional Resources ======================== The Microsoft .NET Framework is available for download at: http://www.asp.net/downloads/essential/ Microsoft SQL Server 2005 Home http://www.microsoft.com/sql/default.mspx 3.0 Installation Instructions ============================= Run the msi based installer supplied and follow the prompts. versaCAT has been designed to provide you with a flexible solution to allow your clients to authenticate to the system. The web.config of versaCAT, described below, allows you to configure how your clients will be authenticated to the application as well as control the behavior of the system. Note: The default installation of versaCAT is configured for Forms based authentication, user is required to provide a username and password to logon. Web.Config App Settings Keys ---------------------------- AppTitle: Defines the application title displayed at the top of the browser window. -------- Example: value="versaCAT" ClientValidationMode: -------------------- value="0" - Windows based authentication (requires username only) value="1" - Forms based authentication (requires username and password to logon) Note: The authentication mode of the web.config must correspond to the appropriate ClientValidationMode Example: if the ClientValidationMode is set to 0, the authentication mode, defined within the web.config file, must be set to Windows as follows: ClientValidationQuery: Defines the SQL Query used to return Password and Email for a client defined by Username. --------------------- Example 1 - Forms Based Authentication Against The versaSRS / versaCRM Module ClientValidationQuery Value="SELECT dbo.tbl_VCRMContact.Password, dbo.tbl_VCRMAddresses.EmailAddress1 AS Email FROM dbo.tbl_VCRMContact LEFT OUTER JOIN dbo.tbl_VCRMAddresses ON dbo.tbl_VCRMContact.ContactID = dbo.tbl_VCRMAddresses.ParentID WHERE (dbo.tbl_VCRMContact.Username = '[USERNAME]') AND (dbo.tbl_VCRMContact.CanLogon = 1) AND (dbo.tbl_VCRMAddresses.ParentTypeID = 2) AND (dbo.tbl_VCRMAddresses.AddressNumber = 1)" In the example above, the client will be prompted to provide a username and password to gain access to versaCAT. The user will be granted access provided the username and password match with a record within the database. The query above will also return their email address which allows the system to display only those calls for which they are the Primary Requestor. Note: the username and password is defined under the versaCAT tab of a versaCRM contact record. Example 2 - Windows Based Authentication Against The versaSRS / versaCRM Module ClientValidationQuery Value="SELECT '' AS Password, dbo.tbl_VCRMAddresses.EmailAddress1 AS Email FROM dbo.tbl_VCRMContact LEFT OUTER JOIN dbo.tbl_VCRMAddresses ON dbo.tbl_VCRMContact.ContactID = dbo.tbl_VCRMAddresses.ParentID WHERE (dbo.tbl_VCRMContact.Username = '[USERNAME]') AND (dbo.tbl_VCRMContact.CanLogon = 1) AND (dbo.tbl_VCRMAddresses.ParentTypeID = 2) AND (dbo.tbl_VCRMAddresses.AddressNumber = 1)" In the example above, the user will be granted access provided the Windows username is found within the database. The query above will also return their email address which allows the system to display only those calls for which they are the Primary Requestor. Note: the username and password is defined under the versaCAT tab of a versaCRM contact record. The password is not required when versaCAT is configured for Windows-based authentication. Example 3 - Forms Based Authentication Against The versaSRS Database Table tbl_ClientAccess ClientValidationQuery Value="SELECT Password, BEmail As Email FROM tbl_ClientAccess WHERE Username = '[USERNAME]'" In the example above, the client will be prompted to provide a username and password to gain access to versaCAT. The user will be granted access provided the username and password match with a record within the database. The query above will also return their email address which allows the system to display only those calls for which they are the Primary Requestor. Example 4 - Windows Based Authentication Against The versaSRS Database Table tbl_ClientAccess ClientValidationQuery Value="SELECT Password, BEmail As Email FROM tbl_ClientAccess WHERE Username = '[USERNAME]'" In the example above, the user will be granted access provided the Windows username is found within the database (tbl_ClientAccess). The query above will also return their email address which allows the system to display only those calls for which they are the Primary Requestor. ClientValidationVersaCRM: Governs whether the ClientValidationQuery is to be performed against the versaCRM module of versaSRS. ------------------------ value="0" - Disabled value="1" - Enabled Note: this setting should only be set to a value of 1 when accounts are defined under the versaCAT tab of the versaCRM contact module. ClientReminderQuery: Defines the SQL Query used to return a username and password for a given email address. ------------------- This feature is only available when the application is configured for Forms-based authentication. Example 1: Password Reminder Query For Forms Based Authentication Against The versaSRS / versaCRM Module value="SELECT dbo.tbl_VCRMContact.Username FROM dbo.tbl_VCRMContact RIGHT OUTER JOIN dbo.tbl_VCRMAddresses ON dbo.tbl_VCRMContact.ContactID = dbo.tbl_VCRMAddresses.ParentID WHERE (dbo.tbl_VCRMAddresses.ParentTypeID = 2) AND (dbo.tbl_VCRMAddresses.AddressNumber = 1) AND (dbo.tbl_VCRMAddresses.EmailAddress1 = '[EMAIL]')" Example 2: Password Reminder Query For Forms Based Authentication Against The versaSRS Database Table tbl_ClientAccess value="SELECT dbo.tbl_ClientAccess.Username FROM dbo.tbl_ClientAccess WHERE dbo.tbl_ClientAccess.BEmail = '[EMAIL]')" See Also: Password Reminder Email Template RemoveDomainFromUsername: ------------------------ Governs whether the DOMAIN is removed from DOMAIN\USERNAME when the system is configured for Windows authentication. value="0" - Do not remove the Domain. value="1" - Remove the DOMAIN AllowSecondaryRequestor: ----------------------- value="0" - Display only those calls where the Client is the Primary Requestor value="1" - Display Calls where the Client is either the Primary or Secondary Requestor. ApplyQueueRestrictions: ---------------------- value="0" - Default, provide access to Calls logged within any Queue, governed by AllowSecondaryRequestor setting value="1" - Provide access to Call logged within any Queue where the versaSRS Queue setting versaCAT Access is enabled, governed by AllowSecondaryRequestor setting SysAdminEmail: Email address of the system administrator (e.g. webmaster@mydomain) ------------- Refresh1: Refreshes the displayed calls (e.g. 60 - units seconds). -------- Example: value="120" - 120 seconds Region: Governs the display and input format of dates within the system. ------ value="-2" (dd/MM/yyyy HH:mm:tt): value="-1" (MM/dd/yyyy HH:mm:tt): value="1" (MM/dd/yyyy hh:mm:tt ss): value="2" (dd/MM/yyyy hh:mm:tt ss): PageSize: Defines the number of Calls displayed per page. -------- Example: value="5" - 5 records per page ReadingPane: Defines whether the reading pane is displayed. ----------- value="0" - Hide reading pane value="1" - Show reading pane EnableCallComments: Governs whether Call comments are exposed to the Requestor(s). ------------------ value="0" - Disabled value="1" - Enabled ShowCallComments: Sets the default state of the Show comments checkbox of the Call History (Printer Friendly) window. ---------------- value="0" - Unchecked value="1" - Checked ShowCorrespondenceHistory: Sets the default state of the Show correspondence history checkbox of the Call History (Printer Friendly) window. ------------------------- value="0" - Unchecked value="1" - Checked ShowLogout: Governs whether the Logout button is displayed. ---------- value="0" - Hide Logout button value="1" - Show Logout button CorporateLogo1: URL to image (GIF/JPEG) displayed within the Call History (Printer Friendly) window. -------------- Example: value="images/versaSRS_logo1.gif" CanManageProfile: Defines whether the versaCAT user can manage their profile. ---------------- Note: this feature should only be enabled for account details stored within the versaSRS database table, tbl_ClientAccess or when versaCRM is enabled. When this feature is enabled, the following properties cannot be modified by the user: Username, Email Address. Please note that any Notes recorded against the account are not exposed via versaCAT. value="0" - Disabled value="1" - Enabled EnableKB: Defines whether the Knowledge Base button is displayed providing access to the Knowledge Base tool. -------- value="0" - Hide button value="1" - Show button KBBaseURL: URL to the versaCAT Knowledge Base module. --------- Example: value="http://localhost/versacat/modules/helpdesk_kb/kbview.asp?kbaid=" KBTitle: The Knowledge Base Title displayed in the Internet Explorer Window ------- Example: value="versaSRS Knowledge Base" KBPageSize: The number of Knowledge Base records returned per page ---------- Example: value="5" - 5 records per page KBSearchModule: Defines whether full-text search is enabled for searching the Knowledge Base -------------- value="0" - Disabled value="1" - Enabled You will also need to setup full-text search, see also To Enable Full - Text Knowledge Base Search. KBPublicAccessOnly: Defines whether the system restricts the display of Knowledge Base articles to those marked with Enable Public Access. ------------------ value="0" - Disabled, provide access to all articles value="1" - Enabled, provide access to only articles marked with Enable Public Access EnableRSS: Governs whether the RSS feature of the Knowledge Base module is enabled. --------- value="0" - Disabled value="1" - Enabled KBImagePath: Defines the relative image path of images used by the Knowledge Base module. ----------- value="images/" - default value UploadPath: Defines a temporary upload folder for attachments. ---------- Example: value="c:\temp\" MailServer: Defines the I.P. address or name of the mail server that will be used when sending email. ---------- SMTPPort: Defines the SMTP port that will be used when sending email. -------- value="25" - default value DesktopEmailClient: 0 - Use versaCAT to compose email-based correspondence, 1 - Use the Client's Mail Client (e.g. MS Outlook). ------------------ MailTo: Defines a versaSRS email account (i.e. an email account that will be processed by versaSRS). ------ MailSubject: Defines the default subject field when logging a new call. ----------- PasswordReminderEmailXmlSrc: Defines the relative path and filename of password reminder email template. --------------------------- Example: value="PasswordReminderEmail.xml" - default email template See Also: Password Reminder Email Template The following web.config appSettings keys are reserved for internal use and must be set as follows: SiteID value="1" versaMenuLicenseKey value="A1T29-FGIJH-NU0XR-FKFMF-NGHOK" CustomFilter value="0" CustomFilterDSN value="" CustomFilterXmlSrc value="" CustomFilterXslSrc value="" CustomFilterFullAccess value="0" Web.Config Database Connection String Settings ---------------------------------------------- These settings are defined within the section of the web.config file. The connection string settings are described below: DSN: Defines the connection string to the versaSRS database. --- Example: connectionString="server=localhost;database=VersaSRS;uid=versasrs;pwd=Versa2008!" Tip: The DSN connectionString will be the same as that defined by SqlServerConnectionString within the web.config of versaSRS. ClientValidationDSN: Defines the connection string to the database containing client details and logon credentials. ------------------- Note: This is typically the same value as defined by DSN. KBDSN: The Knowledge Base database connection string to the database ----- Note: This is typically the same value as defined by DSN. 4.0 Accessing versaCAT ====================== After installing versaCAT, you can access the system via the URL: http://localhost/versacat/ or http://myserver/versacat/ The credentials required to logon to the system will depend on the Client Validation defined within the web.config 5.0 Password Reminder Email Template ==================================== The password reminder email is defined by an email template. The email template is an XML file that can be modified using any text editor. The default password reminder email template is PasswordReminderEmail.xml. This file is located within the root folder of the application. The contents of this file is presented below: support@mydomain [EMAIL] versaCAT - Password Reminder HTML Your Password: [PASSWORD]
]]> Each element is described below: - defines the email From address - defines the email To Address. The tag, [EMAIL] will be automatically replaced with the email address of the person requesting the reminder. - defines optional email Cc recipients. For example you could copy the request to a versaSRS enabled mailbox. - defines optional email Bcc recipients. For example you could blind copy the request to a versaSRS enabled mailbox. Note: to specify multiple recipients, delimit each recipient with a semi-colon. - defines the email Subject. - defines the mail message format. When set to HTML the message will be HTML format and Plain Text for any other value. - defines the maill message body. When entering HTML, the HTML should be enclosed within the tags unless XHTML is entered. Note: the tags [USERNAME] and [PASSWORD] will be automatically replaced with the user's username and password respectively. 6.0 To Enable Full - Text Knowledge Base Search =============================================== MS SQL Server 2000 Configuration Step 1.) - Please refer to the following Knowledge Base article: http://www.versadev.com/kbview.aspx?kbaid=180 Step 2.) versaCAT - web.config Configuration - Edit the appSettings section of the versaCAT web.config, set the value of the key, KBSearchModule to 1. Note: Changes to the web.config will destroy any active sessions with the application. Please make sure that users are not running versaCAT when modifying the web.config. 7.0 Support =========== VersaDev Pty Ltd 134 Gilbert Street Adelaide SA 5000 Australia Tel: +61.8.8463 1914 Fax: +61.8.8212 8447 Email: support@versadev.com Web: http://www.versadev.com forums: http://www.versadev.com/forums/