Background Tasks

Field/Column

Description

Index

Identification number for this task.

Active

If this column displays an X, this task is active in SBN.

Exclude Period

Time period, in hours and minutes, that this task is not scheduled to run.

Last Active

Last date and time that this task was run. A default date of 80/01/01 is present if this task has never been run.

Interval

Shows how often this task is run. This depends on the type of task. Intervals are shown as Day:Hour:Minutes:Seconds.

Max Rows

Maximum number of rows of data the program may affect during each activation.

Description

Free format description of this task.

Look Back

For tasks that relate to deleting items, this field determines the length of time data is kept before it is deleted. For other tasks, this field is used to determine the grace period on alarms.

Fixed Window

A check mark in this field causes the task to run based on the deferred time shown in the offset window field rather than on the interval period.

Window Offset

Amount of time this task is delayed from the interval period. Only use this if the Fixed Window field has been marked.

Next Active

Next date and time that this task is scheduled to run.

Group ID#

Group number of the selected task. The Background Tasks Service runs a separate session for each background task group.

Job Index

Identification number for the selected task. User-created Background Tasks always have a negative number to distinguish them from default Background Tasks.

Exclude Period

The beginning of any period in which the Background Task should not run. The default is 00:00.

Exclude Period 2 (unlabeled)

The end of any period in which the Background Task should not run. The default is 00:00.

Description

The chosen descriptive name of the Background Task.

Misc 1

Defines maintenance date range to generate service tickets for. Number of days entered in this field is added to the number of days in the Maintenance Frequency field of program #559. Service tickets are generated for all installations with Maintenance Dates that fall within the defined range. Used for Jobs 58 and 59.

Misc 2

Service request status code. Used for Jobs 58 and 59.

Misc 3

Service request priority. Used for Jobs 58 and 59.

Last Active

The date when this Background Task was last active.

Last Active 2 (unlabeled)

The time when this Background Task was last active.

Look Back

For tasks that relate to deleting items, this field determines the length of time data is kept before it is deleted. For other tasks, this field is used to determine the grace period on alarms.

Active

This checkbox notes whether this Background Task is currently active.

Max Rows

Maximum number of rows of data the program may affect during each activation.

Interval

Shows how often this task is run. This depends on the type of task. Intervals are shown as Day:Hour:Minutes:Seconds. If this field is set to 0, the maximum number of consecutive missing signals feature will not work.

MTWThFSaSu

A check mark in each field determines what days this task should be run.

Group ID #

Group number of the selected task.

Fixed Window

A check mark in this field notes that the Background Task will run during a fixed window of time on every day that it is scheduled.

Window Offset

The additional number of hours, minutes, and seconds past the default time when the Background Task will run.

Stored Procedure Name

The name of the stored procedure. This field is only accessible on user-created Background Tasks.

Task #

Task Name

Description

0

Copy Task Log

Cleans the log of inter-machine copies.

1

Alarm Timers

Runs tasks for timers that are attached in monitoring.

2

Test Queue Removal

Removes active alarms from test and runaway mode after the test interval has expired. The process checks for "restore required" and generates a "prev reported" event, for all zones that are not considered restored.

Note: This task no longer closes service requests that were created when users put installations in test mode.

3

Data Entry Copy Task

Deletes the Copy Queue for Data Entry copy task copies.

This task only displays if option ba101 is on and includes ma_sim_phone.

4

Service Copy Task

Deletes the Copy Queue for Service copy tasks copies.

This task only displays if option ba102 is on.

5

Stats Hourly

Runs miscellaneous statistics hourly.

6

Stats Sampler

Collects run-time statistics used by SBN Graphs.

7

Report Queue

Clears old entries from the Report Queue.

8

Alarm Log Sum

Clears summary Alarm Log information. This task only displays if option sys013 is on.

9

Alarm Log

Clears the alarm log. This task only displays if option sys013 is on.

Note: If using option sys013, be sure to set the number of days you want to keep your Alarm Log history.

10

Open/Close Log

Clears the Open/Close log. This task only displays if option sys013 is on.

Note: If using option sys013, be sure to set the number of days you want to keep your Open/Close Log history.

11

Temp Comments

Clears temporary comments that have expired. This task only displays if option sys013 is on.

12

Item Log

Clears entries from the Inventory log. This task only displays if option sys006 is on.

13

Passcards

Clears expired passcards. This task only displays if option sys013 is on.

14

Mon Stat Change

Changes the Monitoring Status of installations on the date specified in Data Entry to the status in the New Mon Stat field of Data Entry Master (program #559). Changes the Monitoring Status of CIDs on the date specified in the Data Entry CID grid to the status in the New Mon Stat column of the Data Entry CID grid.

Note: To avoid losing the previous monitoring status of each changed installation or CID, do not use the Grace Period feature for this task. Enter 0000:00:00:00 in the Look Back field.

15

Inventory Allocation

Updates the current allocations in program #1757 Branch Inventory for use in the Pieces Allocated column. This is based on the Work Order date and the Look Back Time.

16

Composite Schedule

Updates the composite Open/Close Schedules by deleting old schedules and creating new ones. This task only displays if option sys013 is on.

17

Contract Expiration Date

Sets the expiration dates in Contract Master. This task only displays if option sys013 is on.

18

Test Timer

Controls monitoring test timers. If the missing test timer is less than 5 minutes over due when this task begins running, SBN uses the old time plus the interval when resetting the timer.

If the missing test timer is more than 5 minutes over due when this task begins running, SBN uses the current time plus the interval when resetting the timer.

This task only displays if option sys013 is on.

Note: Your settings for test timers depend on the numbers of operators you have and how often you get expired test timers. You may want to set the exclude for nighttime.

19

Spec Watch (no longer available)

Defines the number of days ahead to create special watch tickets. This task is no longer supported in SBN.

20

Billing Copy Task Queue

Deletes the Copy Queue for Billing copy task copies. The Look Back Days define the number of days that Billing records are kept. This task only displays if option ba104 is on.

21

Marketing Copy Task Queue

Deletes old entries from the Copy Queue for Marketing copy tasks. The Look Back Days define the number of days that Marketing copy tasks are kept.

This task only displays if option ba105 is on.

22

Work Order Copy Task Queue

Deletes the Copy Queue for Work Order inter-machine copies. The Look Back Days define the number of days that Work Order records are kept.

This task only displays if option ba106 is on.

23

Scheduling Copy Task Queue

Deletes the Copy Queue for Scheduling copy task copies. The Look Back Days define the number of days that Scheduling records are kept.

This task only displays if option ba113 is on.

24

Schedule Generation Technicians

Generates technician schedules for days defined in the Look Back field. This task only displays if option sys004 is on. Using this program to regenerate previously calculated schedules slows the process.

25

Schedule Generation Installations

Generates installer schedules for days defined in the Look Back field. Using this program to regenerate previously calculated schedules slows the process. This task only displays if option sys004 is on.

26

Schedule Generation Sales

Generates sales person schedules for days defined in the Look Back field. Using this program to regenerate previously calculated schedules slows the process. This task only displays if option sys004 is on.

27

Work Order Transfer

Transfers and purges Work Orders that have been sent to the Lawson tables. This task only displays if option in001 is on.

28

Commission Transfer

Transfers and purges commission information that has been sent to the Lawson tables. This task only displays if option in 001 is on.

29

Referral Transfer

Transfers and purges referral payment information that has been sent to the Lawson tables.

30

Work Order Adjustment Transfer

Transfers and purges work order adjustments that have been sent to the Lawson tables.

31

Invoice Transfer

Transfers and purges invoices that have been sent to the Lawson tables.

32

Payment Transfer

Transfers and purges payments that have been sent to the Lawson tables.

33

Write Off Transfer

Transfers and purges write offs that have been sent to the Lawson tables.

34

Work Order Allocations

Transfers and purges work order allocations that have been sent to the Lawson tables.

35

Aut Post Payments

Auto posts payments that have been placed on hold and are awaiting invoicing on a work order. This task only displays if option sys003 is on.

36

Auto Run Onscreen Aging

Runs update contract / account agings (program #576), which updates onscreen aging, collection database, and collector statistics. This is also needed for reminder calculations.

37

SBN System Backup

For IBS use only.

38

DE Log

Moves entries from the Change Log of Data Entry (program #559) into an archive. Moves entries from the Account Change Log of Contract Master (program #548) into an archive. Moves entries from the Contract Change Log of Contract Master (program #548) into an archive.

Note: Look Back functions as a retention period for Data Entry Change Log. Option ba418 must be on to archive the change logs.

39

Navision Item

Deletes the nav-items table. The Look Back Days define the number of days that records with a status of -1 are kept.

This task only displays if option in002 is on.

40

Navision Allocations

Deletes the nav_alloc table. The Look Back Days define the number of days that records with a status of -1 are kept.

This task only displays if option in002 is on.

41

Navision Satellite

Deletes the nav_satellites table. The Look Back Days define the number of days that records with a status of -1 are kept.

This task only displays if option in002 is on.

42

Userlogin Log

Purges Userlogin Log activity not within the previous one year period.

43

Navision Inventory Calc

Calculates inventory numbers. Should be set for 1 day back and a fixed window offset of 00:05:00.

44

Navision Inventory Transfer

Transfers to the work orders. This background job includes internal use transactions.

45

Navision Vendors

Synchronizes vendors with Navision.

46

Navision Purcorders

Synchronizes purchase orders with Navision.

47

Old Quotes

Flags work orders not closed and not invoiced with a change date <xxx as deleted.

48

Book Delay

Sets service ticket status to PTRL if:

• book_delay is not set

• service ticket has no schedule date

• service ticket has status X, where X should be an inparameter to the job, if possible

49

Book Missed

Sets service ticket status to PTRL if:

• book_missed is not set

• service ticket has no schedule date

• service ticket has status X, where X should be an inparameter to the job, if possible

50

Alarm Log Sum Arc

Clears summary Alarm Log information from archive tables.

51

Alarm Log Arc

Clears archived Alarm Log entries.

52

Open Close Log Arc

Clears archived Open / Close log entries.

53

Call Out Log

This job removes entries from the Call Out log that are not flagged with "Quality Control".

54

Zone Ext

This job removes rows from zone.ext if they are more than X days old.

Warning: Do not set the number of days any shorter than the longest test period set in Test Queue.

55

Error Account Alarm Log

This job removes alarms older than date specified for all accounts in the Error Account program.

56

Customer Specific

Customer may create a large stored procedure, such as a scheduled update. (IBS recommends stopping background jobs when a procedure is replaced.)

Note: For Customer Specific background tasks, IBS supplies a dummy procedure called cp_bg_jobs_userdef which does nothing. Customers can create their own procedure on the fly to do updates (or whatever procedure they need) which will execute under program #1712 control. Procedure receives 3 parameters:

• @nowdt: Current time in GMT

• @rcnt: Maximum rows defined in program #1712

• @ldt: Look back time in seconds from program #1712

When the user has completed his/her task, the user can put the default procedure back.

57

Data Entry Log Arc

Deletes entries from the Change Log archive of Data Entry (program #559) and the Account Change Log and Contract Change Log archives of Contract Master (program #548).

Note: Option ba418 must be on to archive the change logs.

58

Maintenance Tickets (701)

Generates maintenance tickets for selected dates and installations as in program #701.

59

Inspection Tickets (701)

Generates inspection tickets for selected dates and installations as in program #701.

60

Work Order Closing

Closes work orders marked for billing when option ba385 is on.

When option ba492 is on, this task approves and closes Cognito work orders for Company 105 that meet the conditions listed in the Options B document.

Note: This task should only run on the Billing server in a Billing/Monitoring split system.

61

Alarm Log Sum Arc Sec

Determines what data from the Alarm Log SBN stores in the secondary archive.

62

Alarm Log Arc Sec

Determines what data from the Alarm Log SBN stores in the secondary archive.

63

Open Close Log Arc Sec

Determines what data from the O/C Log SBN stores in the secondary archive.

64

Bluelink GL Export

Allows interface with Bluelink software to run monthly GL exports.

65

Bluelink PO Export

Allows interface with Bluelink software to run LCT accruals.

66

Test Queue Insert

Inserts zones into the Test or Runaway Queue that have been set to go into Test or Runaway on a specific date and time in the Test Queue tab of Data Entry (program #559).

67

POC Revenue Calc

Calculates work order Percent of Completion values.

68

Alarm Queue Transfer

Transfers alarms from one queue to another according to setup in Alarm Queue Transfer (program #1696).

69

Remove Old Schedule Req

Removes schedule requests (work orders, service requests, and sales visits) from the Service Request List in Scheduling (program #563). The Max Rows field indicates the number of requests that will be removed per background job run. The Schedule Date field in Program #563 determines which jobs are old enough to be removed.

70

Branch Move for Team Sold Ins

Customer specific for company 120.

71

QAS Address Update

Updates addresses in Data Entry (program #559) from table w#qas_inst_addr.

Note: If there is more than one address for an installation in the table, SBN uses the most recent address to update Data Entry.

72

Sales Survey

Processes sales survey emails in the survey queue.

Note: Email Service must run for SBN to send emails. Option survey1 must be on to add a sales survey to the queue when a sales visit is scheduled in program #563 for a sales resource.

73

Work Order Survey

Processes work order survey emails in the survey queue.

Note: Email Service must run for SBN to send emails. Option survey2 must be on to add a work order survey to the queue when a work order is closed.

74

Maint SV Survey

Processes maintenance service request survey emails in the survey queue.

Note: Email Service must run for SBN to send emails. Option survey3 must be on to add a maintenance survey to the queue when a service request with a status defined by option sur3_val is outdated.

75

Insp SV Survey

Processes inspection service request survey emails in the survey queue.

Note: Email Service must run for SBN to send emails. Option survey4 must be on to add an inspection survey to the queue when a service request with a status defined by option sur4_val is outdated.

76

Cycle Fee Generation

Creates cycle fees on installations with codes selected in the Class fields of program #559 that have cycle fees defined in Installation Classes (program #1555).

Note: This task should only run on the Billing server in a Billing/Monitoring split system.

77

Cognito Queue Cleaner

Deletes Cognito Queue records that have been in the queue longer than the period of time in the Look Back field.

78

Cycle Fee Delete

Clears table ma_inst_class_cfee, which stores cycle fees to be created on installations with codes selected in the Class fields of program #559 that have cycle fees defined in Installation Classes (program #1555).

Note: This task should only run on the Monitoring server in a Billing/Monitoring split system.

79

Ext Reset

Sends Reset commands to Sonitrol panels. (Not yet functional.)

80

Queue 17 Cleaner

Clears Alarm Queue 17.

Note: When option fe015 is on, SBN makes backup copies of all signals that enter the Immediate Queue in Alarm Queue 17.

81

Recurring Holidays

Searches the oc_calendar table for records that:

• Are later than today

• Are linked to an oc_holiday record that is flagged Recurring

• Do not have another oc_calendar record for the same holiday in the future

This background task creates a new entry in oc_calendar for exactly one year from the current record's date for all records identified as Recurring.

82

Access Control Log Cleaner

Purges data in table ma_ac_log, the log file for tasks completed in Access Control tab of program #559, after the amount of time specified in the Look Back field.

85

IVR Clean Up

Clears IVR activity data rows.

86

Emergency Routing Clean-Up

Purges expired entries from ma_queue_routing table that are marked as active and emergency.

87

Communication Log E-mail

Adds emails to email queue for closed entries from the communications log queue that have reached or passed the follow-up date of the Communication Log entry, and have Key 5 set to one of the emails specified in option ma037. The subject of the emails is set to option ma039 and the res_code on the communication log entry is set to option ma038 after it is added to the email queue.

88

ALF Device Onboarding

This task is client-specific to company 162.

Processes entries in the ma_wifi_queue table that have an op code of 101 or 102 (create or delete). Entries that  have on opc of 101 are added to the ma_installed_components table and entries with opc 102 are removed from that table.

100

Autofeed UserID Delete (531)

Automatically deletes items within program #531.

101

SEFCO Calculation Table Delete

Deletes records from table ma_sefco. Look Back will determine the age of the record before deletion.

102

Alarm Log Info

Archives data from the Alarm Log Infor table by moving entries from the ma_alarmlog_info table to the ma_alarmlog_info_arc table. Requires option ba301 to be enabled.

103

Alarm Log Info Archive

Purges entries older than the specified lookback time from the Alarm Log Info archive table. Requires option ba301 to be enabled.

104

Installation Access Log Cleaner

Purges entries older than the specified lookback time from the ins_access_log table.

105

Monitoring Dealers Activation Update

Controls the Active From and To date fuctionality in Monitoring Dealers (program 2508).

106

fe_bell Table Cleaner

This task is client-specific to company 162.

Purges entries older than the specified lookback time from the fe_bell table.

107

Delete Account

No current functionality.

108

Delete Account Load

No current functionality.

109

Cycle Fee to Services

Process Cycle Fees for Alarm.com (ADC).

110

Purged Linked Payment Methods for Cancelled Contracts

No current functionality.

111

Purge Unlinked Payment methods

Removes the payment method(s) used after a set amount of time.

112

Purge Service Ticket/Invoiced Work Order Payment Methods

Removes any payment method(s) linked to service tickets or Work Orders after a set amount of time.

113

Communication Log Survey

Processes communication log survey emails in the survey queue.

Note: Email Service must run for SBN to send emails. Option survey5 must be on to add an communication log survey to the queue when a communication log matches the communication code selected in Report Messages (#1766).

Button

Name

Shortcut Key

Action

Description

Get

ALT+F1

1712/ 1

Get record.

Change

F2

1712/ 2

Change selected record.

New

F3

1712/ 3

Create new user record.

Delete

SHIFT+F10

1712/ 4

Delete user-created record.

Refresh

 F6

1712/ 5

Refresh SQL.

Toggle

 F7

1712/ 6

Toggle between active and inactive reports.

Print

CTRL+F8

1712/ 7

Print selected records.

Previous

F4

1712/ 1

Select last record.

Next

F5

1712/ 1

Select next record.