Skip to content
Get on GitHub Autodesk App Store - coming soon

Navisworks: TimeLiner

11 nodes. Types ending in [] are lists. An input with a default is optional.

TimeLiner.AutoAttachByProperty

For every TimeLiner task (subtasks included), finds all items whose property value equals the task name (or, with matchOn "Display id", the task's display id) and attaches them — the UI's "Auto-Attach Using Rules", scriptable. Replaces each matched task's existing attachment; tasks with no matching items are left untouched and reported in unmatchedTasks. The search buttons next to category and property list what the elements selected in Navisworks right now carry.

Inputs

Input Type Default What it does
category required string — Property category display name (e.g. "Element" or a Properties.SetCustom tab). Internal names do not match.
property required string — Property display name (e.g. "Task Name"). Internal names do not match.
matchOn string "Name" What the property value is compared with: the task's "Name" (default) or its "Display id" (the Activity ID column of an imported schedule).
document Document null The document (defaults to the active document).

Outputs

Output Type
attachedCount integer
unmatchedTasks any

Returns: How many tasks received attachments, and the names of tasks with no matching items.

Tags: timeliner auto attach rules 4d link schedule property timelinertask activity id

TimeLiner.Tasks

All TimeLiner tasks in a document, with subtasks flattened into one list, read again on every run. Each task comes before its subtasks ("parents first"). Navisworks replaces a task's subtasks when the task itself is edited, so when you edit or delete a whole list that holds tasks together with their subtasks (TimelinerTask.SetProgress, SetDates, SetActual, Delete over the list), set order to "children first" in the Advanced panel: the subtasks are then handled before their task and none is already replaced when its turn comes.

Inputs

Input Type Default What it does
order string "parents first" "parents first" (default) lists each task before its subtasks; "children first" lists the subtasks before their task.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
tasks TimelinerTask[] Every task, with the task hierarchy flattened (subtasks included).

Tags: timeliner tasks schedule 4d all timelinertask timeliner task

TimelinerTask.AttachSet

Attaches a saved selection/search set to a task as a LIVE link (like Attach Set in the UI) — the core 4D-linking automation. Give the set itself, its name, or its folder path and name; a list of tasks and a list of sets link each task to the set at the same position.

Inputs

Input Type Default What it does
task required TimelinerTask — The stored TimeLiner task (from TimeLiner.Tasks or TimelinerTask.Create).
set required any — The saved selection or search set: the set itself (SelectionSet.ByName, SelectionSets.All), its display name or its folder path and name.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
task TimelinerTask The updated stored task. Lace over task/set lists for bulk 4D linking.

Tags: timeliner task attach set link 4d

TimelinerTask.ByName

Finds a TimeLiner task by its name (subtasks too). When several tasks share the name the first one in the list is used and the node shows a warning; give the path through the parent tasks ("Structure/Level 2") to choose one exactly. Fails when there is no such task.

Inputs

Input Type Default What it does
name required string — The task's name, or its path through the parent tasks such as "Structure/Level 2".
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
task TimelinerTask The stored task.

Tags: timeliner task byname find lookup schedule 4d path

TimelinerTask.Create

Creates a TimeLiner task with planned dates and optionally attaches model items. Leave parent empty for a top-level task, or give the parent task (TimelinerTask.ByName, or its name or path) to build a schedule hierarchy. A task of the same name under the same parent is updated instead of added again, so running the graph twice does not duplicate the schedule; set onExisting (Advanced) to "add" to always add one or to "error" to stop.

Inputs

Input Type Default What it does
name required string — Display name for the task.
plannedStart required datetime — Planned start date.
plannedEnd required datetime — Planned end date.
items ModelItem[] null Model items to attach (optional).
taskType string "Construct" Simulation task type: Construct, Demolish or Temporary (a custom task type of the document can be wired in as text).
parent any null The task to create this one under: a task, its name or its path such as "Structure/Level 2". Empty creates a top-level task.
onExisting string "update" What to do when the same parent already has a task of this name: "update" changes that task (dates, type, items), "add" always adds another, "error" stops.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
task TimelinerTask The stored TimeLiner task.

Tags: timeliner task create new schedule 4d subtask parent hierarchy

TimelinerTask.Delete

Deletes a TimeLiner task together with its subtasks. Returns false (and changes nothing) when the task is not in the document or was already removed by an earlier delete in the same run, so a clean-up step can run twice and a list holding a task and its subtasks can be deleted whole (set TimeLiner.Tasks to order "children first" for that).

Inputs

Input Type Default What it does
task required TimelinerTask — The stored TimeLiner task to delete.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
deleted boolean True when the task was removed; false when it is not in the document.

Tags: timeliner task delete remove clean 4d schedule

TimelinerTask.Info

Name, id, planned and actual dates, task type and progress of a TimeLiner task, the name of its parent task (empty for a top-level task) and its depth (0 for a top-level task, 1 for a subtask ...).

Inputs

Input Type Default What it does
task required TimelinerTask — The TimeLiner task.

Outputs

Output Type
name string
displayId string
plannedStart datetime
plannedEnd datetime
actualStart datetime
actualEnd datetime
taskType string
progress number
parent string
depth integer

Returns: Name, id, planned/actual dates, task type, progress, the parent task's name and the depth in the hierarchy.

Tags: timeliner task info dates schedule parent depth hierarchy

TimelinerTask.Items

The model items attached to a TimeLiner task. Search and set attachments are re-evaluated.

Inputs

Input Type Default What it does
task required TimelinerTask — The TimeLiner task.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
items ModelItem[] The attached items (search/set attachments are evaluated).

Tags: timeliner task items attached selection

TimelinerTask.SetActual

Sets a task's ACTUAL start and/or end dates (the planned dates are untouched; use TimelinerTask.SetDates for those) — record what happened on site next to the plan. A date you leave unwired is kept as it is, so "started today, end not known yet" is just the start. With neither date the node changes nothing and shows a warning. Over a list that holds tasks together with their subtasks, set TimeLiner.Tasks to order "children first".

Inputs

Input Type Default What it does
task required TimelinerTask — The stored TimeLiner task.
start datetime null Actual start date; leave it unwired to keep the task's actual start as it is.
end datetime null Actual end date; leave it unwired to keep the task's actual end as it is (a task that has started and not finished).
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
task TimelinerTask The updated stored task. Lace over lists for bulk updates.

Tags: timeliner task actual dates start end schedule 4d update

TimelinerTask.SetDates

Updates a task's planned start/end dates in place — bulk schedule edits without a re-import. Over a list that holds tasks together with their subtasks, set TimeLiner.Tasks to order "children first".

Inputs

Input Type Default What it does
task required TimelinerTask — The stored TimeLiner task.
plannedStart required datetime — New planned start date.
plannedEnd required datetime — New planned end date.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
task TimelinerTask The updated stored task. Lace over lists for bulk schedule updates.

Tags: timeliner task dates schedule update planned

TimelinerTask.SetProgress

Sets a task's percent complete (0-100; anything outside is clamped) — update progress from a site report in bulk. Lace over tasks and percentages. Over a list that holds tasks together with their subtasks, set TimeLiner.Tasks to order "children first".

Inputs

Input Type Default What it does
task required TimelinerTask — The stored TimeLiner task (from TimeLiner.Tasks or TimelinerTask.Create).
percent required number — Percent complete; values outside 0-100 are clamped to 0 or 100.
document Document null The document (defaults to the active document).

Outputs

Output Type What it gives
task TimelinerTask The updated stored task. Lace over task / percent lists for bulk progress updates.

Tags: timeliner task progress percent complete status 4d update