Skip to content

CAP-ACC-BAT-009Configure recurring batch streams

Markdown

CAP-ACC-BAT-009

Configure recurring batch streams

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

KindCapabilityProduct areaAccountingModuleBatch ManagementRevision1

Read atservices-accounting f47cb263react-console baf6dae3

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Administrators can maintain recurring intake configuration and see whether initial intake is available.
Surfaces
consoleapi
Constraints
Accounting scheduling owns occurrence claiming, stored runs and automatic pause.

Controls

26 controls apply, from the corpus control catalogue.

TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-AZ-006 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-TEN-004 TC-DAT-001 TC-DAT-004 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-005

Permissions

KeyChecked atScope
accounting.recurring-batches.readapitenant
accounting.recurring-batches.createapitenant
accounting.recurring-batches.updateapitenant
accounting.recurring-batches.deleteapitenant
accounting.application.accessapitenant

Business Rules

14 rules, 13 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
A recurring configuration retains its original business unit and schedule identity.
invariantservice, databasetest
02must prove
Proposed
Creating recurring configuration requires a unit, name, batch-name template and schedule, derives an omitted reference from the name and refuses a reference already in use.
validationapi, service, databasetest
services-accounting:modules/batches/tests/e2e/recurring-batches.e2e.spec.js#answers 400 naming schedule to a body without one
03must prove
Proposed
A recurring schedule cannot roll more frequently than once per twenty-four hours.
validationservicetest
services-accounting:modules/batches/tests/e2e/recurring-batches.e2e.spec.js#answers 400 to a schedule that would run more often than once a day
04must prove
Proposed
Name and code templates can read only batch date, unit and currency plus the recurring configuration’s reference and name, rejecting invalid templates or unknown variables.
validationservicetest
services-accounting:modules/batches/tests/e2e/recurring-batches.e2e.spec.js#answers 400 naming batch_code_template to a template using a variable a batch template does not provide
05
Proposed
An omitted schedule zone defaults to the workspace zone, and reads expose the next occurrence, schedule description, latest run and any pause reason.
calculationservicetest
services-accounting:modules/batches/tests/e2e/recurring-batches.e2e.spec.js#answers every field as written, the schedule in the tenant’s zone, its next run and its sentence, and no last run
06must prove
Proposed
Active creation and reactivation attempt the first batch immediately, while a refused first-batch plan leaves the configuration saved with its explanation.
lifecycleservicetest
services-accounting:modules/batches/tests/integration/services/roll/batch-roller.integration.spec.js#saves a recurring batch whose first batch is refused, with the refusal and no batch
07must prove
Proposed
Deactivation disables future rolls without closing the existing active batch, and reactivation enables scheduling and clears its pause.
lifecycleservicetest
08must prove
Proposed
Replacement requires the saved version, rejects missing or stale versions and recomputes the next occurrence from the save time.
validationservicetest
services-accounting:modules/batches/tests/e2e/recurring-batches.e2e.spec.js#answers 409 StaleObject to a replacement at the version first read
09must prove
Proposed
A default assignment or assignment rule referencing the recurring configuration prevents its deletion and identifies that reference.
invariantservice, databasetest
services-accounting:modules/batches/tests/e2e/recurring-batches.e2e.spec.js#answers 409 naming the settings and how they name it
10must prove
Proposed
Deletion removes the configuration’s schedule, runs and unused active batch, but refuses removal while another generated batch remains.
lifecycleservice, databasetest
11must prove
Proposed
A business unit cannot be deleted while recurring configurations still reference it.
invariantdatabasetest
12must prove
Proposed
Accounting access and read permission govern recurring records, history and preview, while create, replace and delete each require their administrator write permission.
permissionapi, consoletest
13must prove
Proposed
The recurring list sorts by name, supports unit, activity and name-or-reference search, and limits each page to two hundred records.
validationapi, servicetest
14must prove
Proposed
The documented renderer contract produces trimmed single-line names and codes within its subject limit of 998 characters.
validationservicedocumented

Scenarios

IdGivenWhenThenProvenance
01The unit’s calendar covers the current date.An administrator saves an active weekday card stream with a date-based batch name.Its first batch is Open and the recurring response describes the next run.test
services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#answers the recurring batch’s first batch as its active batch: open, named for today, of the recurring batch
02Two assignment rules reference the card stream.The administrator deletes that recurring configuration.The refusal identifies the rules and preserves the configuration and schedule.test

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.