[In Progress] Workflow's Environment Variables

Definition

By default, every Task that runs generates a series of environment variables. These variables are invisible in the sense that you'll never see them in the platform but they can always be accessed by your scripts.

These environment variables can help your scripts be context-aware as they run, giving knowledge into the structure and placement of the Task in relation to other Tasks

original marketplace Variables = Marketplace Variables

Environment Variable Type	Variable Name	Example (these are not real)	Definition
Alli Client Cred S3 information:	`ALLI_S3_BUCKET`	something-123ab321-ct94-09p3-c74d-520e7e2c7py3	Used to read and write files to a client’s s3 bucket: how to
	`ALLI_S3_KEY_PREFIX`	source=app/app=something/-
	`ALLI_S3_KEY_TEMP_PREFIX`	source=app/app=something/temp=true/exec=913c104v-a385-30ge-9fa7-3p12owg2ef3a/
	`AWS_ACCESS_KEY_ID`	PASHQT8HPAUNWW3LRPRA
	`AWS_SECRET_ACCESS_KEY`	AxUAQhO9Kj0/SNE7YNUnpElbvv0EP3U8N6N1eP817
Alli Client Cred Redshift information . How To	ALLI_DATA_REDSHIFT_URL
	ALLI_DATA_REDSHIFT_HOST
	ALLI_DATA_REDSHIFT_PORT
	`ALLI_DATA_REDSHIFT_DATABASE`	`datawarehouse`
	ALLI_DATA_REDSHIFT_USER	`alliclient_acme_ijpm`
	ALLI_DATA_REDSHIFT_PASSWORD	\|_;9OI1`2=,nq12xP&Me”PWCW:N,Xv{WO
	ALLI_DATA_REDSHIFT_IAM_ROLE	`arn:aws:iam::123456789101:role/datawarehouse-staging-client-creds@PMG,arn:aws:iam::1234567891011:role/alliprod_123ab456-ib78-91z9-q12b-123e3m9r55f3_forklift`
	`ALLI_DATA_REDSHIFT_KMS_KEY_ID`	`3p9d871e-123a-4bc5-6def7-8hi910jkl11m`
Alli Client Information	ALLI_CLIENT_ID
	ALLI_CLIENT_SLUG
	ALLI_CLIENT_TIMEZONE
Dividing Logs. How To	`LOG_BREAK`
Alli OAUTH variables. How To	`ALLI_OAUTH_TOKEN`
Alli OAUTH variables. How To	`ALLI_OAUTH_TOKEN_TYPE`
Google Cloud information. How To. For Google Sheets	`ALLI_GOOGLE_CLOUD_CREDENTIALS`
Google Cloud information. How To. For Google Sheets	`ALLI_GOOGLE_CLOUD_PROJECT`
Task Run Execution Details	`MARKETPLACE_TASKRUN_START_TIME_DAY`	`08`	The day of the Task start time in format 01-31.
	`MARKETPLACE_TASKRUN_START_TIME_HOUR`	`19`	The hour of the Task start time in format 0-23.
	`MARKETPLACE_TASKRUN_SCHEDULED_TIME`	`2025-05-08T19:31:22Z`	The time at which the Task started running. Formatted using the RFC3339 standard.
	`MARKETPLACE_TASKRUN_START_TIME_MINUTE`	`31`	The minute of the Task start time in format 0-59.
	`MARKETPLACE_TASKRUN_START_TIME_YEAR`	`2025`	The year of the Task start time.
	`MARKETPLACE_TASKRUN_START_TIME_SECOND`	`29`	The second of the Task start time in format 0-59.
	`MARKETPLACE_TASKRUN_START_TIME_MILLISECOND=892`	`892`	The millisecond of the Task start time in format 0-999.
	`MARKETPLACE_TASKRUN_START_TIME_EPOCH`	`1670443778`	The number of seconds since the Unix epoch.
Workflow Run Execution Details	`MARKETPLACE_WORKFLOWRUN_START_TIME_YEAR`	`2025`	The year of the Task start time.
	`MARKETPLACE_WORKFLOWRUN_START_TIME`	`2025-05-08T19:31:29Z`	The time at which the Workflow started running. Formatted using the RFC3339 standard.
	`MARKETPLACE_WORKFLOWRUN_START_TIME_HOUR`	`19`	The hour of the Workflow start time in format 0-23.
	`MARKETPLACE_WORKFLOWRUN_START_TIME_SECOND`	`29`	The second of the Workflow start time in format 0-59.
	`MARKETPLACE_WORKFLOWRUN_START_TIME_DAY`	`08`	The day of the Workflow start time in format 01-31.
	`MARKETPLACE_WORKFLOWRUN_START_TIME_MILLISECOND`	`892`	The millisecond of the Workf.ow start time in format 0-999.
	`MARKETPLACE_WORKFLOWRUN_START_TIME_MONTH`	`05`	The month of the Vessel start time in format 01-12.
	`MARKETPLACE_WORKFLOWRUN_SCHEDULED_TIME`	`2025-05-08T19:31:22Z`	The time at which the Workflow started running. Formatted using the RFC3339 standard.

[old] Shipyard Variables (needs update)

Click here to expand...

Name	Example	Definition
`SHIPYARD_ORG_ID`	`5c35c2da-a9a5-472a-a215-29b616ebc2c9`	Set to the UUIDv4 of the Organization that the Vessel belongs to.
`SHIPYARD_ORG_NAME`	`Platform`	Set to the name of the Organization that the Vessel belongs to.
`SHIPYARD_PROJECT_ID`	`03cf3d8b-95c0-4b6c-8d57-be58c252c4be`	Set to the UUIDv4 of the Project that the Vessel belongs to.
`SHIPYARD_PROJECT_NAME`	`Platform Tutorials`	Set to the name of the Project that the Vessel belongs to.
`SHIPYARD_BLUEPRINT_ID`	`d07f3355-ab62-479b-8756-27c7cbf48907`	Set to the UUIDv4 of the Blueprint that the Vessel is built from. In the case of a Code Vessel, the ID will not be UUIDv4.
`SHIPYARD_BLUEPRINT_NAME`	`Print Text`	Set to the name of the Blueprint that the Vessel is built from.
`SHIPYARD_VESSEL_ID`	`20e347ff-fe74-43dc-8f38-6a31910c0533`	Set to the UUIDv4 of the Vessel that the Log belongs to.
`SHIPYARD_VESSEL_NAME`	`Hello, World`	Set to the name of the Vessel that the Log belongs to.
`SHIPYARD_LOG_ID`	`c81a050c-5caf-445c-90d0-dc3b761979b0`	Set to the UUIDv4 of the current Log that is running.
`SHIPYARD_LOG_WORKDIR`	`/home/shipyard`	Set to the working directory that your Vessel is set to do its work in.
`SHIPYARD_REPO_NAME`	`example-repo`	Set to the name of the Git repository selected for Code. Only set when the Vessel is connected to Git.
`SHIPYARD_CLONE_LOCATION`	`/home/shipyard/example-repo`	Set to the directory where the Git repository root was cloned. Only set when the Vessel is connected to Git.
`SHIPYARD_VESSEL_START_TIME`	`2021-03-12T21:22:47Z`	The time at which the Vessel started running. Formatted using the RFC3339 standard.
`SHIPYARD_VESSEL_SCHEDULED_TIME`	`2021-03-12T21:22:00Z`	The time at which the Vessel started running. Formatted using the RFC3339 standard.
`SHIPYARD_VESSEL_START_TIME_YEAR`	`2022`	The year of the Vessel start time.
`SHIPYARD_VESSEL_START_TIME_MONTH`	`12`	The month of the Vessel start time in format 01-12.
`SHIPYARD_VESSEL_START_TIME_DAY`	`07`	The day of the Vessel start time in format 01-31.
`SHIPYARD_VESSEL_START_TIME_HOUR`	`14`	The hour of the Vessel start time in format 0-23.
`SHIPYARD_VESSEL_START_TIME_MINUTE`	`34`	The minute of the Vessel start time in format 0-59.
`SHIPYARD_VESSEL_START_TIME_SECOND`	`12`	The second of the Vessel start time in format 0-59.
`SHIPYARD_VESSEL_START_TIME_MILLISECOND`	`434`	The millisecond of the Vessel start time in format 0-999.
`SHIPYARD_VESSEL_START_TIME_EPOCH`	`1670443778`	The number of seconds since the Unix epoch.

Fleet Environment Variables

When a Vessel is run as part of a Fleet, the following Environment Variables will be available. For an overview of Upstream, Currentstream, and Downstream read our Glossary of Terms.

Name	Example	Definition
`SHIPYARD_FLEET_ID`	`32f0f12f-8f68-46fd-b3ab-eeddce439f49`	Set to the UUIDv4 of the Fleet that the Vessel belongs to.
`SHIPYARD_FLEET_NAME`	`ETL Workflow`	Set to the name of the Fleet that the Vessel belongs to.
`SHIPYARD_FLEET_LOG_ID`	`ac0332d3-2420-4e8e-a58c-dfe78ae5bdf0`	Set to the UUIDv4 of the current Fleet Log that is running. This ID will be constant for all Vessels in the current run.
`SHIPYARD_FLEET_CURRENTSTREAM_INDEX`	`0`	The position of the current Vessel in the currentstream. This value is 0 based. Useful for splitting tasks into chunks dynamically and consistently.
`SHIPYARD_FLEET_UPSTREAM_COUNT`	`2`	The number of Vessels that ran upstream.
`SHIPYARD_FLEET_CURRENTSTREAM_COUNT`	`2`	The number of Vessels running in the currentstream.
`SHIPYARD_FLEET_DOWNSTREAM_COUNT`	`2`	The number of Vessels that will run downstream.
`SHIPYARD_FLEET_UPSTREAM_LOG_IDS`	`46a41790-310b-4627-b1b7-492c6c042538,b93766e0-e89b-49d9-ae15-6045e9387b3c`	A comma-separated list of Log IDs from Vessels that ran upstream. The order of the IDs will match the corresponding upstream environment variables, but may change with every run.
`SHIPYARD_FLEET_CURRENTSTREAM_LOG_IDS`	`c930d35f-4396-4316-8d3b-c1ed5a1f100f,524bf2c7-18fa-47a1-bb3b-16bf487a45a9`	A comma-separated list of Log IDs from Vessels that are running in the currentstream. The order of the IDs will match the corresponding currentstream environment variables, but may change with every run.
`SHIPYARD_FLEET_DOWNSTREAM_LOG_IDS`	`48542f9d-fa9f-4a77-810b-417eab4fe810,030f7490-36c9-446c-9f84-5aceb03176dd`	A comma-separated list of Log IDs from Vessels that will run downstream. The order of the IDs will match the corresponding downstream environment variables, but may change with every run.
`SHIPYARD_FLEET_UPSTREAM_VESSEL_IDS`	`38621a35-8c94-4e41-817a-8ff2587a871d,7700aea1-599a-486d-be32-09fcb200cdce`	A comma-separated list of Vessel IDs from Vessels that ran upstream. The order of the IDs will match the corresponding upstream environment variables, but may change with every run.
`SHIPYARD_FLEET_CURRENTSTREAM_VESSEL_IDS`	`02ce1830-14a1-4d6b-ada1-ea39e8add14f,83ca8dcb-b2b7-4456-bbe0-ab550db98bb5`	A comma-separated list of Vessel IDs from Vessels that are running in the currentstream. The order of the IDs will match the corresponding currentstream environment variables, but may change with every run.
`SHIPYARD_FLEET_DOWNSTREAM_VESSEL_IDS`	`8934f43f-413a-4bc9-b267-0924035e3459,aa0c6a42-c61d-4f15-b54a-75247c4281da`	A comma-separated list of Vessel IDs from Vessels that will run downstream. The order of the IDs will match the corresponding downstream environment variables, but may change with every run.
`SHIPYARD_FLEET_START_TIME`	`2021-03-12T21:22:47Z`	The time at which the Vessel started running. Formatted using the RFC3339 standard.
`SHIPYARD_FLEET_SCHEDULED_TIME`	`2021-03-12T21:22:00Z`	The time at which the Vessel started running. Formatted using the RFC3339 standard.
`SHIPYARD_FLEET_START_TIME_YEAR`	`2022`	The year of the Fleet start time.
`SHIPYARD_FLEET_START_TIME_MONTH`	`12`	The month of the Fleet start time in format 01-12.
`SHIPYARD_FLEET_START_TIME_DAY`	`07`	The day of the Fleet start time in format 01-31.
`SHIPYARD_FLEET_START_TIME_HOUR`	`14`	The hour of the Fleet start time in format 0-23.
`SHIPYARD_FLEET_START_TIME_MINUTE`	`34`	The minute of the Fleet start time in format 0-59.
`SHIPYARD_FLEET_START_TIME_SECOND`	`12`	The second of the Fleet start time in format 0-59.
`SHIPYARD_FLEET_START_TIME_MILLISECOND`	`434`	The millisecond of the Fleet start time in format 0-999.
`SHIPYARD_FLEET_START_TIME_EPOCH`	`1670443778`	The number of seconds since the Unix epoch.
`SHIPYARD_WEBHOOK_HEADERS_FILE`	`/home/shipyard/2560137a-5360-4561-8bfb-810280dce3f0.webhook_headers`	The path to the file that will be optionally created if headers are provided in the webhook invocation.
`SHIPYARD_WEBHOOK_BODY_FILE`	`/home/shipyard/2560137a-5360-4561-8bfb-810280dce3f0.webhook_body`	The path to the file that will be optionally created if a body is provided in the webhook invocation.

Definition​

Fleet Environment Variables​

Definition

Fleet Environment Variables