This registry entry enables is used to specify style, graphics, email and text settings for the CRMAnywhere (the Client Web Interface). This registry entry also is used to define the location of the graphics files for CSRAnywhere.
Testing Your Registry Entries
The system does not verify the validity of registry entries. Be sure to test your registry entries after completing them to verify that they are functioning correctly.
To set the CSRAnywhere Locations: Registry Entry for CSRAnywhere .
To override web-settings values for by Web Profile: Web Profile Viewer .
To override web-settings values for by Web User: Web Users Viewer
To Specify Web-viewer Document Categories: Registry Web Viewable Document Categories
To set up the guest login registry for the Confirm Appointment pages, see Guest Login for Appointment Confirmation
Please note that the values from 'web-settings' are loaded when the web service is started: if you change this registry entry, you will need to restart the web server to see the results.
Registry options entered on the Registry tab of the Web Profile / Web User viewer overridden entries in web-settings.
Id
web-settings
Setting Key: web-dir Setting Value: /subdirectory/
In Web Profile/User Registry Tab: web-dir= /subdirectory/
Specifies the subdirectory (in the base Data-Basics software directory containing the v.exe executable) where web files are kept (logos, banners). Note the '/' at the beginning and end of this entry are required. If you have multiple application servers, all should contain this subdirectory.
Setting Key: web-dir-temp Setting Value: /subdirectory/
Specified the subdirectory (in the base Data-Basics software directory containing the v.exe executable) where temporary web files are kept (these are cleaned on server startup, and on session logout). If you have multiple application servers, all should contain this subdirectory.
Email Groups Supported: Email Groups are now supported for Informational (pop up) email links as well as the New Site request form (from email-default). An email group is specified in brackets in the registry setting: for example, email-default=[custserv] specifies that all members of the email group custserv will be emailed when a new site request is made.
Setting Key: email-default Setting Value: info@mycompany.com
In Web Profile/User Registry Tab: email-default=info@mycompany.com
The default email address for information requests. This must be a valid email address on your company’s email server.
Setting Key: email-woinvviewdetail Setting Value: invoices@mycompany.com
In Web Profile/User Registry Tab: email-woinvviewdetail=invoices@mycompany.com
Replace invoices@mycompany.com with an address for an information request from 'View Invoice Detail' screen. This must be a valid email address on your company’s email server.
Setting Key: email-woviewdetail Setting Value: openworkorders@mycompany.com
In Web Profile/User Registry Tab: email-woviewdetail=openworkorders@mycompany.com
Replace openworkorders@mycompany.com with an email address for an information request from 'Open WO Detail' screen. This must be a valid email address on your company’s email server.
Setting Key: email-quotedetail Setting Value: quotes@mycompany.com
In Web Profile/User Registry Tab: email-quotedetail=quotes@mycompany.com
Email address for an information request from 'Quote Detail' screen. This must be a valid email address on your company’s email server. This email address will also be used when a CRMAnywhere user accepts a quote option in CRMAnywhere: an e-mail being sent when the web user pushes the Save Decisions button on the Manage Quotes page. This email will include the Quote Id and Description in the Subject line, and the following information in the body:
Quote Option Id(s) and Description(s)
Site Id and Name
Web User Id (or Technician Id if using old style configuration)
Date and Time acceptance given
When sending the e-mail, the system will first look in the Web User registry tab, then (if not found) in the Web Profile registry tab, and finally in the web-settings registry. If the system does not find this option, the email address specified in the email-default option will be used. If a valid address is not located, no action will be taken.
Setting Key: email-password Setting Value: emailaddress@mycompany.com
A temporary password may be emailed users if they forget theirs. Note that this functionality is not supported if the Client Web or CSRAnywhere login is via a Technician (rather than a Web User) record. This registry option enables you to specify the From Address to use in the password reset email. This must be a valid email address on your company’s email server. Note that if this option is not present, the ‘from’ address is derived from web-settings email-default.
This registry entry enables our clients to link to their own custom Help page that is hosted on their website (HelpURL) or a file located in the designated web directory (HelpFile). A basic pdf help file is available from support for your use with this feature.
If one of these registry option is enabled, a Help link will appear in the left menu frame of CRMAnywhere, and also on the Login page (if implemented as a URL). The link will point to a specific help page or document; it is not context specific for the Client Web page the link is on. Howwever, it may be made Web User or Web Profile Specific via the Registry tabs in the Web Profile/Web User viewers. Note that the web-settings registry must be enabled to support Help on the Log In screen.
Setting Key: HelpFile Setting Value: filename of help document
Note that the file should be located in the web directory with the Setting Key web-dir indicated in the web-settings registry or in the applicable Web User or Web Profile Registry tab. A .pdf file for your users is available from support, or you may generate your own.
Setting Key: HelpURL Setting Value: url of help webpage
This option would be implemented to point the CRM user to a specific page on their website for Help.
Example:
Setting Key: HelpURL Setting Value: http://www.mycompany.com/CRM/help.html
In Web Profile/User Registry Tab:
HelpURL=url of help webpage for this customer
Note: Web User/Web Profile Registry Tabs:
The Web Profile and Web User registry tabs support both the HelpURL and HelpFile formats. However, if both the HelpURL and HelpFile have been defined, HelpURL wins.
After a successful login, the Client Web session has registry settings that are compiled from web-settings, Web Profile and Web User. Individual settings from web-settings are trumped by settings from Web Profile which are in turn trumped by settings from Web User.
Setting Key: newsiterequiredfields Setting Value: clntste_nme, clntste_addrss, etc
In Web Profile/User Registry Tab: newsiterequiredfields=clntste_nme, clntste_addrss, etc
You can mark fields on the Request New Site screen as required by specifying a comma-delimited list of fields selected from the following:
clntste_nme (Site Name)
clntste_addrss (Street Address)
clntste_cty (City)
clntste_stte (State)
clntste_zp (Zip)
clntste_phne (Phone)
This feature is recommended to insure that a reasonable amount of information will be collected from this form.
This enhancement improves the way the page headers are handled. If Client Web was implemented in an earlier release, modifications to your existing graphics will be needed to support the change. To be more suitable for larger screen, the following registry entry may be used to enable the centering of headers with an appropriated background graphic, and a right-justified graphic to complete the screen:
Setting Key: NewHeaders Setting Value: true
See (Client Web Interface) Installation for details on the graphics needed to support this option.
Registry entry to allow sorting of open work orders and service request lists if multiple sites are involved. This option should be use with caution as it may impact performance.
Setting Key: AllowMultiSiteSorting Setting Value: true
The Client Web HTML display of the Report Service History and Site Equipment is not always clear past the first page. To ameliorate this problem, the following registry option has been added:
Setting Key: CRMReportType Setting Value: pdf (if absent, default as html)
If this option is implemented, a PDF widget will appear in the Report screen instead of the HMTL display. The report itself will be displayed in pdf format.
This option is also supported in the Web Profile / User Registry tabs.
Setting Key: InactivityTimeout Setting Value: N
In Web Profile/User Registry Tab: InactivityTimeout=N
Due to a lack of standardization in the way browsers close, it is not always possible for SAM Pro to know that a web user has left, and that the session should be closed. This registry option enables you to specify the number of seconds (where N is number of seconds) that a web user may be logged on before the session is closed. If any sessions for this user are inactive for more the N seconds the sessions will be closed and the logon history records will be terminated.
Example:
To terminate a session after 30 minutes:
Web Profile/User Registry Tab: InactivityTimeout=1800
Setting Key: dayshistorylimit Setting Value: numberofdays
This optional setting limits the amount of history displayed on completed work order lists to improve performance. For example, to limit history to the last year a setting value of 365 would be specified.
Setting Key: usedayshistorylimitforopen Setting Value: true
By default there is no age control on open work orders/service requests. If this is set to true the days history limit will be used when querying the database for open service requests and open work orders.
If this is set to anything other than true or not present at all, the days history limit will not be used when querying the database for open service requests and open work orders.
Setting Key: web-prefix Setting Value: prefix
Sets the string that gets prepended to the titles of web pages (e.g. 'Acme AC','Finest Facilites' “Excellent Electrical’, etc)..
Setting Key: newcallmessage Setting Value: Text of message to be displayed
In Web Profile/User Registry Tab: newcallmessage=Text of message to be displayed
This message is displayed at the beginning of the New Work Request process (Step One) and at the end of this process (the confirmation page for the service request). It can be used to display instructions for after-hours emergency service or other important information.
Setting Key: quotesmessage Setting Value: Text of message to be displayed
In Web Profile/User Registry Tab: quotesmessage=Text of message to be displayed
The message defined by this option will be displayed on the CRMAnywhere Quotes detail page.
Registry entry controls exist at the Webuser, Webuser Profile, or All Users level for the following options. The following entries at the web-settings level will remove links from all users:
Setting Key: DisableCSRNewLeads Setting Value: true
Setting Key: DisableCSRManageLeads Setting Value: true
Setting Key: DisableCRMReports Setting Value: true
Setting Key: DisableCRMNewCall Setting Value: true
Setting Key: DisableCRMSiteView Setting Value: true
Setting Key: DisableCRMOpenWO Setting Value: true
Setting Key: DisableCRMCompletedWO Setting Value: true
Setting Key: DisableCRMManageQuotes Setting Value: true
Setting Key: DisableChangePassword Setting Value:true
(currently only supported in the web-settings registry)
In Web Profile/User Registry Tab:
DisableCSRNewLeads=true
DisableCSRManageLeads=true
DisableCRMReports=true
DisableCRMNewCall=true
DisableCRMSiteView=true
DisableCRMOpenWO=true
DisableCRMCompletedWO=true
DisableCRMManageQuotes=true
Make these entries in the Registry child table of the Web User account to disable links for a single user.
Make these entries in the Registry child table of the Web Profile to disable links for users with that web profile. Note that these registry options are cumulative: ones entered in the Web Profile or Web User tab are in addition to those entered in the web-settings registry entry.
This option may be used to customize which work order columns will be displayed on the Open WorkOrder table.
Setting Key: woopencolumns Setting Value: list of columns
In Web Profile/User Registry Tab: woopencolumns=list of columns
The following columns may be specified:
type,id,rn,created,scheduled,tech,description,status,sitename,siteid,womane,servicerequest
Note that ‘id’ refers to the work order id. You may select from the list of valid options shown above; be sure to separate options with a comma.
If you do not create this entry, the following columns will appear by default:
id,sitename,siteid,created,scheduled,description,status,servicerequest
The Web Log Id (labeled Service Request) has been added to the Work Order list default displays so that users can better track their Service Requests as the default display. To add the Service Request to a custom list use the column name servicerequest.
Be sure that the columns and titles (in the following entry) are listed in the same order.
Setting Key: woopentitles Setting Value:Title1,Title2,Title3, …
In Web Profile/User Registry Tab: woopentitles=Title1,Title2,Title3,
This entry lets you customize the column titles on the Open Work Orders table. Be sure to specify the exact text that you want, and to sure to separate options with a comma.
Setting Key: woinvoicedcolumns Setting Value: list of columns
In Web Profile/User Registry Tab: woinvoicedcolumns=list of columns
The following columns may be specified:
id,sitename,siteid,created,workcode,closed,invoice #,invoiced, amt billed ,servicerequest
Note that ‘id’ refers to the work order id and servicerequest refers to the Web Log id. This entry may be used to customize which work order columns will actually be displayed on the Completed Work Orders screen. You may select from the list of valid options shown above; be sure to separate options with a comma. Be sure that the columns and titles (in the previous entry) are listed in the same order.
If you do not use this entry, the following columns will appear by default:
id,sitename,siteid,created,workcode,closed,invoicenum,invoiced,amt billed,servicerequest
Setting Key: woinvoicedtitles Setting Value: Title1,Title2,Title3, …
In Web Profile/User Registry Tab: woinvoicedtitles=Title1,Title2,Title3, …
This entry lets you customize the column titles that will appear on the Completed Work Orders table. Be sure to specify the exact text that you want, and to separate options with a comma.
Setting Key: sropencolumns Setting Value: list of columns
Web Profile/User Registry Tab: sropencolumns= list of columns
The following columns may be specified:
type,id,rn,created,scheduled,tech,description,status,sitename,siteid
This option may be used to customize which service request columns will be displayed on the Service Request table. Note that ‘id’ refers to the service request (weblog) id, and type refers to the record type (weblog in this case). You may select from the list of valid options shown above; be sure to separate options with a comma.
If you do not use this entry, the following columns will appear by default:
id,sitename,siteid,description,status
Be sure that the columns and titles (in the following entry) are listed in the same order.
Setting Key: sropentitles Setting Value: Title1,Title2,Title3, …
Web Profile/User Registry Tab: sropentitles=Title1,Title2,Title3, …
This entry lets you customize the column titles on the Service Requests table. Be sure to specify the exact text that you want, and to separate options with a comma.
This registry option may be enabled to block partially built quotes from appearing in CRMAnywhere. If the following registry option is implemented, the absence of the report id in the QuoteMaster header will be used to determine if the Quote should appear in CRMAnywhere. Note that the absence of a report id prevents CRMAnywhere from listing the quote. Note: the Web Viewable CRM field in the Quote Viewer must be flagged in order for the Quote to appear in CRMAnywhere.
Setting Key: BlockedQuotes Setting Value: true
In Web Profile/User Registry Tab: BlockedQuotes=true
If any registry settings have been made in the Web User or Web Profile registry tabs, this option must be set in these tabs to implement this option.
On the Acknowledge Leads page, the WO Id is a clickable link. If you click it, runs the WOList report and displays it by default. This works fine UNLESS there is a function substitution registry entry that points rwolist to something else (e.g., a crystal report the user doesn’t have access to). To handle this problem, the following registry option should be added to web-settings to allow the standard WO Report function id (rwolist – and whatever function substitution it points to) to overridden.
Setting Key: CSR-Workorder-Report
Setting Value: WOTICKET (or any valid function id for a valid workorder report).
The following registry options enables the user to control the columns that are included in the Site List. They can be entered either in the Web Profile (Registry tab) or the Web User (Registry tab) records. They do NOT seem to work when entered in the 'web-settings' registry entry.
In Web Profile/User Registry Tab:
clntstecolumns = comma-delimited list of columns to include
clntstetitles = comma-delimited list of titles for included columns
The clntstecolumns are the internal column names that are understood by SAMPRO. The choices are select, siteid, sitename, store, city, state, zip, openrequests, completedrequests. These are the default values.
The values for clntstetitles define the titles the user sees on the web pages. These can be changed as necessary. For example, 'Building Name' could be used in place of 'Site Name' and SAMPRO wouldn't care. The defaults are Sel, Site Id, Site Name, Store #, City, State, Zip, Open, Completed.
The two registry settings MUST stay synchronized with each other. If the clntstecolumns setting is used to rearrange or remove columns, then the corresponding changes must be made for clntstetitles. The clntstetitles seting can be used by itself when the only desired change is to relabel one or more column titles.
This page is desired to allow your CRMAnywhere customers the ability to access and download .pdf documents such as sales and service specials and other company literature. The page will display the Document Category, Document Id, and Document Description of the documents that qualify for the list. Clicking on the Document Id will display the Document. The graphic for the top banner must be named view_other_documents.gif and should be formatted in the same manner as your other banner title files (such as siteview.gif).
This page will only appear if the following new registry setting is present AND these documents are located in your data. When the Web User selects the new option, the list of Other Documents will be displayed.
Registry Id: web-settings
Setting Key: GlobalDocumentCategories
Setting Value: comma-delimited list of Document Categories
Setting Up the Global Documents
A document record must be made for each .pdf document that you wish to appear on the CRMAnywhere Other Documents page.
The Document Category must exactly correspond to one referenced in the registry setting
The Document Name should briefly describe the document: it will be displayed on the Other Documents page.
The Document must be flagged as CRM Web Viewable
In the References list, enter the Table Name field as Document, and select any Reference Id. If you do not complete this step, your document will not appear on SAM Pro’s View Document list (although it will appear in CRMAnywhere).
If the document is only good for a limited time, clearing the CRM Web Viewable flag will remove it from the CRMAnywhere View Document list.
Setting Key: web-front-end Setting Value: style
Where style is 'new' or 'old'. Defaults to 'new'. Old style refers to the web interface prior to version 5.01.