Get the scripts
Download the sandbox scripts bundle and set it up.
Download the sandbox scripts
One zip with everything you need — the scripts, the sample data and the configuration file.
Unzip the bundle
Unzipping creates a folder with the scripts, the sample data and config.env at the top — this is the folder every command below runs from.
Open a terminal in that folder
Open your terminal and cd into the unzipped folder.
Right-click inside the folder in File Explorer and choose Git Bash Here (installed with Git for Windows).
Every command below runs from this folder.
Get your account
Open config.env, in that same folder:
open -e config.envnano config.envSave and exit: Ctrl+O, Enter, Ctrl+X.
notepad config.envFill in SUPPLY_CHAIN_NODE_URL, SUPPLY_CHAIN_USER_NAME, SUPPLY_CHAIN_USER_PASSWORD and SUPPLY_CHAIN_ORGANIZATION_IDENTITY with the credentials the TWIN team gave you, then save.
Follow your role tutorial
- Freight Forwarder — publish the consignment lifecycle
- Location Operator — read the consignment and send the match back
- Border Agency — verify ISN signals and read the consignment
What's inside
| File | Purpose |
|---|---|
README.md | The same instructions as these pages, for offline reference |
config.env | The configuration file — fill in your credentials here |
fetch-consignment.sh | Reads a consignment and downloads its documents |
freight-forwarder/publish-consignment.sh | Publishes the full consignment lifecycle |
location-operator/send-match.sh | Sends the match back to TWIN |
data/consignment-lifecycle.template.ndjson | The sample lifecycle data the freight forwarder publishes |
shared/common.sh | Shared helpers used by the other scripts |
bin/ | Bundled jq, used automatically if your system doesn't have one |