Get BoxTop job documents

Downloads the documents published to an account on a Descartes BoxTop job, as files later steps can read.

@lainstack/boxtop/get-job-documents · TMS · Available on Lainstack Cloud

How to use it

Use Get BoxTop job documents to download the documents on a job in Descartes BoxTop, so later steps can read them or send them on.

Good to know:

BoxTop only lists documents published to the account you enter, so an empty list does not prove the job has no documents. The block leaves on Out either way.
Name contains keeps documents with that text in their name or file name, ignoring case.
Most documents takes 1 to 32 and defaults to 10, and keeps the newest by stored date. foundCount says how many matched, and truncated is true when some were left out. A number outside the limits fails the step.
files lines up with documents. A PDF or image gets its type from its file name, so an Agent can read it if its model takes that type. An Agent takes at most 10 files.
Each document can be up to 10 MB. A larger one fails the step, and so does a listed document BoxTop does not return.
Downloads run one at a time, for up to 4 minutes. After that the step fails and says how many came down. Lower Most documents or use Name contains.
A draft run calls this block for real, because it only reads. It changes nothing in BoxTop.
A Sample data connection answers from a fixed set of fictional records and calls nothing, so you can build and run an automation before you have a BoxTop key. sample is true on those answers.
If BoxTop refuses the request or does not accept the key, the step fails with the HTTP status and never shows BoxTop’s reply. A rate limit or server error also fails the step, and is worth trying again. Each request has 30 seconds to finish.

Setting	Key	Type	Details
BoxTop connection (required)	`credentialId`	Connection	Use a Sample data connection until you have a BoxTop key. At most 160 characters.
Job number (required)	`jobNumber`	Text	The BoxTop job, up to 12 characters. Find or create BoxTop job returns it.
Account number (required)	`accountNumber`	Text	The customer’s BoxTop account, up to 8 characters. BoxTop only lists the documents published to this account.
Name contains	`nameContains`	Text	Optional. Keeps documents with this text in their name or file name.
Most documents	`mostDocuments`	Number	How many of the newest documents to download, from 1 to 32. Defaults to 10.