How Do I Create a Simple Batch Program? (Magic xpa 3.x)

There are two kinds of simple batch programs:

• Programs that cycle through all the records in a data source, commonly to export them to a file. You can create these easily using the program generator (Ctrl+G).See How Do I Create Tasks that Dump Data Records Into Flat Text Files and Vice Versa?.

• Programs that cycle once, usually to return a value. We’ll cover how to create these kinds of programs here.

Creating a simple batch program

1. In the Program repository, press F4 to open up a line.

2. Give your program a name. This name is not used by Magic xpa, so you can use any naming convention you like.

3. Zoom (F5) on the program name. Because this is a new program, you will see the Task Properties dialog box.

4. By default, the Initial mode is Modify. This is generally what you want. If you use Query, no records will be updated.

5. Select Task type Batch.

6. Select End task condition Yes. This will prevent the task from looping forever. Instead, it will only loop once. If you want it to loop some number of times, you can zoom here and enter an expression to control when the task exits.

7. Select Evaluate condition After updating record.

Since this is a batch program, by default no screen will show to the user. If it is a long process, you may want to show some “processing ...” window.

Now you can create your logic to do whatever you want to do. You may want to update records, or pass back data in parameters or, as shown here, in a return value.

See also

How Do I Export Data into a Text File?

How Do I Set a Program to Return a Value to the Calling Program?

The Online and Rich Client Samples projects (program TS06 and RTS06)