BILLmanager 6 Startup, Advanced

Cron scheduler

The article contains a description of the settings and the list of jobs that cron runs in BILLmanager.

The cron scheduler is a program that runs jobs at specified intervals.

To manage jobs, in the upper right corner, click the administrator's name → Back to root → enter SettingsScheduler. The Scheduler section contains the jobs for the root user, which are located in /var/spool/cron/root or /usr/spool/cron/.

In this section you can:

  • Create new jobs;
  • Edit existing jobs;
  • Enable or Disable jobs;
  • Delete jobs.

Configuring jobs

To add a new job, click Create job:

  • Email — specified in the settings after the job is created;
  • Server date and time — displays the current date and time on the server;
  • Command — specify the command that the scheduler will run on a schedule. See the Jobs description section;

    Command example
    /usr/local/mgr5/sbin/mgrctl -m billmgr currencyrate.upload upload=on sok=ok plid=153/50
  • Description — specify the description of the job;
  • Active — when this option is active, the job will be enabled after creation;
  • Schedule. The jobs will be performed on server time.
    • Basic mode — a simplified version of the schedule setup. Select the job interval and specify the start time;
    • Expert mode — an advanced schedule setup option. Specify the job interval manually. See the Jobs description section;
  • Do not email report — when enabled, the command execution results are not emailed.

Scheduler setup

To configure the scheduler, select the job → click Settings:

Job description

A cron job consists of six fields separated by spaces or tabs. The fields are listed in order: minute(s) hour(s) day(s) month(s) weekday(s) command(s).

The execution time can be specified as:

  • a number;
  • a comma-separated list of numbers;
  • a range of numbers separated by a hyphen;
  • the * character is any integer number;
  • the / character is the increment of the range values.

Field

Range value

Description

minute

0-59

start minute

hour

0-23

start hour

day

1-31

start date (day)

month

1-12

start month

weekday

0-6

start day of the week (Sunday = 0, Monday = 1, Tuesday = 2, etc.)

command


Sequence of commands to execute. These can be commands or executable files

Examples of time recording:

  • 23 0-23/2 * * * — at 00:23, 2:23, 4:23 ..., daily;
  • * 5 4-10 0-3 * — at 5:00 on the 4,5,6,7,8,9,10th days of January, February, March and April.

command — the command executed by the interpreter. Counts to the end of the string and may contain spaces. As a command, specify the path to the executable file and use the command according to the format supported by the specified file. For example:

  • <path to the executable file> -m billmgr <command parameters> — platform request;
  • <path to the executable file> --command <command parameters> — request to additional BILLmanager modules.

To compile the parameters of the command you can use the articles from the BILLmanager API old section.

Command example
/usr/local/mgr5/sbin/mgrctl -m billmgr currencyrate.upload upload=on sok=ok plid=153/50
Job example
## BILLmanager autoprolong notification

30 */12 * * /usr/local/mgr5/sbin/billmaintain --command autoprolong_disabled_for_items >/dev/null 2>&1


Job list

The list of cron jobs may vary depending on the version and settings of the platform and modules installed.

To view the list of cron jobs for the user root, execute the command:

crontab -u root -l

Notifications

Cron job

Meaning

## BILLmanager update expiredate notification

0 1 * * * /usr/local/mgr5/sbin/billmaintain --command warnupdateexpiredate >/dev/null 2>&1

Checking whether letters for services with an pending expiration date need to be sent

## BILLmanager send periodic notifications

0 3 * * * /usr/local/mgr5/sbin/billmaintain --command send_notification >/dev/null 2>&1

Sending financial notifications

## BILLmanager set ntsms messages 

* * * * * /usr/local/mgr5/notify/ntsms --command process >/dev/null 2>&1 

Automatic SMS notifications.

This list includes users who have: 

  • a verified phone number; 
  • SMS notifications enabled; 
  • the condition for sending a notification met. 

Finance and payment

Cron job

Meaning

## BILLmanager low money notification

0 1 * * * /usr/local/mgr5/sbin/billmaintain --command warnmoney >/dev/null 2>&1

Sending notifications and balance top up (if autopay is configured)

## BILLmanager generate postpaid payments

25 2 1 * * /usr/local/mgr5/sbin/billmaintain --command payment_generate_postpaid >/dev/null 2>&1

Automatic billing of all clients who have unpaid expenses at the beginning of the month

## BILLmanager check modules balance info

0 6,18 * * *  /usr/local/mgr5/sbin/mgrctl -m billmgr crontask action=processing.checkbalance >/dev/null 2>&1

Check the balance of processing modules. Read more in Balance of service processing module in the BILLmanager documentation

## BILLmanager clean_stalled_stored_methods

0 2,14 * * * /usr/local/mgr5/sbin/billmaintain --command clean_stalled_stored_methods >/dev/null 2>&1

Clearing the list of suspended saved payment methods

## BILLmanager process autopayments

1 0 * * * /usr/local/mgr5/sbin/billmaintain --command recurring >/dev/null 2>&1

Autopayments

root@aqua-rosolite-cloned ~# crontab -l | grep close_acco 15 2 * * * /usr/local/mgr5/sbin/billmaintain --command close_accounts >/dev/null 2>&1

Close invoices automatically

Services

Cron job

Meaning

## BILLmanager autosuspend unpaid items

2 * * * *    /usr/local/mgr5/sbin/billmaintain --command autosuspend >/dev/null 2>&1 

Automatic stop of services

## BILLmanager daily billing

15 0 * * */usr/local/mgr5/sbin/billmaintain --command billdaily >/dev/null 2>&

Daily collection of information about open services. Read more in Billing Cycle in the BILLmanager documentation

## BILLmanager process certificate subscription

30 0 * * * /usr/local/mgr5/sbin/billmaintain --command process_certificate_external_subscription >/dev/null 2>&1

Checking the need to renew the certificate on the processing module side

## BILLmanager sync items data with providers

40 */3 * * * /usr/local/mgr5/sbin/billmaintain --command syncitem >/dev/null 2>&1

Synchronization of domain data. Read more in Synchronization of domain data in the BILLmanager documentation

## BILLmanager process abuse tasks

20 * * * * /usr/local/mgr5/sbin/billmaintain --command abuse_task >/dev/null 2>&1

Search for violations of the service usage policy with the status "Open" and the term of elimination less than the current date on the server. Read more in Abuses in the BILLmanager documentation.

Statistics

Cron job

Meaning

## BILLmanager collect licence 6 usage stat

5 18 * * * /usr/local/mgr5/sbin/mgrctl -m billmgr collect_usageinfo sok=ok >/dev/null 2>&1

Collection of statistics on platform performance

## BILLmanager export to Google Analytics

*/10 * * * *   /usr/local/mgr5/sbin/mgrctl -m billmgr google.analytics.export

Exporting information to Google Analytics. Read more in Integration with Google Analytics in the BILLmanager documentation

## BILLmanager select tickets

0 1 * * * /usr/local/mgr5/sbin/billmaintain --command selecttickets

Automatic filling of the Quality control module selection list

Reselling

Cron job

Meaning

## BILLmanager sync items processing info

30 */4 * * * /usr/local/mgr5/sbin/mgrctl -m billmgr processing.syncserver.cron >/dev/null 2>&1

Synchronization of parameter values from a third-party control panel. Read more in Parameter values in the BILLmanager documentation.

## BILLmanager sync processing module configurations

54 * * * *  /usr/local/mgr5/sbin/mgrctl -m billmgr processing.getconfig >/dev/null 2>&1

Updating the information about available OS templates. Read more in Operating systems available for order. VMmanager 6 in the BILLmanager documentation

Marketing

Cron job

Meaning

## BILLmanager process affiliate

10 3 1 * * /usr/local/mgr5/sbin/billmaintain --command affiliatemonthly >/dev/null 2>&1

Accrual of remuneration for the referral program. Read more in How the referral program works in the BILLmanager documentation

## BILLmanager send notification

0 3 * * */usr/local/mgr5/sbin/billmaintain --command send_notification >/dev/null 2>&1

Sending mailings on the server. Read more in Client groups in the BILLmanager documentation.

Support tickets

Cron jobMeaning

## BILLmanager archive tickets

0 12 * * * /usr/local/mgr5/sbin/billmaintain --command archive_ticket >/dev/null 2>&1

Sending requests to the archive