Managing batches

A batch is a program that performs automatic processing based on a set up frequency. It can also be run manually. For examples, some batches prevent you from manually performing repetitive low value-added tasks. Others can link Akuiteo's data to other software programs or databases.

1 Go to Tools > Setup > Batches > Batch creation and modification.

The list of batches already created in Akuiteo opens.

2 In the action bar, click on .
3 In the New Batch screen, fill in the following fields:
Field Description
Batch template

Select the batch template from the drop-down list.

Depending on the selected template, the parameters displayed in the table are updated.
Code Enter a code to identify the batch. The code must be unique for each batch, all companies combined.
Label Enter a label to name the batch.
Restrict display to DMF Enter a DMF if you want to restrict access to the batch to certain users. Only users with the entered DMF will be able to display the batch.
Restrict parameter changing to DMF Enter a DMF if you want to restrict parameter modification to certain users. Only users with the entered DMF will be able to modify the batch parameters.
Restrict launch to DMF Enter a DMF if you want to restrict the execution of the batch to certain users. Only users with the entered DMF will be able to run the batch.
Parameters

The table displays the parameters available depending on the selected Batch template.

Some parameters are specific to each batch template but others are common and can be found in most batches. Those common parameters serve the same function regardless of the batch but their values are independent to each batch.

Double-click on each desired parameter and enter the needed value. All the required parameters must be specified.

Reference

For more information about batch parameters, refer to Setting up a batch.
4 In the action bar, click on .

The batch is created. You can now plan and run it.

1 In Tools > Setup > Batches > Batch creation and modification, search for the batch and open it.
2 In the action bar, click on .
3 Modify the desired information.

References

To modify the parameters of the batch, refer to Setting up a batch.

To plan the batch, refer to Planning a batch.

4 In the action bar, click on .

The batch is modified.

The parameters of the batch are gathered in the Parameters table of the Batch tab.

Some parameters are specific to each batch template but others are common and can be found in most batches. Those common parameters serve the same function regardless of the batch but their values are independent to each batch.

When a new template is selected, the list of parameters is updated.

Important

When selecting a new template, none of the values entered in the parameters of the former template is conserved.

All parameters contain the following data:

  • The Code is the unique ID of the parameter.
  • The Description indicates the use of the parameter and can specify the expected type of value.
  • The Value indicates the value used for the parameter during the batch execution. The possible values depend on the type of parameter.
  • The Type indicates the type of parameter and the possible values for this parameter. A parameter can only be of one unique type.
  • The Required? column indicates whether the parameter must be entered. The batch will not be able to run if there is no value entered for a required parameter.
1 Open the desired batch and click on in the action bar.
2 Double-click on the parameter to be modified.

The parameter window opens.

3 If needed, modify the Description.
4 Enter the desired value depending on the type of the parameter:
  • String: Enter a string of characters. For example: RESP_COM_AFF or support@akuiteo.com.
  • Date.
  • Number.
  • Boolean: Select True or False from the drop-down list.
  • List of values.
  • SQL request.

Important

An SQL query must be entered only if it is suggested by Akuiteo.

5 Click on Validate.
6 In the action bar, click on .

The parameter is modified and the batch is saved.

Note

A parameter could be missing after an Akuiteo update. In this case, it is possible to add a parameter by clicking on at the top right of the table. A parameter must be added only if it is suggested by Akuiteo.

It is also possible to delete a parameter by clicking on it then on at the top right of the table. A parameter must be deleted only if it is suggested by Akuiteo.

The following parameters are common and can be found in most batches. Those parameters always serve the same function regardless of the batch but their values are independent for each batch.

Code Description Type Required
BATCH_DEBUG_PARAMS

When the parameter is set to True, the parameters of the batch are displayed in log files.

Note

A log is a text file with the .log extension that is generated during each batch execution. It contains the history of all the operations performed during the batch execution. It can be opened with a text editor.

 Boolean No
BATCH_LOG_CONSOLE

When the parameter is set to True, the logs are displayed in the console and in the log file.

The console is a window used by developers that indicates Akuiteo's activity.

 Boolean No
BATCH_LOG_FILE Directory of the instance's server where the log file is saved.

String

Ex:
C:\AKUITEO\logs_batch

 No
BATCH_LOG_ID

Log file ID (name).

It is recommended not to use accents or spaces.

String

Ex: RelancesAutomatiques.log

 No
BATCH_LOG_LEVEL

Log level.

It is possible to choose a log level among the following ones:

  • ERROR: Only errors are present in the log file.
  • WARN: Errors and warnings are present in the log file.
  • INFO: Errors, warnings and information messages are present in the log file.
  • DEBUG: Debug messages, errors, warninAkuiteogs and information messages are present in the log file.

Important

The parameter must be modified only if it is suggested by Akuiteo because large files might be generated and overload the disk drive.

String

Ex: WARN

 No
BATCH_MAIL Email address of the logs' recipient in case of an error.

String

Ex: support@akuiteo.com

 Yes
BATCH_MAIL_CC Email address of the logs' cc recipient in case of an error.

String

Ex: support@akuiteo.com

 No
BATCH_MAIL_CCI Email address of the logs' bcc recipient in case of an error.

String

Ex: support@akuiteo.com

 No
BATCH_MAIL_FROM Email address of the logs' sender in case of an error.

String

Ex: support@akuiteo.com

 No
BATCH_MAIL_REPLY_TO

Email address of the recipient when replying to the email including logs in case of an error.

String

Ex: support@akuiteo.com

 No
BATCH_PWD

Password of the user who starts the batch. This password must be linked to the BATCH_USER specified.

In the table, * characters are displayed instead of the password.

String

Ex: aHFG45*F

 Yes
BATCH_USER

Login of the user who starts the batch.

The user must be in the company on which the batch is launched.

If the batch is set up on the ***** company, the user must also be from the ***** company.

String

Ex: TECH

 Yes

Planning a batch enables it to be run automatically at desired moments based on the specified planning parameters.

1 Open the desired batch and click on in the action bar.
2 In the Planning tab, select a planning mode among the five available:
  • Disabled : Enables you to disable planning. In that case, the batch can only be run manually.
  • Simple mode : Enables simple planning.
  • Scheduling : Enables the batch to be run before or after the execution of another batch.
  • Calendar mode : Enables the batch to be launched on precise dates without corresponding to a defined frequency.
  • Advanced mode : Enables you to specify advanced planning options.

Note

It is impossible to select multiple planning modes at the same time. For example, it is impossible to select Simple mode while using Calendar mode to also plan dates with the calendar.

3 Set up the planning according to the selected mode.

Note

For more information about setting up the planning, refer to the subsection corresponding to the selected planning mode.

4 In the action bar, click on .

The batch is planned.

During its creation, the batch is set to Disabled.

Check Disabled to disable the batch planning. With this mode, the batch can only be launched manually (refer to Running a batch manually).

Check the Simple mode to enable the simple planning of the batch.

This mode enables you to plan the execution of the batch or to apply a recurrence to it.

Examples

I want to run a batch every Sunday at 23:59:

  1. In the Recurrence drop-down list, I select Week.
  2. Among the days of the week, I check Sunday.
  3. In the Hour field, I select 23.
  4. In the Minute field, I select 59.

I want to run the batch every year, on December 31st at 00:00:

  1. In the Recurrence drop-down list, I select Year.
  2. In the Day field, I enter 31.
  3. In the Month drop-down list, I select December.
  4. In the Time field, I select 0.
  5. In the Minute field, I select 0.

Important

It is necessary not to run two batches of the same template at the same time, such as two RelanceAutomatiques batches planned at the same day and time. Malfunctions will occur.

In the same way, it is necessary not to define a frequency shorter than the time necessary for the execution of the batch. For example, if a batch has a running time of two hours, its execution must not be planned every hour.

Field Possible values
Recurrence

Select the pace of the recurrence from the drop-down list:

  • Never (disabled): Recurrence is disabled. The batch can only be run manually.
  • Only once: The batch is only run once on the specified date.
  • Week: The batch is run every week, on the day of the week and at the time specified.
  • Month: The batch is run every month, on the date and at the time specified.
  • Year: The batch is run every year, on the date and at the time specified.

Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

Only available for the Week recurrence.

Check one or more days of the week on which the batch runs.
Day

Only available for the Only once, Week, Month and Year recurrences.

Enter the number of the month's day during which the batch runs, from 1 to 31.

Important

If you enter a day's number greater than the number of days in the month, the batch will not run during that month.

For example, if you enter 31 and the month contains 30 days or less, the batch will not run during that month.
Month

Only available for the Only once, Week and Year recurrences.

Select the month during which the batch runs.
Year

Only available for the Only once, Week and Year recurrences.

Select the year during which the batch runs.
Hour and Minute

Available for the Only once, Week, Month and Year recurrences.

Select the hour and minute at which the batch runs.

Under the Scheduling option, it is possible to specify the following field:

Field Possible values
Next batch

Select a batch from the drop-down list. The list contains all the batches created in Akuiteo.

After the execution of the current batch, the batch selected in the list runs automatically.
Run the next batch even if the status of the current batch is FAILED

If the box is checked, the next batch runs even if the current batch is in a FAILED status.

If the box is not checked, the next batch does not run if the current batch is in a FAILED status.

Tip

When you save the batch, the specified planning options are displayed in the Advanced mode part. This can be useful to check the modifications you made.

Check Scheduling to enable the batch to run before or after the execution of another batch.

Option Description
Next batch

Select a batch from the drop-down list. The list contains all the batches created in Akuiteo.

After the execution of the current batch, the batch selected in the list runs automatically.
Start the next batch even if the status of the current batch is FAILED

If the box is checked, the next batch runs even if the current batch is in a FAILED status.

If the box is not checked, the next batch does not run if the current batch is in a FAILED status.
Previous batch

Select a batch from the drop-down list. The list contains all the batches created in Akuiteo.

After the execution of the batch selected in the list, the current batch runs automatically.
Start this batch even if the status of the previous batch is FAILED

If the box is checked, the current batch runs even if the previous batch is in a FAILED status.

If the box is not checked, the current batch will not run even if the previous batch is in a FAILED status.

Check Calendar mode to plan the execution of the batch on fixed dates. Dates are specified in the Calendar tab of the batch page. They can also be added with an API.

1 Click on the Calendar tab.
2 At the top of the Batch scheduling table, click on .
3 In the input field, click on .

A calendar opens.

4 Select the desired date and time.

Important

It is impossible to enter a date earlier than the date of the last batch execution.

The date and time are displayed in the field.

5 In the action bar, click on .

The batch is planned on the specified dates. The following table summarizes the meaning of the icons:

Icon Description
No icon The batch will run on this date but at least another earlier date is scheduled.
The batch will run the next time on this date.
The batch ran on this date.

Note

If the calendar mode is disabled and dates are scheduled in the Batch scheduling tab, the batch will not run on the scheduled dates.

If the batch is already running when a planned date and time is reached, the batch will not run once again.

Under the Scheduling option, it is possible to specify the following field:

Field Possible values
Next batch

Select a batch from the drop-down list. The list contains all the batches created in Akuiteo.

After the execution of the current batch, the batch selected in the list runs automatically.
Run the next batch even if the status of the current batch is FAILED

If the box is checked, the next batch runs even if the current batch is in a FAILED status.

If the box is not checked, the next batch does not run if the current batch is in a FAILED status.

Check Advanced mode to set advanced planning options. The advanced mode uses Unix cron syntax.

Important

It is necessary not to run two batches of the same template at the same time, such as two RelanceAutomatiques batches planned at the same day and time. Malfunctions will occur.

In the same way, it is necessary not to define a frequency shorter than the time necessary for the execution of the batch. For example, if a batch has a running time of two hours, its execution must not be planned every hour.

The fields must be filled in the following way:

Field Possible values
Second

[0-59] , - / *
Minute

[0-59] , - / *
Hour

[0-23] , - / *
Day of the month

[1-31] , - / * ? L W
Month

[0-11] {JAN,MAY,.} , - / *
Day of the week

[1-7] {MON,WED,.} , - / * ? L Hash

1 is for Sunday, 2 for Monday, and so on.
Year

Empty [1970-2099] , - / *

Special characters are used in the following ways:

Character Description Example
, Enables you to enter multiple values.

I want to run the batch on the 1st and the 15th of every month:

  • In the Day of the week field, I enter 1,15.
- Enables you to enter the interval between two values (From X to X).

I want to run the batch every month from January to June:

  • In the Month field, I enter: 1-6 which corresponds to the values 1, 2, 3, 4, 5, 6.
/

Enables you to increment from a starting value.

I want to run the batch every 15 minutes:

  • In the Minute field, I enter 0/15 which corresponds to the values 0, 15, 30, 45.

I want to run the batch every 10 minutes:

  • In the Minute field, I enter 0/10 which corresponds to the values 0, 10, 20, 30, 40, 50.

I want to run the batch every 20 minutes starting from the 3rd minute:

  • In the Minute field, I enter 3/20 which corresponds to the values 3, 23, 43.
* Enables you to select all values possible for the field.

I want to run the batch every month:

  • In the Month field, I enter * which corresponds to the values from 1 to 12.
?

Enables you to either select the day of the month or the day of the week:

  • To select the day of the month, enter ? in the Day of the week field.
  • Conversely, to select the day of the week, enter ? in the Day of the month field.

I want to run the batch on the first day of every month:

  • In the Day of the month field, I enter 1.
  • In the Day of the week field, I enter ?.
L

Corresponds to the last possible value of the field:

  • If it is entered on its own in the Day of the month field, the last day of the month is selected.
  • If it is entered on its own in the Day of the week field, the last day of the week is selected (7 or Saturday).
  • If it is entered right after another value, the last of that value is selected.

I want to run the batch on the last day of the month:

  • In the Day of the month field, I enter L.
  • In the Day of the week field, I enter ?

I want to run the batch on the last Friday of the month:

  • In the Day of the week field, I enter 6L.
  • In the Day of the month field, I enter ?.
W Enables you to select the nearest day of the week excluding weekends.

I want to run the batch starting from the 10th day of every month. However, the batch must not be run during the weekend.

  • In the Day of the month field, I enter 10W. Therefore, if the 10th falls on a Saturday or Sunday, the batch will run on Monday.
# Enables you to select the umpteenth day of the week in the month.

I want to run the batch on the third Wednesday of the month:

  • In the Day of the week field, I enter WED#3.

Tip

In the Planning tab, two links are available at the top right: Help and Documentation. Those links redirect to resources for more information about the syntax.

Under the Scheduling option, it is possible to specify the following field:

Field Possible values
Next batch

Select a batch from the drop-down list. The list contains all the batches created in Akuiteo.

After the execution of the current batch, the batch selected in the list runs automatically.
Run the next batch even if the status of the current batch is FAILED

If the box is checked, the next batch runs even if the current batch is in a FAILED status.

If the box is not checked, the next batch does not run if the current batch is in a FAILED status.

You can run a batch at any moment, for example when you do not need the batch to be planed or when you want to test the batch to know if it works correctly. The manual running can be done in addition to another scheduling.

1 Go to Tools > Setup > Batches > Batch (execution reports).

The list of batches already created and set up opens.

2 Right-click on the line of the desired batch.
3 Click on Run.

The batch is executed in the background.

When the process is done, the Status column is displayed:

  • COMPLETED if the process finished without error.
  • FAILED if the process failed.

When a batch is running, it is possible to stop it at any time, for example if you realize the batch was not set up correctly.

1 Go to Tools > Setup > Batches > Batch (execution reports).

The list of batches already created and set up opens.

2 Right-click on the line of the batch you want to stop.
3 Click on Stop the processing.

The batch stops running.

1 Go to Tools > Setup > Batches > Batch (execution reports).
2 In the Batches table, double-click on the desired batch.

The list of execution reports for the selected batch is displayed.

3 Double-click on the line of an execution.

The execution report of the batch opens.

Important

Deleting a batch cannot be reversed.

From the batch, click on in the action bar and confirm the deletion.