Batch Management

Large amounts of similar data are managed in batches or large groups. Any actions or components that are automated, such as incentives or rewards, are handled in batches to ensure that all applicable fields and parts are updated with the same information at the same time. This provides a more reliable way of managing these fields.

There are some batches that are handled in the background, but you can manage the majority of batch files. You can review the full list of available batches at the bottom of this page.

Keep this in mind as you start managing your batches - there are some that you can just leave alone and they will work just fine. For the rest of the batches, you can easily update or make changes as needed.

By default, batch processes automatically run daily at midnight, but you can change how many times each process runs within the week or month, and when it will run. You can also create and delete a new one. For example, if you need to delay or interrupt the evaluation of levels for some time, you can go in and make the change. You can also force a manual running of batches.

Let's take a look at how you can run, postpone, and manage your batches.

Review and Update Scheduled Batches

When you install Fielo, there are a number of batches that are automatically scheduled to run. You can view them all by going to Setup > Schedule Jobs. All of the existing batches are listed here.

This is also where you will return if you want to make changes to your batches.

Add an Existing Batch to the Schedule

Since you are likely to need your own batches based on incentives, rewards, courses, and other custom elements, you are able to customize batches to manage your data.

1. Go to Setup.
2. Find Apex Classes and click on the Schedule Apex button.
3. Enter a job name that will be easy to identify as the batch you want to run. For the apex class, refer to this page to know their API names and description.
4. Select the following:
   a. The apex class for the batch
   b. The frequency for the desired execution of the process
   c. The start and end date
   d. The time that it will run
5. Click the Save button.

Manually Running Your Batches

Occasionally you will probably need to run a batch or two outside of a regular schedule. The following steps will take you through the quick process to manually run whatever batch you need to clean up your data.

1. Select Batch Management to access batch data and manually run batches for programs with Online Processing disabled. You can also access the batch management page from the Tools tab.

2. Click Run.

Add Your Own Batches

You can add your own custom batch to the batch management page, by creating a new static resource in your Org.

1. Prepare a JSON file that will be used to create the batch. It must have the same format as the following example:

[
    {
        "className": "FieloPLT.UpdateEventsValue",
        "label": "Increment Events Value",
        "description": "Batch to increment all events value by 1 (one)",
        "confirm": "Are you sure?",
        "type": ["BatchApex"]
    }
]

2. Make sure that the className includes the namespace (if the Org has one), that the class you are using is global - so that Fielo package can interact with it -, and the Type must be ["BatchApex"]. You can enter whatever information you would like in the other inputs.

The attribute confirm allows you to add a message that will appear when the user clicks on Run. Use this to confirm that they want to run the batch or to give a warning.

Other than that, the JSON file can contain a list of batches, in this format:

[
    {batch_1},
    {batch_2},
    {batch_3}
]

3. Go to your Org's Setup and enter "static resources" in the Quickfind box.

4. Click on New and fill out the form with this information:
   a. Name: CustomBatches
   b. Description: FieloPLT-Batches
   c. Cache Control: public
   d. File: [select the JSON file that you created]

5. Click the Save button.

Managing Batches for Challenges

Batches have been created to help you scale your challenges. There are three batches related to challenges:

• Challenge Status moves the challenge status from Active to Ended on the challenge end date.
• For challenges that include leaderboards, Challenge Leaderboard updates participating members' leaderboard rankings and scores.
• Process Challenge Rewarding issues rewarding to members who have participated and earned rewards.

You can make sure that the batches have run on the Closing Status tab of a Challenge record page. Both the Challenge Status and the Process Challenge Rewarding batches appear here, as well as the Challenge Leaderboard batch, if applicable. This lets you quickly check whether the appropriate batches have run once a challenge has ended.

📘

Batch Scheduling for Challenges with Leaderboards

If using leaderboards in any of your Challenges, be sure to schedule the Challenge Leaderboard batch to run before the Challenge Status batch (for example, one day prior).

Resetting the Batch Schedule

You can reset the Fielo scheduled batches to package defaults. To do so, navigate to the Fielo Batch Jobs page and, inside the gear menu, select Reset Schedulers.

Fielo Batch List