Skip to main content

Module references

Module references 

Source
Expand description

Reference tracking besides the BOM:

  • Item references – a drawing documents a part, a specification applies to an item, a model references another one. They belong to the revision of the referencing item (like BOM lines): changed only while it is checked out, copied by Revise and frozen at release.
  • File references – the file names found inside CAD files (cadrefs): an assembly file names its part files, a drawing its model. They are matched against the files of the latest revisions in the vault, so the revision page shows which item a referenced file belongs to and which referenced files are not in TeamCraft yet.

Structs§

FileMatch
A file in the vault that matches a referenced file name.
FileReferrer
A file of another item whose CAD file references a file of this revision.
FileWithReferences
A file of a revision with the CAD files its current version references.
NewReference
ReferencedName
A referenced file name and where TeamCraft has it.
SuggestedItem
Suggestions
What the file references suggest for the structure of a revision: items whose files an assembly file uses but which are not in the BOM, and items a drawing documents without a “drawing of” reference.

Functions§

add
Adds a reference to a revision that is checked out by the actor.
file_referrers
CAD files of the latest revisions of other items that reference one of the files of this revision (assemblies using the part file, drawings of it). Matches in groups the actor may not see are left out without a count: a file-name match is a heuristic and never crosses a restricted group’s boundary (unlike explicit links, which are counted).
files_of_revision
The file references of a revision, matched against the files of the latest revisions of all items (and of the revision itself).
get
A reference of a revision the actor may read (hidden target = placeholder).
incoming
Revisions (of other items the actor may see) that reference an item, newest revisions first.
incoming_hidden
Number of referencing revisions the actor may not see.
outgoing
The references of a revision to other items; references to items the actor may not see are placeholders.
remove
Removes a reference from a revision that is checked out by the actor.
suggestions