BeyondERP.Newsletter
Menu

Setup page · System administration

Batch class configuration overrides

A setup page where you add a batch class and override settings that come from its code, such as whether it can be retried.

Used by
Information technology manager
Business process
Administer system features
Menu item
BatchClassConfigurationOverrides
Main table
BatchClassConfigurationOverrides
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA setup page where you add a batch class and override settings that come from its code, such as whether it can be retried.
What you do hereUse this page to decide whether tasks of a batch class are retried automatically after a short loss of connection to the database.
ExampleFor example, a partner's integration class doesn't implement BatchRetryable, so its tasks fail on every brief SQL connection loss; after the developer confirms the class is idempotent, the administrator adds it here with Is Retryable = Yes, and the platform retries it after 5, 8, 16 and 32 seconds and so on, up to five minutes.
Batch class configuration overrides page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

Business processAdminister system features
Menu pathSystem administration › Setup › Batch class configuration overrides
Set up firstBatch jobs (Maximum retries per task) Microsoft Learn
Used next byBatch job history clean-up Microsoft Learn
Related pagesBatch jobs Microsoft Learn
End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

Step by step, with screenshots

Set up Batch class configuration overrides1 screen

Use this page to decide whether tasks of a batch class are retried automatically after a short loss of connection to the database.

  1. Screen 1

    Override how a batch class retries

    Go to System administration > Setup > Batch class configuration overrides

    1. Select New
    2. Choose the batch class
    3. Select whether its tasks are retried automatically after a short loss of connection to the database
    4. Select Save
    Override how a batch class retries (zoomed on the outlined fields)
    Show the full screenOverride how a batch class retries
    page title tab to open what to set or check

Steps from Microsoft

  1. Go to System administration > Setup > Batch class configuration overrides.
  2. Add the batch class.
  3. Set the Is Retryable value that you want for the class.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansExample
Is RetryableWhether tasks of the batch class are retried after a short database connection error.Microsoft Learn Yes
Batch classThe batch class the override applies to.Microsoft Learn

Common errors and fixes

MessageWhat to do
A task failed on a SQL connection loss although Is Retryable = YesThe class must throw the TransientSqlConnectionError exception itself (or wrap it); if it throws another error, the platform doesn't recognise it and doesn't retry. Microsoft Learn
A retried task sent the same email twiceThe class isn't idempotent. Set Is Retryable = No for it, or make the email step idempotent. Microsoft Learn

Test checklist

  1. Add the batch class and set Is Retryable.
  2. Confirm with the developer whether the class implements BatchRetryable or sets Idempotent in code, and that the override gives the intended result.
  3. Check on Batch jobs that tasks of the class also have a Maximum retries value above 0 for other errors.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up Batch class configuration overridesSet Is Retryable to Yes only for batch classes whose tasks are idempotent (running them twice gives the same result)A retryable class is retried automatically after a SQL transient connection error, and the value on this page overrides the value in code. Learn's best practice is that batch tasks should be idempotent.Which batch classes are retried after SQL transient errors?Marking a class retryable when its tasks aren't idempotent, for example a task that sends email, so a retry can repeat the work or send duplicate messages.Test: An override takes priority over the class code

Feature management and licence

Licence or add-inOn this system the page opens for Information technology manager. IT administrators set overrides with developers. SQL transient retries need version 10.0.18 or later for BatchRetryable. No Feature management feature needs to be turned on for this page.

Microsoft Learn

Solution architect

5Design impact

Shared or per companySystem-wide: an override applies to every task of the batch class in every company (the table is the batch class global configuration overrides). Microsoft Learn
Can it be undoneReversible: Change or delete the override at any time; it applies to retries after SQL transient connection errors from then on. Microsoft Learn
If you change it laterThe value set on this page takes priority over the value that the batch class sets in its code. Microsoft Learn
Technical architect

6Technical

Menu itemBatchClassConfigurationOverrides Checked in Dynamics 365
FormBatchClassConfigurationOverrides Checked in Dynamics 365
TableBatchClassConfigurationOverridesShown as “Batch class global configuration overrides” in Record infoChecked in Dynamics 365
Who can open itPrivilegesMaintain Batch class configuration overrides BatchClassConfigurationOverridesMaintainDutiesMaintain system settings SysServerSettingsMaintain
1 security roleInformation technology manager SysServerITManager
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itInformation technology manager SysServerITManagerGive people one of these roles. On this system, 1 role can open this page.Checked in Dynamics 365
Actions on the pageOptions: Personalize, Page options, ShareChecked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=BatchClassConfigurationOverrides
Data migrationLoad order: Batch class configuration overrides has no data entity in Data management, so it can't be loaded from a file or a configuration template. Add the overrides by hand in each environment.Checked in Dynamics 365
Everyone

8Sources