Copies Parameter Explained
When there is only one location/fund/copies tuple within the allocation array for an order, you should not specify a global copies parameter (Z) outside of the allocation array. In this case, the only copies value should be specified along with the location and fund within the allocation array.
When there is more than one location and fund within an allocation array for an order, it is suggested that you specify copies for each location and fund within the allocation array and set the global copies parameter (Z) to be the sum of all of the copies parameters within the allocation array (e.g., Z = a + b + c). There is a complex set of rules that are followed when the global copies parameter (Z) is not equal to the sum of all the copies parameters listed within the allocation array. Therefore, it is simpler if you explicitly set the global copies parameter (Z) to be equal to the sum of all the copies parameters within the allocation array so that the allocation rules are not applied.
In the event that the global copies parameter (Z) is not equal to the sum of all the copies parameters listed within the allocation array (a, b, and c), the following table shows how the allocation rules are applied.
|
{ "login":"acqstaff", "copies": Z, "allocation":[ { "location":"00", "fund":"acfic" "copies": a }, { "location":"00aca", "fund":"acnf" "copies": b }, { "location":"00ar", "fund":"jcpb" "copies": c } ], "vendor":"vend1" } Z, a, b, c are integers > 0 |
| Scenarios | #Example Values | #Copies Placed in New Order Record |
|---|---|---|
| If Z > a + b + c | Z = 10, a = 4, b = 3, c = 1 | a = 6, b = 3, c = 1 |
| If Z = a + b + c | Z = 8, a = 4, b = 3, c = 1 | a = 4, b = 3, c = 1 |
| If Z < a + b + c | Z = 5, a = 4, b = 3, c = 1 | a = 4, b = 1, c = 0 |
| If a not provided | Z = 10, b = 3, c = 1 | a = 1, b = 3, c = 6 |
|
If b not provided |
Z = 10, a = 4, c = 1 | a = 4, b = 1, c = 5 |
| If c not provided | Z = 10, a = 4, b = 3 | a = 4, b = 3, c = 3 |
| If a and b not provided | Z = 10, c = 1 | a = 1, b = 1, c = 8 |
| If a and c not provided | Z = 10, b = 3 | a = 1, b = 3, c = 6 |
| If b and c not provided | Z = 10, a = 4 | a = 4, b = 1, c = 5 |
| If a, b and c not provided | Z = 10 | a = 1, b = 1, c = 8 |
| If Z not provided, then no order will be placed, regardless of what values are assigned to a, b, or c. | a = 4, b = 3, c = 1 | No order will be placed |
