Configuration

Settings

General
LicenceCode SISfm licence code, allowing use of a given SISfm instance according to its URL. SISfm can always be used when the domain name of its URL is localhost.
GoogleAnalyticsTrackingId A Google Analytics tracking ID, obtained from a Google Analytics account, which may be used to track the usage of SISfm pages. Optional.
GoogleAnalytics4TrackingId A Google Analytics 4 tracking ID, obtained from a Google Analytics account, which may be used to track the usage of SISfm pages. Optional.
XSSValidateOff If set to TRUE, XSS/SQLi protection is disabled.
Access
LoginWindow The login page display mode, optional:
INLINEthe login page is displayed in the current browser window.
POPUPthe login page is displayed in a popup window (default).
LoginBarHeight The height of the login bar in pixels, 19 if omitted.
LoginBarTextColour The colour of text in the login bar, as hexadecimal RRGGBB (range 00 to FF for Red, Green, Blue). If omitted blue is used.
LoginOnLoginDisabled If set to TRUE, the Log In link is not displayed in the login bar.
HomeLinkText The text to be displayed for the home page link in module menus. If omitted the module name is used.
AccessDeniedText The text to be displayed if access to a function is denied. If omitted no message is issued.
Custom Files
CustomFolder The URL of the folder containing custom files. If omitted the supplied default folder is accessed.
Data Files
DataFolderSis The URL or physical path of the folder containing the site and building plans as Cadcorp SWD files.
DataFolderMap The URL or physical path of the folder containing facility map XML, SVG and image files. Required. A physical path may be specified, when an ASPX page is used to send map layer SVG content (subject to layer access control) to prevent unauthenticated access to it.
DataFolderMapIcon The URL or physical path of the folder containing map icon image files (see Map Compiler Cadcorp Data). Optional.
DataFolderPhoto The URL of the folder containing facility images. Optional.
DataFolderReport The URL or physical path of the folder containing report definitions for the Report Maker module. Optional.
DataFolderAsset The URL of the folder containing asset images. Optional.
DataFolderBIM The URL of the folder containing X3D files. Optional. See BIM Compiler for details.
Databases
  Database connection details may be:
  • a Microsoft Access database if it ends with ".mdb", its path is physical if it includes "\" otherwise it is a URL; else
  • an OLE DB Data Link if it ends with ".udl", its path is physical if it includes "\" otherwise it is a URL; else
  • an OLE DB (Object Linking and Embedding Data Base) connection string if it contains "provider="; else
  • an ODBC (Open Data Base Connectivity) connection string.

DbConnection setting values may be encrypted using the SISfm Encrypt Database Connection Strings utility.

DbConnectionIFM The IFM Facility database connection details.
DbConnectionAFM The Archibus Facility database connection details. Required if DbConnectionIFM is not specified.
DbConnectionLDAP The LDAP connection details. The following methods are available:
  • SQL - specify a database connection string (e.g. using the AdsDsoObject OLE DB provider) plus setting DbTableLDAP.
  • .NET - specify an LDAP server URL using the ldap: protocol, and do not set DbTableLDAP. Note that this method requires the adsPassword session variable.
DbConnectionPBX The Telephone PBX database connection details. Optional, if defined also see DbProductPBX
DbConnectionBook The Room Bookings and Asset Bookings database connection details. Required to enable this module.
DbConnectionCMIS The CMIS timetable database connection details. Optional, used by Room Bookings. Only one timetable database type may be specified.
DbConnectionCELCAT​N (where N=1,2,3...) List of the CELCAT timetable database connection details. Optional, used by Room Bookings. Only one timetable database type may be specified.
DbConnectionMove The Move Manager database database connection details. Required to enable this module.
DbConnectionAsset​N (where N=1,2,3...) List of asset database connection details, referenced by AssetTable and *LinkTable values.
DbConnectionMap​N (where N=1,2,3...) List of map database connection details for real time layers, where N corresponds to View Points overlay attribute DbConnectionMap& (see Map Compiler Cadcorp Data).
 
DbAccessSecurity If set to TRUE, access security is enabled, using the Archibus application and hierarchical security model, extended to include Map Enquiry layers and Report Maker reports. For its data model refer to the facility database.
DbAccessSecurityMethod The access security method:
NEWthe new method now available (default).
OLDthe method previously used.
BOTHboth methods, error displayed if results differ (performance penalty).
DbDocumentStorage If set to TRUE, documents/photos are accessed from the database instead of from folders DataFolderPhoto and DataFolderAsset.
DbDocumentMaxMB The maximum size in MB of documents/photos that can be uploaded. This should be less than the ASP.NET settings maxRequestLength and maxAllowedContentLength for the SISfm application. Optional, no check is made if not defined.
DbEnableADS If set to TRUE, access to LDAP via the ads table is enabled.
DbProductPBX The Telephone PBX database product:

EricssonEricsson DNA Suite (default)
AastraAastra CMG Suite
DbTableLDAP The LDAP table name. Required if DbConnectionLDAP is defined for the SQL implementation.
DbUpdateLogging If set to TRUE the SISfm session variable adsName is passed to the database session before executing an INSERT, UPDATE or DELETE statement:
  • for SQL Server by executing:
    EXEC sp_set_session_context @key='UserID', @value='adsName';
  • for Oracle by executing:
    CREATE OR REPLACE CONTEXT sisfm USING sisfm_set_key;
    CALL sisfm_set_key('UserID', 'adsName');

    (note that the procedure sisfm_set_key must exist in the database)
so that SQL Server triggers can be used to log changes including the users who made them. See FAQ How do I log database updates?
DbExcludeErrorDetails If set to TRUE details in "Error executing SQL" messages are omitted.
Email
MailDomain The domain name of email addresses at your organisation.
NOTE that the SMTP server used by SISfm to send emails is configured separately in the <system.web> section of Web.config, refer to the supplied example for details.
MailTesting If set to TRUE then emails sent by SISfm will instead be created in its temp folder, and display in popup windows, files named MailTestingN.html where N=1,2,... containing the messages that would have been sent in a session.
MailMethod The method used for sending emails:

SMTPSMTP settings in web.config (default).
GoogleOAuth2 authentication with the Google identity provider, using MailGoogle settings below.
MicrosoftOAuth2 authentication with the Microsoft identity provider, using MailMicrosoft settings below.
 
MailMicrosoftTenantId The Directory (tenant) ID of the email application created in Microsoft Entra. Message 'From' addresses must not include a display name (which is added by Entra), and must have access to this application.
MailMicrosoftClientId The Application (client) ID of the email application.
MailMicrosoftClientSecret The Client Secret that authorizes access to the email application.
 
MailGoogleServiceAccountEmail The email address of the Service Account created in Google Cloud. Must not include a display name. Message 'From' addresses may have display names, and must have access to this account.
MailGooglePrivateKey​N (where N=1,2,3...) A Base64 encoded private key that authorizes access to the Service Account.
Web Service
ServiceWebsite URL to access the SISfm Services website. Required if MailMethod is Google or Microsoft.
Charts
ChartOptions​N (where N=1,2,3...) Optional list of Google Charts options, as the following semicolon-separated values:
  1. The chart type, one of: AreaChart BarChart ColumnChart ComboChart Gauge LineChart PieChart.
  2. Zero or more options for that chart type.
 
ChartData​N (where N=1,2,3...) Optional list of corresponding SQL SELECT statements to obtain Google Charts data, as a table with:
  1. The first column of string data type.
  2. One or more subsequent columns of numeric data type, according to the chart type.
The SQL must include the WHERE 1=1 placeholder for adding site, building, floor restrictions.
 
ChartDrilldown​N (where N=1,2,3...) Optional list of corresponding SQL SELECT statements to obtain background data for a chart, as a Google Charts chart type Table. The SQL should include columns matching those used for the corresponding chart, plus others as desired. The SQL must include the WHERE 1=1 placeholder for adding site, building, floor restrictions. Columns may include hyperlinks or other HTML. Use values not commencing SELECT (e.g. "-") where background data is not required.
People
AppAdmin Comma-separated list of email addresses of the SISfm administration team. If this includes the address of the logged in user:
  • Space Manager displays the Output Log button in its menu.
  • Edit Occupants is available for rooms (when People Manager is not enabled).
  • All details pages display the Add, Remove and Edit buttons.
  • All details pages display all fields.
NOTE that if access security is enabled, use of the equivalent access security functions is recommended instead of this setting.
 
EmView The name of a database view to access people, instead of table em. Optional, if defined and not em, functions that update people are not available, other than people in the EmEditable table.
EmEditable The name of a database table to access people whose details can be edited. Optional, if defined it must have the same fields as table em, and the EmView setting must specify a database view which combines it with table em using an SQL UNION.
EmNameFields Comma-separated list of the names of the fields in table em used to store last and first name. Optional, default em_id,em_first. Note that the default Archibus schema includes fields name_last,name_first.
EmNumberField The name of the field in tables em, em_schedule, em_group and occupant_group_new used to store person identifier. Optional, default em_number. The field em_id is recommended.
EmPositionField The name of the field in table em used to store position title. Optional, default em_positn.
EmExtensionFromLDAP If set to TRUE then staff extensions are obtained from the LDAP telephoneNumber, instead of the em.extension field.
EmExtensionLastDigits The number of digits at the end of the LDAP telephoneNumber field that are used as the extension number.
EmExtraKeyField The name of an additional key field in tables em and em_schedule. This must be of a string data type. Optional, the default key is the field defined by EmNumberField.
NOTE that the use of an additional key field (to model multiple roles for the same person, for example) is not recommended unless table em is only updated from a product which supports such a model correctly (such as PeopleSoft or Alesco).
EmLocationUpdateCommentField The name of an optional field in table em to store details of the most recent update by the Edit Occupants function of the person's location (fields bl_id, fl_id, rm_id and loc_code) as "date loc_code updated by username using SISfm". Not used if People Manager is enabled.
EmLocationDepartmentField The name of an optional field in table em to store an alternative person's "department". Used by the Edit Occupants function. If not defined, em.dp_id is used. Not used if People Manager is enabled.
EmStatusLeftValue The value of field em.status to signify that the person has left the organisation, so will not be included in staff searches. Optional. Field em.status is not accessed if People Manager is enabled, when em.date_end is used for this purpose.
EmTypeFieldsRequired​N (where N=1,2,3...) Optional list of person edit validation checks according to person type, each specifying the following space-separated values:
  1. The person type, a em.em_type value.
  2. A comma-separated list of required fields in table em.
 
BlAreaField The name of the field in table bl used by Map Enquiry to obtain building areas for site plans. Optional, default area.
Facility Type
FacilityType​N (where N=1,2,3...) Optional list of additional facility types, each specifying the following comma-separated values:
  1. The facility type code, e.g. CP.
  2. The facility type name equivalent to "building", e.g. Car Park.
  3. The facility type name equivalent to "floor", e.g. Level (if omitted, floor details are not displayed).
  4. The facility type name equivalent to "room", e.g. Bay.
Location Code
LocCodeFormat Specifies the format for location code values (loc_code) as one of the following:

  • delimited format - by specifying a single delimiter character. This is used to delimit S, B, F, R so that they can be of variable length. The delimiter must be one of the !$+-.@^`~ characters.

    Note that the ; character is also permitted as a delimiter if XSSValidateOff is TRUE.

    Example: 20.15A.01.102

  • fixed format - by specifying a character field layout such as SSBBBbFFR.

    Fields must be defined in this order. Each may have any number of characters. The room ID field extends to the end of the loc_code value (whose length may vary), so a single R is sufficient. Any other characters in the LocCodeFormat value signify characters in the location code that are not used. The building sub-ID is intended for buildings identified with a suffix character (e.g. building 15A), all zeros signifies no suffix.

    Example: 20015A01102

where:

S is the site ID (site.site_id).
B is the building ID (first part of bl.build_no).
b is the building sub-ID (optional, second part of bl.build_no).
F is the floor ID (rm.fl_id).
R is the room ID (rm.rm_id).

If omitted, delimited format using a decimal point (.) is expected.

NOTE that the above fields must not contain:

  • the loc_code delimiter character;
  • characters *<>":?/\| which are not permitted in Windows file names;
  • characters #$&+=@ and the space character, which are not permitted in URLs without encoding;
  • characters %[]{}^ which are generally considered unsafe in URLs without encoding;
  • characters '(; which are reserved by SISfm.

Thus characters permitted in these fields for SISfm are:

  • characters ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
  • characters 0123456789
  • characters !)-.`~_ (less the loc_code delimiter character, except rm.rm_id which may contain one)

Some permitted characters should be avoided for readability or keyboard entry reasons.

LocCodeOutput Specifies the format for location code display.

  • default format - by specifying no value. The default format (e.g. ML 15A.102) is displayed, in which the site ID is converted to its site Code and the floor ID field is not included, so this is best suited when the floor ID prefixes the room ID.

  • location code format - by specifying the value LocCode. The location code value itself is displayed, which is best suited for the delimited format.

  • custom format - by specifying any value optionally containing one or more occurrences of {S}, {B}, {F} and {R} which are replaced by the site ID, building ID, floor ID and room ID respectively. Repeat S,B,F,R to specify a minimum field width, this will be left padded with zeros. For example {S}{BB}.{R} displays site 3, building 5, room 101 as 305.101.

LocCodeOutputB Specifies the format for building code display, if omitted LocCodeOutput is used.
Sites
SiteId Comma-separated list of site.site_id values for sites to be included. Site selectors show sites in this order.
SiteCode Comma-separated list of corresponding short site mnemonic codes.
Rooms
  Room classes may be either room categories (rm.rm_cat) or room types (expressed as rm.rm_cat|rm.rm_type - e.g. 6|601).
RoomClassOccupant Comma-separated list of classes for "occupied" room categories, such as offices.
RoomClassSession Comma-separated list of classes for "sessional" room categories, such as teaching areas or laboratories.
RoomClassGeneral Comma-separated list of classes for other general rooms.
RoomClassMeeting Comma-separated list of classes for conference/meeting rooms.
 
RoomTypeLayoutCaseStudy Comma-separated list of case study room types. For these rooms the image ~/space/images/roomLayoutsCStudy.gif is displayed in room details.
RoomTypeLayoutTeaching Comma-separated list of lecture or tutorial room types. For these rooms the image ~/space/images/roomLayoutsN.gif is displayed in room details, where rm.RoomCapacityField >= N and N=35,50,70,100.
Assets
AssetStatusInclude Comma-separated list of asset table status field values for which assets will be shown. If not defined, or the status field does not exist, all assets will be shown.
AssetLatLonFields If set to TRUE the asset database table location field names are lon and lat, otherwise X and Y.
 
AssetTable​N (where N=1,2,3...) Optional list of asset database tables (for details see Asset data), each specifying the following comma-separated values:
  1. The database identifier, as an DbConnectionAsset entry number, or zero for the Facility database. Must be zero for Asset Manager.
  2. The database table name. This may instead be a table alias name followed by the actual table name and an SQL WHERE clause to specify a subset of rows in the table, for example museq[eq WHERE eq_std='MUS'].
  3. A title for the asset category stored in this table.
  4. An optional '~' separated list, to enable its availability in Asset Manager, of:
    1. A definition of fields in this table for asset items.
    2. An optional definition of fields in this table for asset component items.
    where each field definition is a space-separated list of:
    • field group definitions, as group titles enclosed by '|' and with '_' replacing spaces. Group title 'Photo' specifies a field group to contain a photo thumbnail with its name and description.
    • the * character, to specify a component count field for asset items.
    • field names, or '-' separated lists of names of fields in dropdown field sets, for the preceding group. If a field name is followed by '!' then it will not be included as a List column.
 
AssetSubTable​N (where N=1,2,3...) Optional list of asset database sub-tables (for details see Asset Manager), each specifying the following comma-separated values:
  1. The name of a table/alias specified by an AssetTable setting.
  2. The sub-table name.
  3. A sub-table title.
  4. A field definition list, as for the AssetTable setting.
 
AssetListCumulative If set to TRUE, asset lists in building and floor details include those of their descendants.
Projects
ProjectStatusInclude Comma-separated list of project.status field values for which projects will be shown. If not defined, or the status field does not exist, all projects will be shown.
Links
LinkFileModifiedDate If set to TRUE the file modified date is included in document links, for documents on the SISfm web server.
 
SiteLinkFolder​N (where N=1,2,3...) Optional list of site links folders, each specifying the following comma-separated values:
  1. A title for the links stored in this table.
  2. A folder URL, under which location code sub-folders store the link targets (for details see External links).
BuildingLinkFolder​N (where N=1,2,3...) Optional list of building links folders, as for other links folders.
FloorLinkFolder​N (where N=1,2,3...) Optional list of floor links folders, as for other links folders.
RoomLinkFolder​N (where N=1,2,3...) Optional list of room links folders, as for other links folders.
 
SiteLinkTable​N (where N=1,2,3...) Optional list of site links database tables, each specifying the following comma-separated values:
  1. The database identifier, as an DbConnectionAsset entry number, or zero for the Facility database.
  2. The database table name (for details see External links).
  3. A title for the links stored in this table.
  4. An optional URL base for the link targets stored in this table.
BuildingLinkTable​N (where N=1,2,3...) Optional list of building links database tables, as for other links tables.
FloorLinkTable​N (where N=1,2,3...) Optional list of floor links database tables, as for other links tables.
RoomLinkTable​N (where N=1,2,3...) Optional list of room links database tables, as for other links tables.
 
FolderLinkTable Optional folder links database table, specifying the following comma-separated values:
  1. The database table name (for details see External links).
  2. An optional URL base for the link targets stored in this table.
Feature Fields
FeatureBlankOmit If set to TRUE feature fields will not be displayed if their values are blank.
FeatureChartPercent If set to TRUE the display of percentage feature field values will include a pie chart.
FeatureDateFormat Specifies the format for displaying date feature fields, using either a standard format code or a custom format pattern. The following table lists the available standard format codes, their equivalent custom format patterns, and the result for the same date and time for the en-AU culture. Other custom format patterns can be used (as supported by the Microsoft .NET DateTimeFormatInfo class).

NameCodePatternResult
(default) d/MM/yyyy h:mm:ss tt3/01/2002 1:34:21 PM
Long DateDdddd, d MMMM yyyyThursday, 3 January 2002
Short Datedd/MM/yyyy3/01/2002
Long Date Long TimeFdddd, d MMMM yyyy h:mm:ss ttThursday, 3 January 2002 1:34:21 PM
Long Date Short Timefdddd, d MMMM yyyy h:mm ttThursday, 3 January 2002 1:34 PM
Short Date Long TimeGd/MM/yyyy h:mm:ss tt3/01/2002 1:34:21 PM
Short Date Short Time  gd/MM/yyyy h:mm tt3/01/2002 1:34 PM
Day MonthM or m  dd MMMM03 January
RFC 1123R or rddd, dd MMM yyyy HH':'mm':'ss 'GMT' Thu, 03 Jan 2002 13:34:21 GMT
ISO 8601 basedsyyyy'-'MM'-'dd'T'HH':'mm':'ss2002-01-03T13:34:21
Long TimeTh:mm:ss tt1:34:21 PM
Short Timeth:mm tt1:34 PM
Universal TimeUThursday, 3 January 2002 2:34:21 AM
Universal Sortableuyyyy'-'MM'-'dd HH':'mm':'ss'Z'2002-01-03 13:34:21Z
Month YearY or yMMMM yyyyJanuary 2002

FeatureNoTickCrossFields Comma-separated list of feature field names (in any table) whose values are to be displayed literally instead of as a tick, cross or -. Optional.
FeatureShowAllFields If set to FALSE item details will only include feature fields. FALSE overrides the ShowAllFields access security function.
 
PersonFeature​N (where N=1,2,3...) Optional list of person feature fields in table em, each specifying the following comma-separated values:
  1. The name of the field in the table, or a field calculation. A field name value may optionally be followed by a colon, then one of the following descriptors:
    • csi - values are converted to asset CSI Classification descriptions, and a selector button is included when editing. The database field must be a string data type.
    • phone - phone number validation is performed when editing. Values may only include digits and spaces, plus a leading + for international numbers, otherwise a leading 0 and nine more digits. The database field must be a string data type.
    • link:URL - values are displayed as links, which display URL in a new window, replacing any * character in URL by the value.
    A field calculation value takes the form (<expression>) AS <alias> where:
    • expression - is an SQL expression which is valid for the table in SQL SELECT and ORDER BY clauses for the database in use. NOTE that SQL errors will be issued if the expression is invalid. NOTE that it may be necessary to review the SQL that uses this expression for suitability (to see this, introduce an error in it).
    • alias - is any valid SQL field alias name which does not conflict with feature field names in this table. Note that the alias name is displayed in the Map Enquiry advanced theme column list, and as the theme legend title if selected.
    Access security should be provided for a field calculation by creating a dummy field named alias in this table, and defining access to this field in the sisfm_flds table.
  2. (not currently used)
  3. (not currently used)
  4. The column (1,2,...) in which to show the feature.
  5. The heading under which to show the feature.
  6. The description of the feature. If omitted its sisfm_flds.ml_heading is used.
  7. (not currently used)
Features must be listed in column and heading order.
 
ProjectFeature​N (where N=1,2,3...) Optional list of project feature fields in table project, as for Person feature fields.
 
AssetFeature​N (where N=1,2,3...) Optional list of asset feature fields in asset tables, as for Person feature fields plus:
  1. May be an amenities name enclosed in * characters. For example the value *amenity* specifies amenities stored in the asset_amenity table. Other amenities names may be specified to reference other types of amenities in other tables whose names and amenity type fields are named correspondingly.
 
SiteFeature​N (where N=1,2,3...) Optional list of site feature fields in table site, as for Asset feature fields.
 
BuildingFeature​N (where N=1,2,3...) Optional list of building feature fields in table bl, as for Asset feature fields.
 
FloorFeature​N (where N=1,2,3...) Optional list of floor feature fields in table fl, as for Asset feature fields.
 
Feature​N (where N=1,2,3...) Optional list of room feature fields in in table rm, values as for Asset feature fields plus:
  1. A "D" signifies that this is a Default feature that will always be shown in a search result, otherwise it will only be shown if it has been searched upon.
  2. An "S" signifies that this is a Search field that will be searched for text matches.
  1. A "Q" signifies that this field is available to the Map Enquiry Room dialog Quick Edit function.
Note that "D" and "S" flags are ignored for field calculation items.
 
Search
SearchHints Comma-separated list of search terms to display when the Show Search Hints icon of Space Manager is selected (for Map Enquiry, see the MapSearchAdvanced setting). Terms may be followed by explanatory descriptions in parentheses. Optional, if omitted this icon is not displayed. A recommended setting is the following sets of terms (separated by blank terms):
  • the location search keywords site, building, floor, room.
  • alternative facility type codes with descriptions in parentheses, if in use, e.g. cp (car parks).
  • the condition search keywords defined by Search values (perhaps duplicated to include operator options).
  • text which is likely to be commonly used in condition searches or text searches.
SearchSQL If set to TRUE then search SQL statements are included as comments in results XML. This should only be used for diagnostic purposes.
 
Search​N (where N=1,2,3...) List of search keyword specifications, each comprising the following comma-separated values:
  1. The search text keyword.
  2. The name of the field (col), which must exist in the rm table.
  3. The type of search comparison to make:
    numNumeric, when followed by an optional operator from  =  >  <  >=  <=  <>  followed by a number.
    strString, using the following operator and field value
    str_afterString, when followed by a further search term, which is compared for any match (col LIKE '%term%').
    bool_numBoolean numeric (col >= 1).
    bool_yBoolean text (col LIKE 'Y%').
  4. The comparison operator, one of  EQ  GT  LT  GE  LE  NE  (which are translated to the SQL operators  =  >  <  >=  <=  <> ) or LIKE or IS or IS NOT. Used for type str, and as the default operator for type num.
  5. The comparison value, used for type str. The comparison operator and value must form legitimate SQL when combined.
 
Database Manager Module
DatabaseInfoPanelWidth The width of the right information panel, as a percentage. Optional, default 50%.
DatabaseExportFormat The table export format:
  • CSV - comma separated values (default).
  • TXT - tab separated values.
Space Manager Module
  (settings have a Room prefix because formerly this was the Room Enquiry module)
RoomSelectorRows The initial number of selector rows to display in desktop browsers. Optional, default 8. Wrapped pulldown selectors are used in mobile browsers.
RoomSelectNames If set to TRUE the building, floor and room selectors include names as well as IDs, and the site selector includes site codes as well as names.
RoomAdministrationMode If set to TRUE a Statistics option is available when Facility Type, Site, Building or Floor are selected. TRUE overrides the RoomAdministrationMode access security function.
RoomAdministrationOmitRoomCount If set to TRUE room counts are suppressed in Statistics pages.
RoomDetailsSectionOrder A space separated list of zero or more of the following, specifying the order of sections in details pages, followed by those omitted in this order, of:
  • Photos - photos and documents.
  • Projects - projects in site and building details.
  • BuildingLeases - building lease notes in building details (see RoomBuildingLeases setting).
  • RoomUtilisation - room utilisation in room details (see RoomUtilisation* settings).
  • Links - links (see FolderLinkTable, *LinkFolder and *LinkTable settings).
  • SiteBuildingPlanLinks - building plan links in site details in Map Enquiry.
  • WorkRequests - work requests in site, building, floor, room and asset details.
RoomDetailsPlusOccupants If set to TRUE room occupants are displayed after room details in Map Enquiry. TRUE overrides the RoomDetailsPlusOccupants access security function.
RoomDetailsPlusTimetable If set to TRUE the room timetable is displayed after room details in Map Enquiry. TRUE overrides the RoomDetailsPlusTimetable access security function.
RoomDetailsTimetableFirst If set to TRUE the room timetable is displayed before room details in Map Enquiry if both are displayed.
RoomTimetableForMeetingClass If set to TRUE the room timetable is displayed for RoomClassMeeting rooms.
RoomMapModeInherit If set to TRUE Space Manager passes mode=simple to embedded instances of Map Enquiry so that it does not display its information panel.
RoomPhotoPage If set to TRUE clicking a thumbnail photo on a details page displays the full photo in a photo browsing page, otherwise only the full photo is displayed.
RoomPhotoLimit The maximum number of photos to display on details pages when the photo browsing page is enabled. Optional, if omitted all photos are displayed.
RoomStaffFields Comma separated list of the names of fields to include in staff lists, in the order given. Optional, default position,extension,speed,fax,cellular_number. Fields are in table em except speed which is obtained from the PBX database if defined. Field position is obtained using the EmPositionField setting, if absent staff positions are also omitted in Move Manager. Field headings are obtained from sisfm_flds.ml_heading.
RoomUtilisationFields Comma separated list of three base names for fields in table rm which respectively contain yearly frequency, occupancy and utilisation. Field names consist of the base followed by the year (e.g. freq2013). Fields may be of numeric or string data type, string values may end in %. Room utilisation graphs are drawn in the room details page if any valid values for such fields exist, of width sized to suit the range of years, if enabled by access security. Optional, if not defined room utilisation graphs are not displayed.
RoomUtilisationHeading The heading for the room utilisation section of room details. Optional, default Room Utilisation
RoomUtilisationLabels If set to TRUE the points in room utilisation graphs are labelled.
RoomCapacityField The name of the field in table rm to store the maximum number of occupants. Default is capacity. This field is not required if People Manager is enabled in Archibus mode.
RoomVacantField The name of an optional field in table rm to store the value Occupied or Vacant. This field is updated when Edit Occupants is used, and when its "Reset Vacant field for all rooms" button is used (e.g. after table em has been updated externally). Not used if People Manager is enabled.
RoomBuildingLeases The text to display as building lease notes. Optional, if not defined building leases are not displayed.
RoomCompiledPDFCaption An optional caption for the Compiled PDF button, default Compiled PDF.
RoomSearchNameField The name of a field in table rm to use instead of rm.name when searching for rooms, and in the Search Results dialog. This setting is designed for use in an environment where some room names must be hidden.
 
WorkRequestById Item details Work Request panel link URL to display details of an Archibus work request, whose ID is appended. Optional, if omitted the SISfm Maintenance Module is accessed.
WorkRequestNew Item details Work Request panel New Work Request button URL to display a new work request form. Optional, if omitted and WorkRequestById is defined, this button is omitted, otherwise the SISfm Maintenance Module is accessed.
WorkRequestProbTypeExclude Item details Work Request panel list filter, as a comma-separated list of Problem Type values of work requests to not be shown, unless Show All is selected. Optional.
 
RoomTrialDetailsTitleCaption An alternative room details title bar caption for trial rooms.
RoomTrialDetailsTitleColour An alternative room details title bar background colour for trial rooms.
Map Enquiry Module
MapManager The email address of the Map Enquiry manager, used:
  • as the from address for emails sent by this module.
MapFeedbackEmail The email address to which Feedback messages are sent. Optional, if this and MapManager are not specified, the Feedback function is not available.
Appearance
MapFooter If set to TRUE the page footer is included. The page footer is not displayed by Map Enquiry on mobile devices.
MapHeader If set to TRUE the page header is included. The page header is not displayed by Map Enquiry on mobile devices.
MapLoginBar If set to TRUE the login bar is included. The login bar is not displayed by Map Enquiry on mobile devices.
MapHomeNoMenu If set to TRUE the site selector is not displayed on the custom home page (which must then select sites in a different way).
MapHomeExit If set to TRUE, EXIT exits to the Map Enquiry home page instead of to the SISfm home page.
MapInfoPanelWidth The width of the right information panel, in pixels or as a percentage. Optional, if omitted the information panel is not displayed. The information panel is not displayed by Map Enquiry on mobile devices. This width is remembered between sessions on the same device and browser if MapNoWebStorage is not TRUE.
MapInfoPanelMenu If set to TRUE an information panel menu is displayed.
GUI
MapDashboardCharts The Google Charts to display on the Dashboard page, as a space-separated list of indexes to the ChartOptions and ChartData settings. Optional, if not specified the Dashboard is not available.

Note that the chart SQL must include both a table alias CHART_TABLE and a WHERE 1=1 placeholder for adding site, building, floor, room restrictions

MapDashboardChartsAll The Google Charts to display on the Dashboard page for All sites. Overrides MapDashboardCharts if specified.
MapDashboardChartsSite The Google Charts to display on the Dashboard page for a site. Overrides MapDashboardCharts if specified.
MapDashboardChartsBuilding The Google Charts to display on the Dashboard page for a building. Overrides MapDashboardCharts if specified.
MapDashboardChartsFloor The Google Charts to display on the Dashboard page for a floor. Overrides MapDashboardCharts if specified.
MapDashboardChartsRoom The Google Charts to display on the Dashboard page for a room. Overrides MapDashboardCharts if specified.
 
MapAllDone If set to TRUE the DONE button is shown on item details, legend, report, find way and route dialogs.
MapDialogElementHeight The height of dialog elements (such as buttons), as a factor. Optional, default 1.
MapDialogPosition Specifies whether dialog positions should be remembered:
NEVERnot remembered (default)
SESSIONremembered during sessions
DEVICEremembered during sessions, and between sessions on the same device and browser if MapNoWebStorage is not TRUE.
MapDialogTopLeft If set to TRUE dialogs are displayed at top left.
MapDialogSingleButtonDisabled If set to TRUE single button dialogs (such as point item details with a single description attribute) are instead always displayed with content between top and bottom buttons.
MapDialogWidth The dialog width in pixels. Optional, default 192, minimum 100. The dialog width is also constrained to be no more than 0.6 time the device width.
MapDialogHintsDisable If set to TRUE the Hints dialogs are not displayed.
MapItemDialogAsTooltip If set to TRUE, item dialogs are displayed as tooltips in desktop browsers, provided another dialog is not displayed.
MapItemDialogCloseOnPanZoom If set to TRUE, an item dialog is closed if a pan or zoom occurs.
MapMenuFeaturesReverse If set to TRUE the Features dialog displays entries in reverse order..
MapMenuButtons Popup menu button availability and order, as a comma separated list of button names. The names EXIT and SITE may be used to include these buttons in the popup menu instead of in the site and floor Plans dialogs. The name Point Features may be used to specify a separate button for point feature layers. Optional, default no popup menu if MapTopMenuButtons is defined, otherwise Plan Details,Zoom In,Zoom Out,Zoom Previous,Home,Print,3D,Multi Plan,Plans,Viewpoints,Features,Point Features,Download,Labels,Colours,Legend,Report,Footprint,Edit,Draw,Find Way,Zone Location,Occupant Groups,Search,Share,Feedback,Help.
MapMenuButtonNames Names for the popup menu buttons, to replace the standard names, as a comma separated list in the same order as MapMenuButtons. These names are also used for corresponding dialog titles. For blank or missing names the standard button names are used. Optional.
MapTopMenuButtons Top menu button availability and order, as a comma separated list of button names. Names as for MapMenuButtons plus the name MENU to include a button for displaying the side menu. If omitted there is no top menu.
MapTopMenuButtonNames Names for the top menu buttons, as for MapMenuButtonNames.
MapSideMenuButtons Side menu button availability and order, as for MapMenuButtons.
MapSideMenuButtonNames Names for the side menu buttons, as for MapMenuButtonNames.
MapPrintFieldsInAdvance If set to TRUE, print fields are entered in the Print dialog instead of in the Print Preview dialog, the print preview window displays the Legend dialog if colours are defined, and the Print Preview dialog is replaced by a Print button. Ignored if MapPrintInSameWindow is TRUE
MapPrintInSameWindow If set to TRUE, print preview occurs in the map window instead of in a separate window.
MapSingleWindow If set to TRUE, on mobile devices a single window is used to display floor plan and details pages, the latter including a Back button. Otherwise, each plan is opened in a new window to prevent use of the browser Back function, and details pages include a Close button.
MapSiteSelector If set to TRUE the Plans dialog presents site selection as a pulldown (more suitable for a larger number of sites), otherwise as a set of buttons.
MapBuildingFloorSelector If set to TRUE the Building dialog Floor Plan... button displays the floors for selection, instead of selecting the default floor.
MapWheelZoomReverse If set to TRUE mousewheel zoom will operate in the reverse sense.
MapWindowNames The names of the following windows, as an optional space separated list of values. These may be present as frames in a custom layout, otherwise popup windows are used.
  • Room details page (default RoomWindow)
  • Custom page specified by MapLinkUrl (default CustomWindow)
  • Selected items page specified by MapItemLinkUrl (default SelectedItemsWindow)
  • Item pages specified by their LinkAttribute attribute (default ItemWindow)
  • Asset details page (default AssetWindow)
  • Icon move page - not currently used (default IconMoveWindow)
  • Site details page (default SiteWindow)
  • Building details page (default BuildingWindow)
  • Floor details page (default FloorWindow)
  • Room cleaning schedule page (default RoomCleaningWindow)
  • People Manager show plan page (default PersonMapWindow)
  • Person details page (default PersonWindow)
  • BIM properties page (default BIMWindow)
  • Project details page (default ProjectWindow)
  • Dashboard page (default DashboardWindow)
Colours
MapColourBIMSelected Colour of BIM items when selected, default FF0000. Selected Space items are coloured according to MapColourRoomSelected.
MapColourBuilding Colour of building items, default 808080.
MapColourBuildingLabel Colour of building labels, default 000000.
MapColourBuildingLabelBack Colour of building labels background, default none.
MapColourBuildingSelected Colour of building items when selected, default A0A0FF.
MapColourLink Colour of link items, default BB8888.
MapColourPointLabel Colour of point labels, if not defined point labelling is not available.
MapColourPointLabelBack Colour of point labels background, default none.
MapColourRoom Colour of room items, default FFFFDD.
MapColourRoomLabel Colour of room labels, default 006600.
MapColourRoomLabelBack Colour of room labels background, default none.
MapColourRoomSelected Colour of room items when selected, default C0C0FF.
MapColourRoomTrial Colour of room trial items, default FFFFDD.
MapColourRoomTrialLabel Colour of room trial labels, default 006600.
MapColourRoomTrialLabelBack Colour of room trial labels background, default none.
MapColourRoomTrialSelected Colour of room trial items when selected, default C0C0FF.
MapSiteFootprintColour Colour of site footprint colour theme, as hexadecimal RRGGBB. Optional, default 666666 (grey). If floor plan colour themes are defined for bu_id,dv_id,dp_id then the corresponding colour from these is used instead, otherwise the tables bu,dv,dp hpattern_acad values if these exist.
MapColourPalette The colours to display in colour selectors, as a comma-separated list of hexadecimal RRGGBB values. Use an empty value to specify 'no colour' (red diagonal). A multiple of 7 values is recommended. Optional, default 000000,333333,666666,999999,CCCCCC,FFFFFF,,800000,804000,808000,008000,008080,000080,800080,FF0000,FF8000,FFFF00,00FF00,00FFFF,0000FF,FF00FF,FF8080,FFC040,FFFF80,80FF80,80FFFF,8080FF,FF80FF,FFC0C0,FFEBC0,FFFFC0,C0FFC0,C0FFFF,C0C0FF,FFC0FF.
MapHatchPalette The hatch patterns to display in hatch pattern selectors, as a comma-separated list of pattern IDs in the custom file mapEnquiry\hpattern.svg. Use an empty value to specify 'no hatch' (red diagonal). A multiple of 7 values is recommended. Optional, if undefined the Draw dialog Fill hatch selector is not shown.
Layers
MapFloorLayerPointView​N (where N=1,2,3...) List of floor plan View Points layers for which specified SQL replaces the View Points table, each specifying the following '|' separated values:
  1. The layer name.
  2. The SQL replacing the View Points table. This must supply the same field names as the original View Points columns, plus any others used in its where clause. Note that the View Points parameters may only specify a single table.
 
MapLayerAlias​N (where N=1,2,3...) Layers to rename or exclude. Values take the form layer name = alias where spaces before or after either name are ignored. If a layer name does not match any layer name its name is unchanged. If alias is omitted (and optionally also the = symbol) that layer is excluded.
 
MapLayerColour​N (where N=1,2,3...) List of layer colours to override those created by the Map Compiler, specified as the colour and layer name separated by one space.
 
MapLayerLink​N (where N=1,2,3...) Layers to be processed as 'other link' layers. Values are as modified using MapLayerAlias settings. Each may contain point, line and area items.
 
MapLayerMenuOmit A comma separated list of layer names to be excluded from the Features menu.
 
MapOgcWmsUrl The URL of an Open Geospatial Consortium (OGC) Web Map Service (WMS) to use for Map Enquiry layers that have been compiled from OGC WMS map overlays (see Map Compiler for details). Its BBOX, WIDTH and HEIGHT querystring parameters must be present, and may have any values suitable for testing. To obtain this URL, display a representative image from the required Web Map Server using a web browser, then if necessary view the source of the page to obtain the URL of the image itself. See also setting MapLayerOgcWms.
MapOgcWmsMaxPixels Image properties, as a space-separated list of
  1. The maximum image size supported by the Web Map Server in pixels, default 2880.
  2. The image opacity, in range 0 to 1 or 0% to 100%. Optional, default 1.
See also setting MapLayerOgcWms.
 
MapLayerOgcWms​N (where N=1,2,3...) Layers to be processed as Open Geospatial Consortium (OGC) Web Map Service (WMS) layers. Such layers should be compiled from Cadcorp OGC WMS overlays. If this setting is not present for such overlays, settings MapOgcWmsUrl and MapOgcWmsMaxPixels are used instead. The following three comma-separated values are required:
  1. Layer name (as modified using MapLayerAlias settings).
  2. Image properties, as a space-separated list of
    1. The maximum image size supported by the Web Map Server in pixels, default 2880.
    2. The image opacity, in range 0 to 1 or 0% to 100%. Optional, default 1.
  3. The URL to get a map image. This should be equivalent to that used for the Cadcorp OGC WMS overlay (Cadcorp does not provide an API method that Map Compiler can use to obtain this, hence its duplication here). Its BBOX, WIDTH and HEIGHT querystring parameters must be present, and may have any values suitable for testing. To obtain this URL, display a representative image from the required Web Map Server using a web browser, then if necessary view the source of the page to obtain the URL of the image itself.
 
MapLayerOgcWmts​N (where N=1,2,3...) Layers to be processed as Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS) layers, and other tiled map suppliers. Such layers should be compiled from Cadcorp OGC WMTS overlays.The following three or six comma-separated values are required:
  1. Layer name (as modified using MapLayerAlias settings).
  2. The layer opacity, in range 0 to 1 or 0% to 100%. Optional, default 1.
  3. The layer supplier, one of:
    • OSM - OpenStreetMap.
    • Wiki - Wikimedia Maps.
    • GoogleMaps - Google Maps.
    • GoogleSatellite - Google Satellite.
    • GoogleSatelliteHybrid - Google Satellite Hybrid.
    • GoogleTerrain - Google Terrain.
    • GoogleTerrainHybrid - Google Terrain Hybrid.
    • GoogleRoads - Google Roads.
    • EsriNationalGeographic - ESRI NatGeo World Map.
    • EsriWorldOceanBase - ESRI World Ocean Base.
    • EsriWorldImagery - ESRI World Imagery.
    • WMTS - another supplier (when the following further values are required).
  4. The EPSG code specifying the coordinate reference system of the data supplied.
  5. The layer name in the data supplied.
  6. The URL of the capabilities of the data supplied, as an XML document.
  7. Supplier attribution text (optional).
NOTE: Ensure that map service providers' terms of use are complied with.
 
MapLayerPoint​N (where N=1,2,3...) Layers to be processed as point layers. The layer name is required, and the following additional comma-separated values may be supplied: the key and description column names, and default values for table columns if these are undefined or do not exist (see Map Compiler - Cadcorp Data):
  1. Layer name (as modified using MapLayerAlias settings). The layer should be compiled from a Cadcorp View Points overlay.
  2. Key column name, default id. The layer may be edited if this column exists, and a single View Points table is used, according to its data type:
    • if integer, the Edit dialog displays its value read-only, and the next highest value is used when saving new items.
    • otherwise, the Edit dialog displays its value for editing, and this is tested for uniqueness when saving.
  3. Description column name, default description.
  4. scale - point icon scale, default constant icon size.
  5. angle - point icon angle (clockwise degrees from horizontal), default 0.
  6. icon - point icon file name, default Pin.gif.
  7. link - point icon hyperlink URI, default none. This may include placeholders $$column$$, where column is the name of a column in the table, to include its value in the URI.
  8. description - point description, shown in point dialog by default, found by Local Search.
  9. Point label alignment:
    • OVER - place label over the point icon.
    • otherwise - place label above the point icon.
 
MapLayerNetwork​N (where N=1,2,3...) Layers to be processed as network layers, each specifying the following seven comma-separated values:
  1. Layer name (as modified using MapLayerAlias settings). The layer must also be present in MapLayerPoint settings.
  2. Node table name. Must be the layer's View Points dataset table, and may have additional attribute fields.
  3. Link table name. Must have fields id,node_id1,node_id2, and may have additional attribute fields.
  4. Cable table name. Must have field id, and may have additional attribute fields.
  5. Cable links table name. Must have fields id,link_id.
  6. Circuit table name. Must have field id, and may have additional attribute fields.
  7. Circuit cables table name. Must have fields id,cable_id,core_a,core_b.
  8. Circuit splice table name. Must have fields node_id,cable_id1,core_a1,core_b1,cable_id2,core_a2,core_b2.

Table sisfm_tbls is used to define alternative terms for Node, Link, Cable and Circuit (e.g. Pit, Duct, Pipe).

NOTE that this type of layer is experimental, and that its tables must be populated manually.

An different approach is the use of Node and Link item topology in an 'other links' layer.

Icons
MapIconRescaleFactor A scale factor to apply to settings MapIconScale and MapIconScaleFactor. Optional, default 1.
MapIconScale The scale factor for non-scalable map icons. Optional, default 1.
MapIconScaleFactor The scale factor for scalable map icons. Optional, default 1.
Links
MapItemLinkDesc The description of the page to be launched by the Draw dialog Item Link button, shown as the button tooltip.
MapItemLinkUrl The URL of the page to be launched by the Draw dialog Item Link button (not shown if not defined). The following values are sent to the page, each a comma-separated list for items selected using the drawing Select tool:
typethe item type: 1=building 2=room 3=other
linkthe item link: the location code of a building or room, or the link URI for other items
colourthe item colour on the map, as hexadecimal RRGGBB for selected items and 0xRRGGBB for themed items.
MapItemLinkPost If set to TRUE, Draw dialog Item Link values are posted to the page as if from a form, otherwise they are appended to the page URL as querystring parameters. In the latter case, the URL should end with either "?" or "&".
MapLinkDesc The description of the page to be launched by the Custom Link button in the main toolbar, shown in the Custom Link dialog. If not defined this button is not shown.
MapLinkFloorPlan If set to FALSE buildings are not linked to their floor plans. FALSE overrides the MapClickBuilding access security function.
MapLinkRoomDetails If set to FALSE rooms are not linked to their details pages. FALSE overrides the MapClickRoom access security function.
MapLinkUrl The URL of the page to be launched by the Custom Link button in the main toolbar. If not defined this button is not shown. The URL should end with either "?" or "&" after which the following querystring values will be added:
loc_codethe location code of a room on a floor plan, or of the lowest building floor on a site plan, or of the floor plan or site when elsewhere on the plan.
lat
lon
the approximate latitude and longitude in degrees of the position used to select the room or building, if MapGPSUnit is set to LatLonDeg, otherwise
e
n
the easting and northing.
Themes
MapTheme​N (where N=1,2,3...) List of Map Enquiry standard themes and tooltip fields, each specifying the following comma-separated values:
  1. Type, one of:
    tipfor a tooltip field.
    labelfor a Label theme.
    colourfor a Colour theme.
  2. Field name:
    • any field in the rm table, to specify room themes on floor plans.
    • any field in the bl table, prefixed by bl., to specify building themes on site plans.
    • any field in a View Points table, prefixed by its table name, to specify point themes on site or floor plans:
      • field values may include the | delimiter to display them on multiple lines. An example is a field of occupants for a room zone. When using SQL Server, such fields can be specified based on the following self-contained example:
        SELECT TOP 1 STUFF((SELECT '|' + RTRIM(bu_id) FROM bu FOR XML PATH ('')), 1, 1, '') AS bu_id_list FROM bu
      • for tip, if no fields are specified, all attribute fields of the table are included, with field name as description.
      • for label, field name icon specifies the point icons themselves, to allow them to be turned off when other labels are present.
      • for colour, the label background is themed for View Points layers.
    • for the label and colour types, the name of an 'other links' layer, followed by ., followed by the name of a field in the layer's SVG elements (such as description).
    • a field calculation, of the form (<expression>) AS <table>.<alias> where:
      • expression - is an SQL expression which is valid for the table in SQL SELECT and ORDER BY clauses for the database in use. NOTE that SQL errors will be issued if the expression is invalid.
      • table - is the name of the table.
      • alias - is any valid SQL field alias name which does not conflict with feature field names in this table.
    The following special field name values are available:
    bl.idfor building number.
    bl.areafor building area (the field defined by BlAreaField).
    idfor room number.
    bu_idfor room business unit.
    capacityfor room capacity (rm.RoomCapacityField if People Manager is not enabled).
    occupantsfor room occupants (symbol label theme).
    occupantlistfor room occupants (text label theme).
    vacanciesfor room vacancies (the difference between rm.RoomCapacityField and the number of occupants). Not used if People Manager is enabled.
    em.field:colourfor flagged room occupants, e.g. fire wardens (symbol label theme) where:.
    fieldis the name of a field in table em containing 'Y' to flag that occupant.
    colouris one of Red Green Blue for the colour of the flag symbols. If the colour is Red then fire hose reel icons are also displayed for any unoccupied rooms with names containing fire (such as Main Fire Cupboard).
    link_table:fieldto colour theme network links using table link_table (see MapLayerNetwork).
  3. Field description, required for themes, optional for tooltip.
  4. Cost lookup table name. Optional and only used by colour themes. The name of a database table with two fields:
    • Field containing theme values, with the same name as the field being themed.
    • Field containing the $/m² cost for theme values, with the cost lookup field name.
  5. Cost lookup field name. Optional, if omitted the name of the cost lookup table is used.
 
MapThemeAdvanced If set to NONE advanced themes are not available, if set to AFMHEADINGS the field headings in sisfm_flds.ml_heading are displayed if they exist, instead of the field names.
MapThemeAlpha The transparency of building, room and theme colours, as a number in the range 0 to 100 where 100 means solid. Optional, default 100.
MapColourThemeSite The field name of a colour theme to initially display in site plans. Must be one from the colour MapTheme settings. Optional.
MapThemeExcludeRoom An SQL WHERE clause (e.g. rm.rm_cat<>'WKSTNS') to restrict the rooms that are included in theme data. This setting provides a partial work round when the Archibus Occupancy module is implemented, to exclude its workstations which are stored in the rm table. It should not otherwise be used.
Legend
MapLegend​N (where N=1,2,3...) List of Map Enquiry theme colours, each specifying the following comma-separated values:
  1. Themed field name, as specified by a MapTheme setting.
  2. Themed field value, or value range:
    • Value - a single expected item value. Note that rm_type values are expressed as rm.rm_cat|rm.rm_type (e.g. 6|601). Optional if MapLegendColours is set to AFM.
    • Value range - a range enclosing expected item values, specified as minimum and maximum values separated by a tilda (~). Either value can be omitted to specify an open ended condition. Range values can be numeric or non-numeric. Item and range values are compared as numbers if both are numeric, otherwise as strings. Comparisons use greater than on the minimum, and less than or equal to on the maximum range value. The order of legend entries is obtained by sorting these values as strings, left-padding minimum values with zeros if necessary.
  3. Colour for this field value, as hexadecimal RRGGBB. The default theme colour for unspecified field values is 666666. Optional if MapLegendColours is set to AFM.
  4. Description of this field value. Optional. For fields rm_cat, rm_type, bu_id, dv_id, dp_id the description overrides the description obtained from the facility database. For other fields the description overrides the field value.
 
MapLegendColours If set to AFM or AFM2 then MapLegend* settings are interpreted as follows:
  • if colours are omitted, the Archibus colours in field hpattern_acad of the applicable table (bl,rm,rmcat,rmtype,bu,dv,dp or any Archibus field validation table) are used if this field exists.
  • if AFM2 is specified, hpattern_acad values are interpreted as BGR instead of RGB, to suit this change made by Archibus in Web Central.
  • if values are also omitted, the values present in the database are used.
MapLegendColoursUndefined Space separated list of hexadecimal RRGGBB colours to use in rotation for colour themes with no colours defined, for Advanced colour theming, and for colouring disjoint sections of network topology.
MapLegendEdit If set to TRUE legend entry colours and descriptions can be edited.
 
MapLegendPoint​N (where N=1,2,3...) List of Map Enquiry point legend entries. If there are no entries, point legends are not displayed. If there is no entry for a map icon, its file name is used as its description. Each entry specifies the following | separated values:
  1. Map icon name, relative to the folder specified by the DataFolderMapIcon setting.
  2. Description to appear in the point legend.
 
MapLegendStatistics If set to TRUE, legends include the item count and area for each entry.
MapLegendTotals If set to TRUE legends with more than one entry include a totals entry.
MapLegendValuesUndefined The colour to use, as hexadecimal RRGGBB, when the value of a field being themed is undefined. Optional, default 666666.
Labels
MapLabelHeight The point size of map labels, default 8.
MapLabelAlignment The vertical alignment of building and room labels relative to the Cadcorp polygon seed position, one of:
  • LABEL - the label is centred (the default)
  • ICON - the icon is centred
  • BOTH - the icon is above and the label is below
MapLabelMinimumArea The minimum area in sq.m. of rooms (or buildings) for which map labels will be shown. Optional, if not a positive number all will be shown.
MapLabelOmit If set to TRUE labels are omitted if their width exceeds the item. For building and room polygons, this is the extents width; for 'other links' items, the length of the longest line segment; point items are not affected.
MapLabelBuilding An optional comma separated list of MapTheme label fields for initial building labels.
MapLabelRoom An optional comma separated list of MapTheme label fields for initial room labels.
MapMaxLabelChars The maximum number of label characters to display in the current view (an approximate calculation) at the specified MapLabelHeight. When more than this, label size is reduced. Optional, if not a positive number all labels are shown at the specified size.
3D
MapBuildingRoofs Describes how to display building roofs in 3-D isometric views of sites, as SVG styles. No roofs are displayed if not defined, or if walls are not displayed.
MapBuildingWalls Describes how to display building walls in 3-D isometric views of sites, as the following space-separated values:
  1. The height of walls (per storey), in metres. Optional, walls are not displayed if the setting is not defined.
  2. The SVG styles for walls. Optional, default stroke:#666666;stroke-width:0.05px;fill:#666666;fill-opacity:0.2.
MapRoomRoofs Describes how to display room ceilings in 3-D isometric views of sites, as SVG styles. No ceilings are displayed if not defined, or if walls are not displayed.
MapRoomWalls Describes how to display room walls in 3-D isometric views of floors, as the following space-separated values:
  1. The height of walls, in metres. Optional, walls are not displayed if the setting is not defined.
  2. The SVG styles for walls. Optional, default stroke:#666666;stroke-width:0.05px;fill:#666666;fill-opacity:0.2.
Find Way
MapWayFinder If set to TRUE way finding is enabled, and the Way Finder server will be accessed while loading plans.
NOTE that if set to TRUE there will be a delay loading plans if the Way Finder server is not running.
MapWaySelectPlaceBySearch If set to TRUE, Find Way places are selected by search instead of by pulldown.
 
MapRouteDestMargin The distance from way finder route destinations within which the user receives an audible alert, in metres. Optional, if not a positive number alerts are not issued.
MapRoutePathColour A space separated list of way finder route path line colours, as hexadecimal RRGGBB. Optional, default FF00FF (magenta). On site plans, path segments ending in floor plans at offsets +1 and -1 use the second colour in the list, and so on, modulo list length.
MapRoutePathHighlight The way finder route path line segment highlight colour, as hexadecimal RRGGBB. Optional, default FF0000 (red).
MapRoutePathHighlightOver If set to TRUE, route path line segment highlights are shown over the route path line, otherwise under it.
MapRoutePathWidth The width of way finder route path lines, as a factor. Optional, default 1.
MapRouteSegmentZoom The zoom scale factor for viewing way finder route segments; the zoom extent is the segment extent times this value. Optional, default 2. No zoom occurs if the value is 0.
MapRouteSegmentZoomMax The maximum zoom for viewing way finder routes and their segments, expressed as the minimum view width and height in metres. Optional, if omitted no check is made.
Print
MapCompileDate If set to TRUE the map compilation date is included in the map title.
MapTitleFormatSite Format of the title on site plans, with placeholders $$site_name$$, $$compiled$$ for site name, compiled date. Optional, the default is $$site_name$$, $$compiled$$.
MapTitleFormatFloor Format of the title on floor plans, with placeholders $$site_name$$, $$site_facility_type$$, $$build_no$$, $$bl_name$$, $$fl_id$$, $$fl_label$$, $$fl_name$$, $$compiled$$ for site name, building no, building name, floor ID, floor label, floor name, compiled date. Plans must be compiled using the Map Compiler BuildingName setting to include building name. Optional, the default is $$site_name$$, $$site_facility_type$$ $$build_no$$, Level $$fl_id$$, $$compiled$$.
 
MapPrintScaleList Comma separated list of print scales, as increasing integers (e.g. 100,200,500,1000,2000,5000). Prints will be created at the largest of these scales that fits the content within the print photo area for the selected printer, otherwise the scale that fits the content is used.
 
MapPrintName Print template names, separated by '|'. Optional. If more than one name is specified, each of the following MapPrint settings must have the same number of values separated by '|' corresponding to each template. The '|' separator can be preceded and followed by spaces to assist readability.
MapPrintSize The size of the map print, as a comma separated list of width and height, default 297,210. Units (referred to below as print units) are arbitrary, but millimeters are recommended (see MapPrintScaleFactor).
MapPrintScaleFactor Scale factor to convert print units to millimetres, default 1. Affects the scale shown on prints.
MapPrintDate The position of the top left of the print date text, in map print units relative to the bottom left of the print, as a comma separated list of X,Y, default 200,25.
MapPrintDateSize The size of the print date text, as a scale factor, default 0.3. If zero, the print date is omitted.
MapPrintPhoto The rectangular area in which the current view is printed, in map print units relative to the bottom left of the print, as a comma separated list of bottom left X,Y then top right X,Y, default 16,40,281,190.
MapPrintScale The position of the top left of the print scale, in map print units relative to the bottom left of the print, as a comma separated list of X,Y, default 200,30.
MapPrintScaleSize The size of the print scale text, as a scale factor, default 1. If zero, the print scale is omitted.
MapPrintScaleBar The position of the top left of the print scale bar, in map print units relative to the bottom left of the print, as a comma separated list of X,Y, default 200,30.
MapPrintScaleBarSize The size of the print scale bar text, as a scale factor, default 0. If 0, the print scale bar is omitted.
MapPrintTitle The position of the top left of the print title, in map print units relative to the bottom left of the print, as a comma separated list of X,Y, default 155,30.
MapPrintTitleSize The size of the print title, as a scale factor, default 0.3. If zero, the print title is omitted.
MapPrintTitleSplit If set to TRUE the comma separators of the print title are converted to new lines to obtain a multi-line title.
MapPrintDialogScale The default size of the last used dialog (e.g. Legend) in the print, as a scale factor, default 1.
 
MapPrintField​N (where N=1,2,3...) List of Map Enquiry print title fields, each specifying the following comma-separated values:
  1. The X position of the top left of the print title field, in map print units relative to the bottom left of the print.
  2. The Y position of the top left of the print title field, in map print units relative to the bottom left of the print.
  3. The size of the print title field, as a scale factor.
  4. A short description of the print title field, to appear in the Print menu.
Report
MapReportBuilding An optional space separated list of MapTheme* fields (without a bl. prefix) to include in reports for buildings, in the order they are to appear. If omitted the building report is not available. A field name followed by an asterisk signifies that this report column will be totalled if all values are numeric.
MapReportRoom An optional space separated list of MapTheme* fields (without a colour suffix for room occupant flag symbol themes) to include in reports for rooms, in the order they are to appear. If omitted the room report is not available. A field name followed by an asterisk signifies that this report column will be totalled if all values are numeric.
Search
MapSearch If set to FALSE the search tools are not shown. FALSE overrides the MapSearch access security function.
 
MapSearchAdvanced​N (where N=1,2,3...) Optional list Of advanced search options To include In the Search dialog, each specifying the following comma-separated values:
  1. A title for the search.
  2. An advanced search string, to which entered search text will be appended. This may include placeholders $$site$$, $$building$$ and $$floor$$, which will be replaced by site, building and floor search clauses matching the currently displayed plan. Use an empty value to allow a complete advanced search string to be entered (when the comma may be omitted).
 
MapSearchAdvancedDefault If set to TRUE, the default search option is the complete advanced search setting, if this is defined.
MapSearchOmitStaff If set to TRUE room occupants are not included in search results.
MapSearchPredictive If set to TRUE the Search dialog initially displays no features instead of all features.
MapSearchResultItemMaxTextLen The maximum text length to display in search result entries. Longer text is truncated to end with an ellipsis. Optional, no limit if omitted.
Miscellaneous
MapBrowserCheck If set to TRUE a warning is issued if the browser is not Edge, Chrome or Firefox.
MapFloorsNotGeoreferenced If set to TRUE the compass is not shown on floor plans, and the MapGPSUnit setting is ignored.
MapFloorsNotAligned If set to TRUE, floor plans for the same building may be in different coordinate systems (however, moving between them does not retain the current pan, zoom and rotation).
MapDatasetFolder The URL of a folder under which all map dataset files are stored, corresponding to the physical folder defined by the Map Compiler MapDatasetFolder setting. Optional, if not defined the Layer download button is not displayed.
MapDisableZoomAnimation If set to TRUE, zoom animation is disabled (this has been found to cause issues on older devices).
MapDrawExtentsFactor The size of the area available for drawing, relative to plan size. Minimum 1, default 2 (i.e. 4 times the plan area). Larger sizes are known to cause iOS browser malfunctions.
MapDrawMeasurement If set to TRUE, in the Draw dialog Measurement text is yes by default.
MapDrawMode The initial Draw dialog mode. Optional, default Freehand.
MapEditUploadSimple If set to TRUE, the Edit dialog does not include the photo/document name and description fields.
MapFormat The graphics file format to use:
SVGScaleable Vector Graphics format. Recommended for diagnostic use.
SVGZGZIP compressed SVG format. Recommended for production use.
MapGPSUnit If set to LatLonDeg point coordinates are shown as latitude and longitude degrees, otherwise as easting and northing.
NOTE that latitude and longitude are approximate values only. They are calculated using linear interpolation from the homeLatLon attribute of the map element of map XML files.
MapGpsAnimationOff If set to TRUE the GPS location icon is not animated on iOS devices (which causes issues in some iOS versions).
MapNoWebStorage If set to TRUE Web Storage is not used to remember settings between sessions (refer to Map Enquiry for details). Not TRUE overrides the MapNoWebStorage access security function.
MapRoomZoneLayer The name of the floor plan room zone locations layer, default Room Zones. When updating a zone location, this layer is refreshed if it exists, otherwise the floor plan is reloaded.
MapRoomZonePersonFields Optional space-separated list of fields in table em, plus optional punctuation other than the _ character, to display for people in the advanced room zone dialog. Example: em_id name_last, name_first (dp_name). If the first and last name fields specified by the EmNameFields setting are not both present, they are added at the beginning. The following special field values are available:
  • dp_name - the person's department name (dp.name).
  • email_name - the person's email address (em.email) omitting @domain.
MapSvgEnlargement Factor by which to enlarge SVG documents for iOS devices. Optional, default 1. The iOS (WebKit) platform renders SVG as if it is an image, instead of as scalable graphics, therefore it becomes blurred when zoomed in. Increase this setting to reduce this effect. NOTE that to avoid WebKit errors, a high value (such as 10) should not be used, and a low value (such as 2) is required to use WMTS layers.
 
Room Bookings Module
BookManager The email address of the manager of the Room Bookings module, used:
  • as the from address for emails sent by this module.
  • as the approver if no approvers were found for a booking.
  • for requesting room approval access.
BookBcc The email address to BCC each email sent by the Room Bookings module.
BookCMISModuleUrl The URL which, when a CMIS timetable database module ID is appended, will display details for that module. Accessed from timetable links. Optional.
BookCELCATRoomKeyField The name of a field in table rm containing the CELCAT timetable database room ID. Required if a CELCAT database is in use.
BookAutoNumber If set to TRUE the book_index.ID field is assumed to be the autonumber data type.
BookTimetableLink​N (where N=1,2,3...) Optional list of links to external timetable resources, to display in the timetable page, each with the following comma-separated values:
  1. The link button caption.
  2. The link condition field: an optional table rm field name:
    • name undefined or field absent: the link will be displayed for all rooms.
    • field value Y: the link will be displayed for this room.
    • field value NT: the link will be displayed for this room, and the room timetable will not be displayed (regardless of other BookTimetableLink settings).
    • other field value: the link will not be displayed for this room.
  3. The link URL, which may include the following placeholders:
    • $$YYYY$$ - the current year.
    • $$LOC_CODE$$ - the room location code.
    • $$LOCATION$$ - the room code, as bl_id.fl_id.rm_id.
    • $$LOCATION2$$ - the room code, as site_id-bl_id.fl_id.rm_id.
    • $$SITE_ID$$ - the site code.
    • $$BL_ID$$ - the building code.
    • $$FL_ID$$ - the floor code.
    • $$RM_ID$$ - the room code.
    • $$DATE_TODAY$$ - the current date, as yyyy-MM-dd.
    • $$DATE_LAST_MONDAY$$ - Monday last week, as yyyy-MM-dd.
    • $$DATE_LAST_FRIDAY$$ - Friday last week, as yyyy-MM-dd.
BookMaxHrsTotalStudent The maximum number of hours per day for which any student may book any number of rooms with rm.book_max_hrs_total_student set True
Asset Bookings Module
AssetBookManager The email address of the manager of the Asset Bookings module, used:
  • as the from address for emails sent by this module.
  • as the approver if no approvers were found for a booking.
  • for requesting asset approval access.
AssetBookBcc The email address to BCC each email sent by the Asset Bookings module.
AssetBookAutoNumber If set to TRUE the em_book_index.ID field is assumed to be the autonumber data type.
AssetBookEnabledField The name of the table eq field with value 'Y' to enable asset booking. Default bookable.
AssetBookCSI The Construction Specifications Institute standard (field csi.csi_std) to use for asset selection in the Asset List page. Default OmniClass.
Move Manager Module
MoveManager The email address of the manager of the Move Manager module, used:
  • as the from address for emails sent by this module.
MoveAdmin Comma separated list of email addresses of Move Manager administrators, used:
  • to distinguish between Administrator and Business Unit move initiators.
MoveBcc The email address to BCC each email sent by the Move Manager module.
MovePhones The email address for notification of phone changes by the Move Manager module.
MoveTitle The title of the module, used in page titles and in the information PDF file name. Optional, default "Move Manager".
MoveAdminName The name of the module administration group. Optional, default "Planning and Development".
MoveCCProjectChars The width of the cost centre project field used by the Move Manager module.
MoveCCCostCtrChars The width of the cost centre cost code field used by the Move Manager module.
MoveNewStaffDummyID A dummy staff ID which the user is invited to enter for new staff whose IDs have not yet been allocated. Optional.
MoveNewStaffJobID The job ID (field em.em_job) for new staff. Optional, default 1.
MoveAdminNotesWarning The text of a warning that can be added to the Admin Notes field on the move details page. Optional, if omitted the command to add the warning is not displayed.
MoveTextKeyRequired The text to specify the Key Required heading. Optional, default "Key Required".
MoveTextNewExt The text to specify the New Ext field label. Optional, default "New Ext. (if known)".
MoveProgressBar If set to TRUE a progress bar is displayed while creating a new move.
MoveOmitPortNo If set to TRUE the Port No column is not displayed.
MoveMethodCostCentre A number specifying the Cost Centre page, default 1:
  • 1 - the user specifies Project and Cost Centre, and the approver is obtained using SELECT dp_fin_bum_email FROM dp WHERE dp_fin_id_new LIKE '%CostCentre%'
  • 2 - the Cost Centre is the Division ID dv.dv_id and the approver is obtained using SELECT head_email FROM dv WHERE dv_id='CostCentre'
MoveMethodEquipment A number specifying the Equipment page, default 1:
  • 1 - text specifying PC/fax/printer details.
  • 2 - a table of equipment with tag, description, from and to location fields.
MoveMethodRemovalist A number specifying the Removalist page, default 1:
  • 1 - text specifying removalist details.
  • 2 - fields for removalist required, number of boxes, delivery date, description.
MoveOmitExtUpdate If set to TRUE the Update Archibus function does not update field em.extension (e.g. because this field is already synchronised with a telephone database).
MoveOmitGroupEmailValid If set to TRUE the email addresses specified for email groups are not validated (e.g. this permits the use of group email addresses).
MovePortNoHelp Text to replace the Port No help text. Optional.
MoveNotesHeading Text to replace the staff notes heading. Optional.
Report Maker Module
ReportSelectMax The maximum number of distinct values of database fields to display in pulldown selectors when displaying AVW report field restrictions, beyond which a text entry box is displayed instead. Optional, default 100.
ReportOmitSpacerColumns If set to TRUE, report columns have right padding and spacer columns are omitted.
Maintenance Module
MaintModule If set to TRUE the Maintenance module is available.
MaintManager The email address of the manager of the Maintenance, used:
  • as the from address for emails sent by this module.
MaintFieldsRequired A space-separated list of fields in table work_request that are required when Completing a request. Recognised fields are cause_type repair_type cf_notes cost_labour cost_parts cost_other.
MaintHolidays A space-separated list of holiday dates as dd/MM/yyyy used when calculating estimated finish dates from start dates and time periods in days.
MaintViewRequest The name of a database view for obtaining additional values for use in email notifications and elsewhere. Optional, default table work_request. A view may be used to obtain additional fields, such as a building address.
 
MaintDashboardCharts The Google Charts to display on the Dashboard page, as a space-separated list of indexes to the ChartOptions and ChartData settings. Optional, if not specified the Dashboard function is not available.

Note that the chart SQL must include both a table alias CHART_TABLE and a WHERE 1=1 placeholder for adding site, building, floor, room restrictions

MaintDashboardChartsAll The Google Charts to display on the Dashboard page for All sites. Overrides MaintDashboardCharts if specified.
MaintDashboardChartsSite The Google Charts to display on the Dashboard page for a site. Overrides MaintDashboardCharts if specified.
MaintDashboardChartsBuilding The Google Charts to display on the Dashboard page for a building. Overrides MaintDashboardCharts if specified.
MaintDashboardChartsFloor The Google Charts to display on the Dashboard page for a floor. Overrides MaintDashboardCharts if specified.
MaintDashboardChartsRoom The Google Charts to display on the Dashboard page for a room. Overrides MaintDashboardCharts if specified.
 
MaintNotifyAttachPdf The path to Google Chrome, used to generate the PDF file to attach to emails to assigned tradespeople / contractors when the Issue action occurs. Optional, if not defined PDF files are not attached.
MaintColourWROverdue The colour as hexadecimal RRGGBB of row text in the Work Request table for those whose estimated date for completion (work_request.date_est_completion) has been passed.
MaintColourWSProcesses The colour as hexadecimal RRGGBB of row text in the Work Processes / Generate Work Schedules 'For' table for those with Processes assigned.
 
MaintTable​N (where N=1,2,3...) List of the columns to initially include when displaying tables, as a space-separated list in which:
  • The first value is the table name (one of work_request work_process work_schedule work_date work_order site bl fl rm eq).
  • Subsequent values are the names of the columns to include (these need not include PK or description columns).
Each user can change the columns included for tables other than work_request (see Database Manager Web Storage).
 
MaintPMEnabled If set to TRUE Preventive Maintenance is available.
MaintPMWorkRequestFlow The value for field work_request.work_flow_id for Work Requests generated by Preventive Maintenance.
MaintPMWorkRequestProblemType The value for field work_request.work_problem_type_id for Work Requests generated by Preventive Maintenance.
MaintPMWorkRequestPriority The value for field work_request.work_priority_id for Work Requests generated by Preventive Maintenance.
MaintPMWorkRequestLocation The value for field work_request.location for Work Requests generated by Preventive Maintenance, as a comma-separated list of table eq field names, whose values are concatenated with commas.
People Manager Module
PersonModule If set to TRUE the People Manager module is available.
PersonManager The email address of the manager of the People Manager module, used:
  • as the from address for emails sent by this module.
PersonNumberPrefix A prefix Of one Or more alphabetic characters that may optionally be included When entering the Person ID. The prefix Is removed And ignored. Optional.
PersonZoneTerm A replacement For the term "Zone". Should be a Single capitalised word which can be pluralised by adding "s".
PersonPresentTerm A replacement For the term "Present".
PersonRoomZoneAutomatic If Set To True Then room zones are automatically added To equal rm.RoomCapacityField, And the Add/Remove Zone commands are Not available.
PersonNoSpaceField The name Of a Boolean field In table em To signify that a person requires no space. Optional, If defined this Is shown In the reception screen check-In table.
PersonNoSpaceExclude If Set To True Then people whose no space field Is Set are Not included In the reception screen check-In table.
PersonFTEField The name Of a field In table em For the person's Full Time Equivalent factor. An FTE of 1 is used for undefined values of this field. Optional, if not defined person over-allocation checks do not occur.
PersonExtraFields A comma separated list of additional fields in table em to be displayed, maximum 4, or 3 if EmExtraKeyField is specified. Optional.
PersonStartEndFields A comma separated list of the fields in table em used to store the person's commencement and termination dates. Optional, default date_start,date_end.
PersonDepartmentUnused If set to TRUE the department is omitted from the person details header and from the Person and Available Space screens.
PersonSpaceTypeUnused If set to TRUE the room type selectors are omitted from the Available Space screen.
PersonSpaceResults The default Available Space screen results options:
ListShow results as count and List (default)
PlanShow results as count and Plan
BothShow results as count, List and Plan
NoneShow results as count only
PersonPageDisplayWhenComplete If set to TRUE, pages containing room or person details panels are not displayed until these panels are complete and sized.
PersonArchibusMode If set to TRUE the Archibus Workspace Transactions table rmpct is accessed instead of SISfm tables rm_zone and em_schedule, and settings PersonZoneTerm, PersonPresentTerm, PersonRoomZoneAutomatic are not used.
PersonArchibusSync If set to TRUE the Archibus Workspace Transactions table rmpct is updated as well as SISfm tables rm_zone and em_schedule.
PersonTBA If set to TRUE allocation of persons to be advised (TBA) is enabled. Should not be set TRUE if the alternative em.em_type='TBA' is in use
PersonFireWardenField The name of a field in table em containing 'Y' to flag that person as a fire warden. Additional messages occur when the allocations of fire wardens are changed. Optional, if unspecified such messages do not occur.
PersonCheckInLimit The maximum number of people to include in the Reception screen CHECK IN and CHECK OUT tables (which may be further limited by allocation access restriction). Optional, default 1000. Also applies to the Check Out table. It may be necessary to specify this limit during initial allocation of people, it should be removed for normal use.
PersonCheckInShowAll If set to TRUE entries in the CHECK IN and CHECK OUT tables are not checked for allocation access, which can improve Reception screen performance.
 
PersonReportRoomAreaField The name of the table rm field to use in the report for room area. Optional, default area.
PersonReportRoomCapacityField The name of the table rm field to use in the report for room capacity. Optional, default capacity.
 
PersonReportRoomClass​N (where N=1,2,3...) List of room class groups to include in the report, as the following comma-separated values. Optional, if none are specified a single group is shown including the classes in RoomClassOccupant.
  1. The heading colour, as hexadecimal RRGGBB.
  2. The heading text.
  3. Selection criteria as up to two semicolon-separated values:
    1. The room classes to include, as for RoomClassOccupant.
    2. An optional further restriction as an SQL WHERE clause using room table fields (e.g. rm.capacity>0 AND rm.capacity<4).
Workstation Bookings Module
WorkstationBookModule If set to TRUE the Workstation Bookings module is available.
WorkstationBookManager The email address of the manager of the Workstation Booking module, used:
  • as the from address for emails sent by this module.
WorkstationBookLayers A comma separated list of the names of layers to display in floor plans in addition to the MapRoomZoneLayer.
WorkstationBookColourTheme The field name of a colour theme to display in floor plans. Must be one from the colour MapTheme settings, adding the rm. prefix for this table and replacing id by loc_code. Optional, no colour theme is displayed if not defined.
WorkstationBookLabels A comma separated list of names of fields to display as labels in floor plans. Must be one from the label MapTheme settings, adding the rm. prefix for this table and replacing id by loc_code. Optional, no label themes are displayed if not defined.
WorkstationBookTips A comma separated list of names of fields to display in item dialogs in floor plans. Must be one from the tip MapTheme settings, adding the rm. prefix for this table and replacing id by loc_code. Optional, no fields are displayed in item dialogs if not defined.
WorkstationBookPersonFields Optional space-separated list of fields in table em, plus optional punctuation other than the _ character, to display for people in the Workstation Bookings dialog. Example: em_id name_last, name_first (dp_name). If the first and last name fields specified by the EmNameFields setting are not both present, they are added at the beginning. The following special field values are available:
  • dp_name - the person's department name (dp.name).
  • email_name - the person's email address (em.email) omitting @domain.
Map Compiler
MapCompilerGeognoSIS URL to access a Cadcorp GeognoSIS web service for use by the Map Compiler web edition, specifying the server on which the service is running, and the port number to access the service.
 
UploadWebsite URL to access a SISfm website from the Map Compiler desktop edition. If defined, site and floor plans are compiled to local folder %TEMP%\IFM-MapCompiler and then uploaded to the DataFolderMap plan subfolder of this site. Compiling DWG files when DwgDataFolder or DwgViewRotationField are defined is not supported when this setting is defined.
UploadAuthTokenUrl OAuth Access Token URL to use the REST API api/MC for compiling and uploading. Optional, if not defined files are compiled and uploaded using administrator/MC.aspx which is less secure.
NOTE that access token requests include the following parameters which must be supported:
  • grant_type="client_credentials"
  • scope="access_token"
UploadAuthClientId OAuth Client ID. Required if UploadAuthTokenUrl is defined.
UploadAuthClientSecret OAuth Client Secret. Required if UploadAuthTokenUrl is defined.
 
NolFile​N (where N=1,2,3...) Optional list of Cadcorp library (*.nol) files to open, containing non-standard named pens or brushes used.
 
DwgTemplateSwd The URL or physical path of a template SWD file with DWG file overlays defining the styles and filters for SISfm compilation. If not defined, SISfm compilation does not occur.
DwgDataFolder The URL or physical path of the folder containing floor plans as DWG files to be converted to Archibus Web Central DWG files. Optional.
DwgDataFolderAfm The URL or physical path of the folder containing floor plans as Archibus Web Central DWG files. If not defined, the Compile DWG Floor Plans button is not available.
DwgDataFolderAfmFlat If set to TRUE, DWG files are accessed in the folder specified by DwgDataFolderAfm, without site subfolders.
DwgDataFolderAfmSearch If set to TRUE, a search is made for DWG files under the DwgDataFolderAfm folder if they are not found at the expected location.
DwgDataFolderDemo The URL or physical path of the folder containing demo upload floor plans as DWG files. If not defined, demo upload is not available.
DwgDataFolderForOverlay​N (where N=1,2,3...) List of the following comma separated values, to specify supplementary floor plan layers:
  1. Overlay name - the name of the overlay in DwgTemplateSwd.
  2. The physical path of the folder containing floor plans as DWG files, or Windows shortcuts to them, in the usual SISfm subfolder structure.
DwgInsertParams Parameters for the InsertDataset method when reading DWG files, e.g. explodeblockreferences=false.
DwgGrossAreaType The type of gross area polygon to be processed, one of:
  • INTERNAL - one polygon representing internal gross area
  • EXTERNAL - one polygon representing external gross area
  • BOTH - two polygons of smaller and larger area representing internal and external gross areas
  • NONE - gross area polygons are not processed (the default)
DwgGrossAreaLayer The name of the DWG layer containing the gross area polygons, which will be renamed to GROS$. Not required if these items are already in this layer.
DwgRoomAreaLayer The name of the DWG layer containing the room area polygons, which will be renamed to RM$. Not required if these items are already in this layer.
DwgRoomNumberLayer The name of the DWG layer containing the room number text items, which will be renamed to A-ROOM-NO. Not required if these items are already in this layer.
DwgSaveSwd If set to TRUE, floor plan SWD files are saved in the DataFolderSis folder when DWG files are compiled. This allows these SWD files to be modified, and subsequently compiled instead of the DWG files. NOTE that saved SWD files will overwrite existing SWD files.
DwgNameRegularExpression A regular expression matching the names of DWG files to be compiled, containing capture groups (or tagged groups) for use by DwgAddOverlay settings.
DwgViewRotationField The name of a field in table bl which contains the view rotation for its floor plans. Values are in degrees and should be between -180 and 180. If the setting or a field value is undefined, 0 is assumed.
 
DwgAddOverlay​N (where N=1,2,3...) List of additional DWG file overlays, specified using the following colon-separated values:
  1. Overlay colour override, as hexadecimal RRGGBB. In addition, a Blank brush override is applied.
  2. Overlay name, and also the name of an overlay Filter if this exists.
  3. DWG file path, relative to the DWG file being compiled, containing DwgNameRegularExpression replacement parameters.

Example to add ...\A\01B201-A-FP0301.dwg as overlay Base Plan at position 1 when compiling ...\SO\01B201-SOPL0301.dwg:

DwgNameRegularExpression: ([^-]*)-SOPL(.*)
DwgAddOverlay1: 000000:Base Plan:..\A\$1-A-FP$2

 
OverlayExclude A comma-separated list of the names of any SWD overlays that are to be excluded from compilation. Spaces are removed from overlay names before comparison, which is not case sensitive. For radio button (option) overlays, include the part before the "..".
OverlayLinks A comma-separated list of the names of SWD overlays that are to be compiled as building, room or other links. Spaces are removed from overlay names before comparison, which is not case sensitive. For radio button (option) overlays, include the part before the "..".
 
OverlayRoomAreas A comma-separated list of the names of SWD overlays that are to be used to update rm.area in the database. Spaces are removed from overlay names before comparison, which is not case sensitive.
OverlayRoomLocCodes A comma-separated list of the names of SWD overlays that are to be used to update rm.loc_code in the database. Spaces are removed from overlay names before comparison, which is not case sensitive.
OverlayFloorGrossAreas A comma-separated list of the names of SWD overlays that are to be used to update fl.area_gross_int in the database. If the overlay contains two Polygon items, that with the larger area is used to update fl.area_gross_ext. Spaces are removed from the overlay name before comparison, which is not case sensitive.
 
ItemExcludeExtentsFactor The factor by which to enlarge the home extents of plans, to define a rectangular spatial filter to exclude distant items that it does not contain. Such items are assumed to be pathological, and are common in DWG data. Optional, default 100, use 0 to disable this function.
 
ExplodeShapes If set to TRUE, point item symbols (_shape$) are exploded for overlays compiled into SVG files, provided the point symbol is scaleable (as defined by overlay property _pointScaleOverride# and item property _scale#).
 
ExportSVG If set to TRUE, Scaleable Vector Graphics format files will be created. This format is recommended for diagnostic use.
ExportSVGZ If set to TRUE, GZIP compressed SVG format files will be created. This format is recommended for production use. Also see the MapFormat web setting.
ExportPDF If set to TRUE, PDF files will be created according to PDF* settings. These PDF files are not used by SISfm itself. PDF files show plans as defined in their SWD files, including themes for example.
ExportCentroids If set to TRUE, room centroids will be exported when compiling floor plans. If table rm fields centroid_x,centroid_y exist they will be updated, otherwise TXT files will be created.
 
ExportFloor​N (where N=1,2,3...) Optional list of PNG or SVG files to be created for floor plans as *-N.png or *-N.svg, each specified by the following | separated values:
  1. The file format, one of PNG or SVG.
  2. The PNG scale, as pixels per metre. Ignored for SVG.
  3. The plan orientation, one of:
    • UNROTATED - e.g. geo-referenced.
    • ROTATED - rotated to the view rotation defined in the SWD file.
  4. The overlay to be labelled, as an index to the list below of overlays to be included (e.g. 1 for the first). Optional.
  5. The label text, as a Cadcorp expression.
  6. The label height, as a Cadcorp expression.
  7. The label colour, as hexadecimal RRGGBB.
  8. The name of the first overlay to be included.
  9. The name of the second overlay to be included. Optional.
  10. etc.
 
SVGStrokeWidth The thickness of SVG lines, overriding the default. May in turn be overridden by overlay attribute svgStrokeWidth#.
 
PDFPrintTemplate Exported PDF Cadcorp print template name. A template with this name must exist in the Cadcorp SIS standard libraries, or those specified by NolFile settings. The text of text items in the template with attribute Prompt$ is set as follows, where facility type names are obtained from the FacilityType setting, and building and floor text is set blank for site plans:
Prompt$_text$
SiteThe site code
BuildingThe building number
FloorThe floor ID
blTitleThe facility type name equivalent To "building", e.g. Car Park
flTitleThe facility type name equivalent To "floor", e.g. Level
PDFPaperFormat Exported PDF paper format, as for the paperFormat argument of the Cadcorp API ExportPdf method. Required, value not checked.
PDFParameters Exported PDF parameters, as for the parameters argument of the Cadcorp API ExportPdf method. Optional, value not checked.
 
ViewRotationAttribute The name of an SWD attribute which contains the view rotation. Optional, if omitted the view rotation defined by the Cadcorp SIS View / Map Views / Rotate command (window property _displayAngle#) is used. The attribute must be of float data type, of value between -180 and 180 degrees, if absent 0 is assumed.
 
BuildingName If set to TRUE, building names (bl.name) are compiled and can be displayed in floor plan titles (see MapTitleFormatFloor setting).
 
LinkColours If set to TRUE, item colours in other links overlays are compiled, using the primary brush colour for area items, otherwise the primary pen colour, taking overlay style overrides into account. Items are compiled specially for the following named brushes:
  • Blank - the item will have zero fill opacity, so the fill is invisible but a position within the the item will select it.
  • Hollow - the item will have no fill, so a position within the the item will not select it (unlike in Cadcorp SIS).
If not set to TRUE, or if an item colour is not defined, the MapColourLink setting is used.
LinkColoursAreaPen If set to TRUE, and LinkColours is TRUE, the primary pen colour is also used for area items.
 
LinkAttribute The name of the item attribute in links overlays which contains the link URI. Optional, default _URI (i.e. the Cadcorp system property _URI$).
DescAttribute The name of the item attribute in links overlays which contains the link description. Optional, default Description.
BuildingLocCodeAttribute The name of the item attribute in site plan links overlays which contains the floor plan location code. The last character of the name may be $, & Or # to specify the attribute data type as string, integer Or float, otherwise string Is assumed. Optional, default ccLinkList.
LocCodeAttribute The name of the item attribute in floor plan links overlays which contains the room location code. The last character of the name may be $, & Or # to specify the attribute data type as string, integer Or float, otherwise string Is assumed. Optional, default loc_code.
 
MapFloorLayerPointParams​N (where N=1,2,3...) List of View Points layers to be added when compiling floor plans (instead of using Cadcorp View Points overlays), each specifying the following '|' separated values:
  1. The layer name. This may optionally be two '~' separated values:
    1. The FacilityType code for which layers are to be added. Use an empty code for the default facility type.
    2. The layer name.
  2. The View Points parameters. These are the same As the mapEnquiry/getViewPoints.aspx querystring parameters (for an example see Troubleshooting), but:
    • replacing & by +
    • omitting x1 And y2
    • supporting the following placeholders:
      • $$map_name$$ which will be replaced by the floor plan loc_code.
      • $$site_id$$ which will be replaced by the floor plan site_id.
      • $$bl_id$$ which will be replaced by the floor plan bl_id.
      • $$fl_id$$ which will be replaced by the floor plan fl_id.
Such layers are added with with Invisible status.
 
FloorsOnSite​N (where N=1,2,3...) List of details for compiling building floor plans on site plans according to the following four comma-separated values:
  1. The facility type code to be compiled. For the default facility type, use Building.
  2. The name of site plan overlays containing building links.
  3. The name prefix of the overlays containing building floor plans to be added to the site plan. These are added after the building links overlay with names prefix..0 containing all the building floorplans linked from the site plan, prefix..1 for those one level higher, etc.
  4. The name of floor plan overlays containing room links.
  5. The scale of static room labels, e.g. 1000.

Building floor plan layers are only compiled for floor plans with an SWD file, and which are in the same coordinate system as the site plan (e.g. geo-referenced).

If value 3 is in the OverlayLinks setting, rooms on floor plans can be selected and themed, otherwise they are shown with static room number labels.

 
RoomTrialLayers If set to TRUE, table rm_trial is read for each floor plan being compiled. If one or more room trial layers are present for a plan, and if corresponding room trial layers are present, and if these layers are configured to be Link layers, these are compiled as additional room trial layers, in which room location codes include room trial code suffixes, e.g. RW-RW010-01-G15$TRIAL1. In Map Enquiry, room trial layers can be labelled and coloured as usual, and edited in table rm_trial. See also settings MapColourRoomTrial, MapColourRoomTrialLabel, MapColourRoomTrialLabelBack, MapColourRoomTrialSelected, RoomTrialDetailsTitleCaption, RoomTrialDetailsTitleColour and access security function EditRoomTrial.