Predefined Collection commands
Creating a Collection requires you to construct a command incorporating mandatory and optional parameters. Use the help text provided in the command to assist you with spacing and syntax.
You can create a trigger command to do any of the following actions on a Collection or a Contribution. Each command has its own parameter requirements as listed in additional tables.
Command |
Description |
Additional Information |
---|---|---|
Create new Collection instance |
Starts a new Collection. |
To add contributions to the Collection, you need to create a separate trigger for each Contribution. |
Start a Collection Contribution |
Flags work as a Contribution to a Collection. |
Requires an end command |
End an open Collection Contribution |
Ends a Contribution to a Collection. |
Once an end Contribution trigger command fires, the Contribution cannot be reopened. |
Add a new Collection / Contribution attribute |
Modifies an already open Collection / Contribution. |
You can use this to add additional parameters or values to the Collection / Contribution. Keep in mind this cannot be applied retroactively on any triggers which have already fired. |
Lock Collection |
Locks a Collection. |
Once a lock trigger fires, the Collection closes and cannot be reopened. No additional Contributions can be added. |
Rename an open Contribution |
Gives a new name to an open Contribution. |
Requires the named Contribution to be open (not ended) when the trigger fires. |
Attach a new application identifier to a Collection |
Changes the ID of a Collection. |
Requires the old ID and the new ID. Once the new ID is attached it can be used for additional contributions. |
Start a Contribution Parameters