Chapter 8 of 8Page 2 of 4

Manage and troubleshoot

Job queue monitoring

Set up the commission job queue entries, schedule calculation runs, monitor the run log and exceptions, and collect a sanitized diagnostics package for support.

updated: applies-to: 1.2.0.0

Bitta Commission does its background work through standard Business Central job queue entries: scanning posted documents, releasing eligibility, running scheduled calculations, evaluating deadlines and refreshing the license. This page lists those entries, shows how to set them up and monitor them, and how to collect a sanitized diagnostics package for Bitta Apps support.

Before you start

  • The actions that create job queue entries are on setup pages. The Bitta Commission Setup Administrator permission set includes the job queue permissions they need.
  • The scanner and deadline entries are created On Hold. They do not run until you review the schedule and set them to Ready in Job Queue Entries.
  • When you choose Finish in Set Up Bitta Commission, the guided setup does this for you: it creates the native sales, cash and cost scanner and pending eligibility release entries and sets them to Ready, and it creates a daily calculation schedule for the plan with its resume job. See Run the guided setup.

Job queue entries the app creates

Job queue entry description Created by Schedule and initial status
Bitta Commission native sales scanner, native cash scanner, native cost scanner, pending eligibility release Prepare Native Scanner Jobs on Bitta Commission Setup, or Finish in Set Up Bitta Commission Recurring every Native Scan Interval (Minutes) (5 in a new setup, 1 to 1,440). On Hold; the guided setup sets them to Ready.
Bitta Commission service, project and resource time capture scanners, purchase capture scanner, controlled G/L capture scanner, recurring and subscription capture Register Scanner Jobs on Commission Source Capture Setup Recurring every Native Scan Interval (Minutes) (15 when it is blank). On Hold.
Bitta Commission deferred commission amortization, payout and liability forecast refresh, anomaly scan, commission aging evaluation Register Scanner Jobs on Commission Source Capture Setup Same as the extended scanners. On Hold.
Bitta Commission scheduled incremental run (one per schedule) Enable on Commission Run Schedules, or Finish in Set Up Bitta Commission (one schedule for the plan it creates) Every day at the schedule's Run Time (2:00 AM for the schedule the guided setup creates, which skips a period without a full baseline because Create Baseline If Missing is off). Ready. Disable removes the entry.
Bitta Commission batch run resume Create Resume Job on Commission Run Operations Setup, or Finish in Set Up Bitta Commission Every Resume Interval (Minutes). Ready.
Bitta Commission workflow deadlines (approval and dispute SLA) Create deadline job on Commission Workflow Setup Every 60 minutes. On Hold.
Bitta Commission scheduled accrual posting Schedule commission accrual job on Commission Accounting Proposals Once every weekday (Monday to Friday). On Hold. Used with the Scheduled Accrual posting choice. See Commission accruals.
Refresh Bitta Commission license Automatically after a verified direct license activation Every 1,440 minutes (daily). Ready. Deactivating the license removes it.

Choosing a creating action again never creates a duplicate entry. For the scanner entries, it refreshes an entry that is still On Hold with the current setup. Three more processing codeunits accept a job queue entry, but the app does not create one for them: the recalculation queue (73570747), conditional release and forfeiture (73570750) and recovery write-offs (73570743).

Set up the scanner jobs

If you finished Set Up Bitta Commission, the native scanner and release entries already exist and are Ready. Use these steps to check them, or to prepare them yourself when you set up commission without the guided setup.

  1. Search for Bitta Commission Setup and choose Prepare Native Scanner Jobs. A message confirms that the native sales, cash and cost scanner jobs and the pending eligibility release job are prepared in On Hold status.
  2. Search for Job Queue Entries, review the schedule of each Bitta Commission entry and choose Set Status to Ready.
Job Queue Entries list with the Bitta Commission native sales, cash and cost scanners and the pending eligibility release in On Hold status
Step 2: the prepared scanner entries before you set them to Ready.
  1. Back on Bitta Commission Setup, choose Validate Native Scanner Readiness. It checks that exactly one recurring job exists for the sales, cash and cost scanners and for the pending eligibility release, with the current setup and a safe status: Ready, Waiting, In Process or On Hold. If not, the message shows BAA-NATIVE-SETUP and names the first job that fails and why. See Capture posted sales.
  2. For other sources, choose Register Scanner Jobs on Commission Source Capture Setup and set the entries to Ready when their adapters are enabled. See External sources.

Release Batch Size

The pending eligibility release job processes earnings in batches and commits after each batch. Set Release Batch Size on Bitta Commission Setup to how many earnings it processes before it commits, from 1 to 10,000. The default is 100. Smaller batches hold locks for a shorter time; larger batches finish a long run sooner. Every run of the release job, and every Release Pending Eligibility you start by hand, writes a row to Commission Release Log (shown when the Cash-based eligibility and holds module is on). See Credit memo netting.

Check the jobs before a season

Commission Season Readiness checks the commission jobs for its Season Start Date: the sales capture and cash capture jobs (an error when native capture is on and a job is missing), and the calculation schedule, eligibility release and recalculation queue jobs (a warning). A job that is in the job queue but not Ready is reported too, and so is a job queue entry for the eligibility release that runs the wrong codeunit (JOB_WRONG_CODEUNIT). See Setup checklist.

Schedule calculation runs

Commission Run Schedules starts incremental batch runs at a set time of day. At the run time, an enabled schedule starts an incremental batch for every open period of its calendar.

The guided setup creates one schedule for the plan it takes live: code WIZ- followed by the plan code, the description "Daily commission run for plan" with the plan code, the calendar you chose and a Run Time of 2:00 AM. It is enabled, and the batch run resume job is created with it. You can change it here like any other schedule.

  1. Search for Commission Run Schedules and add a schedule: Code, Description, Calendar Code (blank for every calendar), Plan Code, Plan Version No. (zero uses the latest published or active version at run time), an optional Participant No. filter and Run Time.
  2. Decide on Create Baseline If Missing (run a full baseline batch for a period without one) and Include Reopened Periods (periods whose reopen chose the scheduled incremental delta policy). Choose the Trace Level of the batches.
  3. Choose Enable to create the daily job queue entry. On an enabled schedule, Run Now starts the batches immediately.
Commission Run Schedules list with a schedule code, plan, run time, Enabled, Last Run At and Last Result and the Enable and Run Now actions
Step 3: an enabled schedule.
  1. Check Last Run At, Last Batch No. and Last Result on the line. Batch Runs opens the batch runs of the schedule. See Calculate commission.

Run operations setup

Search for Commission Run Operations Setup to tune batch processing. Run Schedules opens the schedules from here.

Field What it does New setup
Max Facts Per Invocation Source facts one batch invocation processes before it suspends and resumes later. The ceiling is 10,000. 1,000
Max Duration (Seconds) How long one invocation may run before it suspends. Zero means no limit. 1,800
Resume Interval (Minutes) How often the resume job continues unfinished batch runs. 15
Reconciliation Tolerance The amount difference tolerated when batch control totals are reconciled to child run ledgers. 0
Default Trace Level Errors only, a summary per invocation, or detail per source fact. Summary
Log Retention (Days) How many days run log entries are kept. The resume job removes older entries. Zero keeps every entry. 90
Error Exception SLA (Hours) Hours to resolve a blocking, critical, error or high severity exception. The due time is stamped on the exception, which is flagged overdue afterwards. 24
Warning Exception SLA (Hours) Hours to resolve an exception of any other severity. 72

Monitor runs and exceptions

  • Commission Run Log lists the entries written by batch and trial runs: when, level, event, message, source fact, count, duration in milliseconds, and the calculation, batch or trial run. Apply Retention removes entries older than Log Retention (Days).
Commission Run Log with logged time, level, event, message, count and duration per entry and the Apply Retention action
Entries written by batch and trial runs.
  • The Commission Operations tiles on the role center count running and failed runs, open exceptions, quarantined staging rows, failed exports, overdue approvals, SLA breaches and open disputes. See Commission reports.
  • Commission Exceptions is the worklist for anything that stopped processing. See Exception handling.
  • When a batch invocation finishes, the app sends one telemetry event, BAACOMM-RUN-0001 "Commission batch run invocation finished.", to the publisher. It carries the operation code, mode, result code, duration and a count band, classified as system metadata, and never amounts or identities.

Collect support diagnostics

  1. Search for Commission Support Diagnostics. The page collects its facts when it opens; choose Collect to collect them again.
Commission Support Diagnostics list with Section, Item, Value and Severity lines for VERSION, ENVIRONMENT, JOBQUEUE, LICENSE and INTEGRITY
Step 1: the facts collected when the page opens.
  1. Review the lines by Section:
Section What it contains
VERSION App version and ID, data version, installed app version, data schema version, last upgrade codeunit and upgrade completion time.
ENVIRONMENT SaaS or not, sandbox or not, a hash of the company ID and the client type.
SETUP, FEATURES, IMPLEMENTATION A hash of Commission Setup, each module with its state, the implementation path, completed and blocked stages, and the migration mode.
POLICY Counts of country policies and signed agreements, in bands.
JOBQUEUE Each commission job queue entry by object ID with its status, next start and attempts.
ERRORS Open exception error codes and their counts, in bands.
LICENSE The entitlement state.
INTEGRITY The last upgrade verification, the last integrity sweep and whether encryption is enabled.
  1. Lines with Severity BLOCKING or WARNING need attention. A job queue entry in Error is BLOCKING, and one still On Hold is a WARNING.
  2. Choose Export Package to download the text file for Bitta Apps support. Every export is recorded in the audit trail.

The package never contains secrets, customer, participant or company names, document numbers, amounts, formulas or raw error text. From the same page, Upgrade Verifications opens Commission Upgrade Verifications, where Run Verification appends a read-only report row, and Business Continuity opens the integrity sweep. See Audit and security.

NOTE

Never send your license activation code to support. The diagnostics package and the license diagnostic code are enough to investigate a license problem.

What's next

Review the audit trail and integrity controls: Audit and security.

// next step

Ready to try Bitta Commission?