Incent Create Batches
Summary
Use the incent create batches command to register new sales order batches within Incent (xactly.xc_user_batch).
Sales order batches allow Incent to group individual sales orders into common processing buckets. Incent requires every sales order row to be assigned to an order batch. Incent uses batch names to group transactions together to optimize processing in Incent’s processing queue. Xactly recommends limiting the number of orders in a batch to 20,000 rows. Please contact Xactly’s technical support team for additional guidance if you wish to use larger batch sizes.
Batches are categorized into Batch Type. Batch types allow you to define a label and group order/transaction batches for calculation with process groups. Batch types are generally used to identify and group batches that should be processed together. They are used in process groups to allow you to create a defined order in which you process your batches.
Incent Admin Guide: https://helpcenter.xactlycorp.com/article/configure-batch-type-2/
Subsequent operations in Incent such as purging batches and calculating credits and incentives take batch name as a parameter to determine which sets of sales orders to process.
Syntax
incent [synchronous] create batches [(Batches=(<query_result_set>))]; |
Parameters
|
Parameter
|
Description
|
|
|---|---|---|
[synchronous] |
(Optional) If the synchronous parameter is used, Connect will not return control to the calling client until the command completes execution. Otherwise, Connect runs the command asynchronously on the Connect server by default. Use SHOW INVOCATIONS and SHOW INVOCATION DETAILS to check the command’s processing status. |
|
[Batches=(<query_result_set>)] |
(Optional) A query that returns one or more distinct rows with the following columns in the listed order:
The command will ignore any batches that already exist in Incent. A given batch name cannot be assigned to more than one period name or batch type name. If the |
|
Details
Ensure you have registered a valid Incent username and password within Connect before invoking the upload command. incent commands require valid credentials to modify data with Incent. Refer to INCENT CREDENTIAL.
A batch name must be registered within Incent before any staging sales orders assigned to the batch can be uploaded into Incent. Refer to INCENT UPLOAD ORDERS.
Xactly recommends assigning a maximum of 20,000 sales order rows per batch. Please contact Xactly Customer Support if your implementation requires larger batch sizes.
Examples
incent create batches;
incent create batches (Batches=(select distinct batch_name, period_name, batch_type_name from staging.order_item));
Related Commands
INCENT CREDENTIAL