Add BoxTop milestone
Records a milestone on a job in Descartes BoxTop, and can notify the customer.
@lainstack/boxtop/write-milestone · TMS · Available on Lainstack Cloud
How to use it
Section titled “How to use it”Use Add BoxTop milestone to record a milestone on a job in Descartes BoxTop, such as a check that has been done.
Good to know:
- Date is written as YYYY-MM-DD and defaults to today in UTC. Anything else fails the step, in a draft too. Wired from an earlier step, it must be a date source: publish refuses plain text.
- Notify customer is off by default. When on, BoxTop sends the customer its own notification about this milestone. Lainstack doesn’t choose what it says or who receives it.
- If BoxTop refuses the milestone, the step fails with the HTTP status it answered and never its reply. A rate limit, server error or timeout fails the step and says the milestone may have landed.
- Running a step again: a step never repeats by itself, but a person or a resume can run it again. That can record it twice and, with Notify customer on, notify the customer twice. Check the job in BoxTop first.
- Draft runs: a draft run holds this block and shows the milestone as Would write, including whether it would notify the customer. Nothing is sent. With no pin and no earlier real run, the branch goes on with your Job number and Milestone, and sample is true.
- Sample data: a Sample data connection sends nothing, notifies nobody and answers with your Job number and Milestone. sample is true.
- Not checked against real BoxTop: this block has only run against the public docs, which date from about 2014. How the key is sent, how BoxTop treats a milestone name it doesn’t know, the value that turns notification on (the block sends -1, as BoxTop’s job sample does for its flags), and how a repeated milestone is treated are all unconfirmed.
Settings
Section titled “Settings”| 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. |
| Milestone (required) | milestone |
Text | |
| Comment | comment |
Text | Saved with the milestone. |
| Date | date |
Date | Written as YYYY-MM-DD. Leave empty for today. |
| Notify customer | notifyCustomer |
Yes or no | When on, BoxTop sends the customer its own notification about this milestone. Default false. |
Outputs
Section titled “Outputs”| Output | Path | Type |
|---|---|---|
| Job Number | jobNumber |
Text |
| Milestone | milestone |
Text |
| Sample | sample |
Yes or no |