Settings

Use System Settings to configure how your CAIRS operates. When you install CAIRS, a Unique Communication Representative and your CAIRS administrators determine these settings. There are four columns of information for each setting:

Setting Name* – the setting name.
Category* – the portion of the software this setting is for or the software name. For example, Billing, Orders/Trouble, Subscriber Portal, etc.
Setting Value* – displays the actual setting, for example, True, False, etc. If you are using the True or False setting, make sure the capitalize the word or it will not accept the setting.
Description* – displays a brief setting description.

The following settings are available (the list below is sorted by category, to match this list click on the Category column header once):

Category – Activity Log

The Activity Log setting determine whether you if you are going to keep track of all the changes that occur within your database. If you choose to keep track you will need to set all the settings. If you choose to not keep track, you can ignore these settings.

Activity Log Directory Path – displays the path to the location of your activity log.
Disable All Activity Logging – determines whether you want to create the log. A value of False indicates that you want to create the activity log. A value of True indicates that you do not want to create the activity log.
Log New Record Field Details – determines whether you want to see the field data for changed or new information, when set to true, the Activity Log à Detailed List displays an Old Value column and a New Value column. If set to False, those columns do not appear.
Max Activity Log Size MB – displays the log file’s maximum size in megabytes. After reaching the maximum size, the file archives to a location designated by CAIRS. Once archived, you no longer see the records within your active database.
Max Days to Keep Activity Log – displays the maximum number of days to keep the activity log within the database. Once the allotted days have passed, CAIRS saves the file and creates a new log.
Min Days to Keep Activity Log – displays the minimum number of days to keep the activity log active within the CAIRS database

Category – Billing

These settings deal with all things needed to generate a bill for unofficial and/or official accounts. If you choose not to run official or unofficial bills, you can ignore these settings.

Allow Negative Funding Amounts for Official – a value of True allows you to enter in a negative amount in the Amount Submitted when applying funds. This is helpful if you have made any clerical errors on funding entries. If set to False, only positive amounts can be entered into the amount submitted.
Auto Fill Install Date for new Assigned Equipment and Services – a value of True will automatically populate the install date of all newly installed equipment and/or service. A value of False requires the user to enter in the install date.
Auto set Delete Date to Installed Date for One-time charges on Equipment/Services – a value of True indicates that when you add an equipment/service with a one-time charge the delete auto-populates with the same date as the installed date. A value of False indicates that you must enter a date in the Delete Date field.
Bill Distribution Folder for SP – If the “Distribute Bills Folder’ setting is set to True, you need to enter the name of the folder that Subscriber Portal will look for to access your bills. This is only the folder name.
Bill Distribution Folder Path from CES – this is the complete path of where CES will distribute the bills to, this is the combination of both the ‘Bill Distribution Folder for SP’ and the Bill Distribution Folder Path from SP’ settings.
Bill Distribution Folder Path from SP – this is the path to the folder name where Subscriber Portal will look for your bills, this works with the folder you listed in the ‘Bill Distribution Folder for SP’ setting, do not include the name of the folder. This setting is designed for an enterprise system to allow for CAIRS to support multiple sites within Subscriber Portal.

– If set to true then CES distributes bills via email, each account assigned an email address gets a bill, if set to false no emails are sent.
Distribute Bills to Folder – determines if you want to send bills generated to a folder you designate in another setting (Bill Distribution Folder Path). If set to True then CES delivers the bills to the folder.
Distribute Bills to Printer – determines whether you want to send the bill generated to a printer. If set to True then CES delivers the bills to the designated printer. This setting is useful if you want to print and mail the bills to your customers.
Enable Automatic Official Billing – determines whether you want CAIRS to generate your bills automatically based on your billing cycle, a value of True turns this on for official billing.
Enable Automatic Unofficial Billing – determines whether you want CAIRS to generate your bills automatically based on your billing cycle, a value of True turns this on for unofficial billing.

The next three settings determine how you want CAIRS to fill your organization information; you must set one of the three to true and the other two to false.

Fill Organization from Call Accounts – this setting determines where the organization information comes from for call records. If set to True the organization information associated within the Accounts for Calls tab is the one used to update the call records. If set to False, the organization associated within the Accounts for Equipment and Services is used.
Fill Organization from Equipment and Service Accounts – this setting determines where the organization information comes from for call records. If set to True the organization information associated within the Accounts for Equipment and Services tab is used to update the call records. If set to False, the organization associated within the Accounts for Calls is used.
Filter Organizations By Account – this setting determines whether you want to filter the organization dropdown box by account number, this means that if you select an account (anywhere in the system), the orgs within the list are only those associated to the account. A true setting filters the list while a false displays the entire list of orgs.
First Official Billing Date – this is the start billing date for all of your official accounts, any charges occurring before this date are not billed.
First Unofficial Billing Date – this is the start billing date for all of your unofficial accounts, any charges occurring before this date are not billed.
Log All Unbilled Account in Billing Cycle – determines whether the accounts that did not generate a bill during the cycle are placed into a log for your review. A value of true generates a log with the accounts that have not bill and a value of false does not generate a log. The log can be viewed after you run the bill in Accounts – Official/Unofficial – Run Bill Requests, double click on any bill to open the General – Billing Cycle window. In the lower right hand corner is the Unbilled pane, any account that are unbilled appear there.
Months to Keep Official Bill Files – this setting works in conjunction with the Distribute Bills to Folder setting, if that setting is set to true, then this setting determines how many months to keep the official bill files before deleting. This defaults to 60 months.
Months to Keep Unofficial Bill Files – this setting works in conjunction with the Distribute Bills to Folder setting, if that setting is set to true, then this setting determines how many months to keep the unofficial bill files before deleting. This defaults to 60 months.
Official Billing System – there are two billing systems that you can choose from: Classic or Dynamic. The Classic is the current billing system and the setting default, where all billing cycles are run progressively from month to month. Meaning you must run April’s bill before you can run May’s bill and so on. The Dynamic billing system allows for billing periods to be run together, amongst several other advantages, to learn more please see the chapter on Dynamic Billing. There is also a Hybrid setting, this allows for you to transition from the classic to the dynamic seamlessly.
Operator Assisted Call Text – allows you to determine the Call Type that you want to use for operator assisted calls. This defaults to ‘Operator Assisted’.
Precision for Minutes Summary in Billing Reports – determines that number of decimal places for the minutes and seconds in your billing reports. The setting can have a value of 0 to 4, the corresponding settings are:
0 – displays minutes only, no second value (1)
1 – displays the minutes and rounds the seconds to a tenth of a second (1:4)
2 – displays the minutes and rounds the seconds to a hundredth of a second
3 – displays the minutes and rounds the seconds to a thousandth of a second
4 – displays the minutes and rounds the seconds to a ten-thousandth of a second
Reset Official Bill Balance Every Bill – determines if you want to carry any balances forward for each billing cycle. If set to True, for each new billing cycle the account balance is set to $0.00. If set to false, any unpaid balances carry to the next cycle.
Reset Official Bill Balance Every Fiscal Year – determines if you want to carry any balances forward for each new Fiscal year. If set to True, for each new fiscal year the account balance is set to $0.00. If set to false, any unpaid balances carry to the new fiscal year.
Return Top Phone Number for Account – when you are viewing an account, there is a yellow status bar directly below the ribbon; this bar contains important account information, including a number field. This setting determines whether the number field is present in the status bar. If set to True, the first telephone found relating to the account populates the field, this may slow down the loading of the complete account details. If set to False, the telephone field is removed from the status bar, this may load the account details quicker.
Update Call Records from Directory Line – as a default, CAIRS updates the call records through the account number. If this setting is set to True, then CAIRS updates the call record information through Set Management. If there are multiple listings, the primary number is used for billing the call records.
Use Funded Program – if set to true the new funded program will become available for use within CAIRS and Subscriber Portal. Please do not turn this setting on without consulting with a Unique Representative first.
Validate New Equipment to Account – determines whether CAIRS will validate the account prior to saving when new equipment or services are added. When a user adds equipment or services, CAIRS will verify that the account that is associated to the record has the appropriate charge type associated. If the charge type is not associated the user will not be able to save the record.

Category – Call Records

Archive Bulk Size – allows you to determine the number of call records that you want to copy when archiving or restoring. The default is set to 10,000 calls in each file. You can increase or decrease the value by entering a different number.
Billing Interval – indicates your billing interval; every second, every 6 seconds or every minute. This defaults to 0 meaning that every second is billed.
Current Currency Symbol – displays the currency symbol you are using for all billing, for example the $ sign.
Days Till Expiration Warning – this setting determines the number of days before you receive an expiration warning for foreign currency. The default is 355 days, meaning that you must update the exchange rate every 355 days.
Do Not Round to Two Decimals – if you are using the re-pricing option, CAIRS automatically rounds the call price to two decimal points. This defaults to false which rounds the call pricing to 2 decimals ($10.55). Set this to True to round to 4 decimals places ($10.3405).
Foreign Currency Expiration Warning – this setting works in conjunction with the ‘Days Till Expiration Warning’, if set to true than the administrator receives the warning, if set to false no warning is given.
Foreign Currency Symbol – displays the foreign currency symbol if you are billing in a foreign currency
Round First Minute – determines whether to round the first minute of billing up, if set to true, if the call is 30 seconds long the customer is charged for the full minute. If set to false, the customer is charged for 30 seconds. This defaults to false.
Round to Next Period – determines whether to round up to the next whole number, if set to false, if a call was 3 min 15 sec long, the customer would be billed for 4 min. If set to false, the customer is charged for exactly 3 min 15 sec.
Unit Value – displays the number of units for each value. For example, 100 units (cents) in $1 or 100 pence in 1 pound.
Update Auth Code Calls by Extension if Missing – in the event that an authorization code does not exist within your database, you can use this setting to have the calling extension billed for the call. This defaults to False meaning that the call record will not be billed to any number until you create the authorization code and run the CES process to Change Call Ownership. However, if you set this to True, CAIRS will automatically bills the calling extension for the call record.
Update Missing Billing Subscriber From Directory Line – ideally call records are updated with the subscriber information associated to authorization codes, if you do not use authorization codes the update comes from the billing account number. If there is no subscriber information on either one of those, CAIRS uses the subscriber information related to the directory line (aka configured set). If this is set to true, CAIRS tries the authorization code then the billing account then the configured set for the subscriber information. If set to false, CAIRS tries, only the authorization code and billing account for subscriber information, if there is no subscriber within either of those then the field is left blank for the call record.
Use Primary Billing Site in Number Plan for Call Record Update – allows you to bill two matching numbers in different number plans to different accounts. When your calls are brought into your active calls, they go through a matching process that associates important information such as site, account number, organization, etc. If this setting is set to True, the matching process looks first at the site associated to the call record and matches that up with the Primary Billing Site within the Number Plan, thus determining the proper extension to associate with the call record.
Use Site Specific Unit Interval Settings – determines whether you use site-specific call pricing, databases that have multiple sites associated use this setting. If set to true, each site contains a Call Pricing Group, Unit Value, Billing Interval, Round to First Period and Round to Next Period fields that will now be used for call pricing. If there is no Call Pricing Group associated with the site, CAIRS will use the default Call Pricing Group. If this setting is set to false all calls are priced based on the default call pricing groups.
Use Foreign Currency – when set to True, all billing is in the foreign currency determined within your rate tables.

Category – Configured Items

Clear Buttons when Changing Set Type – if you need to change the set type for a digital set device and don’t want to have to clear all the button data first, set this to true and CAIRS will automatically clear the buttons except for the primary listed number. This is useful for sites that use the switch syncs.
Default Published Option – this setting determines the default publishing option when you are a creating a new configured set. Enter one the following numbers to choose your option:
0 – Published (if you do not change this setting, it will default to 0 meaning all new sets are published)
1 – Non-Published
2 – Classified
3 – Temporary
4 – Alternate
Group Terminals By Room – a value of true indicates that the terminal for a building are grouped together based on room number, a value of false displays the list based on the order in which they were added to the building
SL100 and CS2100 Call Pickup Group Use Link LEN – a value of True indicates that when you delete the Pilot number of a Call Pickup Group, CAIRS automatically takes the lowest LEN in the group and makes that the Pilot for the Call Pickup Group. If set to False, when you delete the Pilot the next position in the Call Pickup Groups is made the Pilot.

Category – Dropdown

Exclude Organization Path from Organization Name – determines whether the organization name and path appear within one or separate columns. A value of True separates the organization name and path into two separate columns, while a value of False combines the organization name and path within the same column.
Exclude Site Path from Site Name – If True then the Site Path when you access the site dropdown list there will be two columns, the first with the site name and the second with the complete path to the site. If set to False, the site name appears first followed by ~~ and then the path.
Include Account Number in Organization Dropdown – determines if the account numbers associated with an organization appears in the Organization dropdown. If set to true, the account numbers appear in the dropdown, if set to false the account number do not appear in the dropdown.
Include Misc Fields In Organization Drop-down – determines whether miscellaneous organization fields are included next to the organization name and path in the organization dropdown. A value of true displays all misc fields within the dropdown, while a value of False hides these columns.
Include Organization Code with name in Organization Dropdown – determines whether the code and the name appear in the organization dropdown list. If set to true then the code appears before the name followed by a dash (-) and then the organization name, in the first column of the dropdown. If you have not associated a code to the organization, a dash will appear before the organization name. If set to false then just the organization path appears in the dropdown in the first column of the dropdown.

Category – Export

Default PDF to Landscape – determines the orientation of your export in PDF format. If set to True then the PDF format defaults to a landscape orientation, if set to False (the default) the orientation remains as portrait.
PDF Landscape Width – If you have set the Default PDF to Landscape setting to true, this setting is required to determine the width of the columns on the page. This number references the column width of each item in the header, the higher the number the smaller the column width. If you choose a small number, your information may appear on two rows. This defaults to 150.
PDF Portrait Width – If you have, set the Default PDF to Landscape setting to False, this setting is determines the width of the columns on the page when using the portrait setting. This number references the column width of each item in the header, the higher the number the smaller the column width. If you choose a small number, your information may appear on two rows. This defaults to 100.
Prompt for PDF Page Orientation –when set to True the user is prompted to select whether they want to print the report in portrait or landscape. If set the False, no prompt is given and the default setting is used.

Category – Facilities

Prevent Duplicate Binding Posts in Terminal – determines if you can have binding posts with the same number appear in a terminal. This setting defaults to False meaning that you cannot have binding posts with the same number in a terminal.
Show Nearest Building Button in Facilities – when set to True a Nearest Building button displays in Facilities to show the building closet based on the latitude, longitude and elevation coordinates. The default is set to False meaning the button will not display.

Category – Form Layout

Default Form Layout to Admin Layout – determines whether the default form layout for all users will be the administrator’s layout. A value of true changes all form layouts to the administrators. A value of False allows each user, based on permissions, to customize their form layout.
Require Permissions for Form Layout – determines whether you want to allow your users the ability to customize form layouts. A value of false allows any user to change the layout; a value of true requires permissions.

Category – Solr

Use Internal Importer – CAIRS uses Solr to search for information within your database, there are two way that Solr can access the data either through its own Data Import Handler or through HTTP. This setting determines which method Solr uses to pull the data, a value of False means it will use the Data Import Handler. A value of True means that will use HTTP. The default is True.

Category – Startup

Check for Software Updates – determines whether to check for software updates when starting the software. A value of False does not check for updates whereas a value of True checks.
Disable Toll Ticket Notifications at startup – determines whether you are notified of toll ticket statuses when you first start CAIRS. A value of true allows the notifications to appear.
Disable Trouble Ticket Notifications at startup – determines whether you are notified of trouble ticket status when you first start CAIRS. A value of true allows notifications to appear.
Disable Work Order Notifications at startup – determines whether you are notified of work order status when you first start CAIRS. A value of true allows notifications to appear.
Display Warning Message – when set to True the user must accept the DOD warning message before they can access CAIRS, if set to False the warning message does not appear.
Instance Count – displays the maximum number of CAIRS client instances a single user can open. The default is 5, meaning you can have 5 instances of CAIRS open at the same time on the same computer.
Software Update Service URL – displays the software update site URL location. This is the location of where CAIRS will look for a new version of software.

Category – Subscriber Portal

Default Subscriber Portal Password – when a subscriber forgets their password to Subscriber Portal, you can have a default password setup or you can have CAIRS randomly generate a password. If you type in a password here, when a subscriber need a reset you the Reset Password button and this is the password.
SP Web Site URL – displays the URL to your Subscriber Portal

Category – Switch

Days to Keep Switch Sync Log – determines the number of days to keep the Switch Sync Log on file. After the allotted days the log is deleted.
Enable RAX and CXGRP on site – if set to true then a RAX and CXGRP are added to the General – Sites window and you associate each one. This is specific to the EWSD.
Max Days To Store UCE Events – determines the maximum number of days to keep the acknowledged UCE events. This defaults to 30.
Max Idle Minutes for SMA Sessions – displays the maximum number of minutes a SMA session can remain open while inactive. Once those minutes have passed, the session automatically ends.
Switch API Location – determines your Switch API location.
Sync Options On Features
Use Wopr – uses WOPR (Work Order Processing Real-Time) when set to true.

Category – System

Alarm and Traffic System URL – displays the Alarm and Traffic System URL.
Allow SQL Command Window – If set to true then a menu option will be added to System Settings that allows for running of SQL from within your client. This is an advance function, so as a default it is set to False.
Alternate User File Location – this setting allows you to change the location of the folder that saves all your user configurations, as a default we save the file in the c:\Users\Username\Documents\CAIRS. If your network restricts access to that location, put the alternate location here.
Always Reset Search – a value of False tells the system to use the previous search parameters when refreshing a menu list or navigating back to a menu. A value of True tells the system to remove any search parameters when refreshing a menu list.
Always Show Database Utilities Menu – this setting determines whether the Database Utilities menu is visible under System Admin. A value of True shows the menu option and a value of False means the menu is not shown. Keep in mind that the tools within the Database Utilities menu are powerful and could damage your database if not used properly. Do not perform any function with the menu option unless directed by a Unique Communication’s Representative.
CAIRS CEDC Domain – displays the domain name where the CEDC is installed.
Client Web Service Timeout (in Minutes) – this setting determine how long a CAIRS client waits for a response from the CEDC before returning an error. This setting is set to a minimum value of 10 minutes.
Maximum File Attachment Size in MB – displays the maximum file attachment size allowed within your system. This defaults to 2.9 mb. If you allow file attachments within Subscriber Portal you need to increase this amount in connection with the MaxRequestLength in the web.config file to allow for large attachments.
MoraleMinder System Path – displays MoraleMinder’s installation path.
Remember Form Size – when you resize a form CAIRS can remember the size so your wont have to resize anymore. Set this to True to have CAIRS remember your form size. This defaults to True.
Save Column Sort Order – When set to True, the sort order the user has chosen remains in place for future searches. If set to False the sort order returns to the default.
Security Type – there are three different options within Security you can choose either Windows, Certificate or Mixed. With Window authentication, CAIRS will use your windows credentials to login. With Certificate, CAIRS will use your CAC credentials to login. Mixed allows for all types of authentication. To learn more about the different security types please see the section of Security. To change the security type, type in the appropriate type.
Server to Client Messaging – When a new order is created or changes are made to an existing work order, emails can be sent to users. The emails contain a link that when clicked can open the order within CAIRS. If this is set to True then CAIRS will open the order, if set to False CAIRS will not open the order.
Use Public Organizations – when set to True, a new menu option appears within Directory/Organization called Public Organizations. The true value also allows you to generate bills for the organizations for any charges incurred. A value of False leaves the menu option hidden.
Vendor Media Import Menu Option – There are four options available for VMI they are Standard, Advance, Basic and All. To learn more about each of these options please see Vendor Media Imports. The default setting is Standard.

Category – Toll Tickets

Control Number Mask – determines the mask of the toll ticket control number, this default to T=TTCN-;D=yyyy;T=-;D=MM;T=-;I_M=00000;T=-;I_N=000. Your control number will look like TTCN-2015-09-00000-356465730241718240
Use Toll Ticket Option – a value of true indicates that you will use the control ticket option in available in Directory/Organizations. If set to False, the menu item is disabled.
VIP Control Number Mask – determines the mask of the toll ticket control number for VIP’s, the default is T=VIP-TTCN-;D=yyyy;T=-;D=MM;T=-;I_M=00000;T=-;I_N=000. Your control number will look like VIP-TTCN-2015-09-00000-356465730241718240

Category – Work Order

Don’t Close General Orders Until Sub-Orders are Closed – determines whether you can close the general work order before all sub-orders are closed. A value of True prevents you from setting a close date on the general work order until all the related sub-orders are closed. A value of False allows you to close the general work order, even if sub-orders are still open.