Queue Vault Job

Description

The QueueVaultJob node submits a new job to the Autodesk Vault Job Processor queue.
It allows workflows to programmatically create Vault jobs for files, items, folders, or custom objects — automating processes such as PDF creation, DWF publishing, property synchronization, or custom Vault extensions.

This node uses the active Vault connection established through the AutodeskVault dependency in the workflow environment.

---

How It Works

1. Validates core inputs such as Item Type and Job Name.
2. Uses the connected Vault session to identify the target object (file, item, folder, or custom object).
3. Checks for existing jobs with the same name and object to prevent duplicates.
4. Queues a new Vault job using the appropriate API method based on the selected object type.
5. Returns job details, including Job ID, Job Name, and associated object metadata.

---

Supported Item Types

Item Type	Description	Required Identifier
FILE	Queues a job against a Vault file (e.g., Publish PDF, Update DWF).	File Identifier (Vault file path or ID)
ITEM	Queues a job against a Vault item (e.g., Update Item Lifecycle).	Item Identifier (Vault item number or ID)
FOLDER	Queues a job against a Vault folder.	Folder Identifier (Vault folder path or ID)
CUSTOM	Queues a job against a Vault custom object type.	Custom Object Identifier
OTHER	Queues a job not linked to any specific object.	(None)

---

Input Fields

Field	Type	Description	Required
Item Type	Picklist	Type of Vault object to target (FILE, ITEM, FOLDER, CUSTOM, OTHER).	✅
Job Name	Text	The name of the Vault job type (as defined in Job Processor).	✅
Job Description	Text	Description for the queued job. Defaults to "Job created by workflow automation".	❌
Job Priority	Number	Priority of the job in the queue (1–1000). Default = 100.	❌
Custom Parameters	Dictionary	Key-value pairs for job parameters (optional).	❌

When Item Type = FILE

Field	Type	Description	Required
File Identifier	Text	Vault file path or unique identifier.	✅

When Item Type = ITEM

Field	Type	Description	Required
Item Identifier	Text	Vault item number or unique identifier.	✅

When Item Type = FOLDER

Field	Type	Description	Required
Folder Identifier	Text	Vault folder path or unique identifier.	✅

When Item Type = CUSTOM

Field	Type	Description	Required
Custom Object Identifier	Text	Unique identifier for the Vault custom entity.	✅

---

Output Data

Output Variable	Type	Description
QueuedJob	Object	Full Vault job object returned from the API.
JobId	Integer	ID of the newly queued job.
JobName	String	Job name (e.g., PublishDwf).
VaultFile / VaultItem / VaultFolder / VaultCustomObject	Object	Reference to the Vault entity the job was queued against.
taskMessage	String	Descriptive result message (e.g., Vault job 'PublishDwf' queued successfully with ID: 1283).
statusReturn	String	Completed on success, or Fail on error.

---

Example Configurations

🧾 Example 1 — Queue PDF Publish Job (File)

Setting	Value
Item Type	FILE
Job Name	PublishPdf
File Identifier	/Designs/Drawings/1234.dwg
Job Description	Generate PDF for DWG
Job Priority	150

Result:
Queues a new PublishPdf job for file 1234.dwg in the Vault job queue.

---

⚙️ Example 2 — Queue Lifecycle Update (Item)

Setting	Value
Item Type	ITEM
Job Name	UpdateLifecycleState
Item Identifier	P-2001
Custom Parameters	{ "NewState": "Released" }

Result:
Queues a lifecycle update job for item P-2001.

---

📁 Example 3 — Queue Folder Synchronization

Setting	Value
Item Type	FOLDER
Job Name	SyncFolderProperties
Folder Identifier	/Projects/2025/BIM

Result:
Queues a job to synchronize custom properties across the specified Vault folder.

---

🧩 Example 4 — Custom Object Job

Setting	Value
Item Type	CUSTOM
Job Name	UpdateCustomEntity
Custom Object Identifier	TENTEC_CUSTOM_OBJECT_001

Result:
Queues a Vault job targeting a specific custom object entity.

---

Task Flow Summary

Step	Description
1	Validates input fields and ensures a Vault connection exists.
2	Identifies the target object (file, item, folder, or custom).
3	Checks for any existing jobs with the same name/object.
4	Queues a new job via Vault Job Service.
5	Returns job metadata and ID for tracking.

---

Status Messages

Status	Description
Completed	Job successfully queued.
Fail	Validation or Vault error occurred during queuing.

---

Error Handling

Common issues include:

• Missing or invalid Vault connection (ensure autodeskvault dependency is configured)
• Missing required identifier for the selected item type
• Invalid or unsupported job name
• API-level Vault exception (e.g., permission denied, entity not found)

---

Notes

• The node requires an active Vault connection (from a prior AutodeskVault node or service dependency).
• Job priorities range from 1 (lowest) to 1000 (highest).
• Custom parameters are passed directly into the Vault job payload.
• The job processor must be running for queued jobs to execute.
• Use the GetVaultJobs node to monitor or validate job queue status after creation.

---

Example Workflow Integration

graph LR
    A[Get Vault File Info] --> B[Queue Vault Job (Publish PDF)]
    B --> C[Wait for Job Completion]
    C --> D[Notification: PDF Published Successfully]

---

Category: Autodesk Vault Task Name: QueueVaultJob