Scheduled Synchronization Collection Rules
Project content can be updated using synchronization mechanisms. Scheduled Synchronization updates project content by collecting related objects based on predefined rules. These rules determine how related parts, CAD documents, and other associated objects are added to a project.
During synchronization, the system evaluates relationships between objects and collects them accordingly. After collection, a permission-based filter is applied to ensure that only objects accessible to the synchronization user are included.
Scheduled Synchronization begins with one or more seed objects that are shared to a project.
From these seed objects, the system:
• Evaluates predefined relationships
• Collects related objects
• Recursively continues collection where applicable
• Applies permission filtering before adding objects to the project
To understand how objects are collected from these seed objects, review the collection rules that define this behavior.
Collection Rules
The following table describes the collection rules applied during Scheduled Synchronization and explains how each rule determines which related objects are included in a project:
|
Rule Name
|
Description
|
|
WTPART_MEMBERS
|
Collects all child parts of a shared WTPart by traversing the BOM structure. The collection is recursive and includes all levels of the structure, along with occurrence data such as quantity, placement, and structure path.
|
|
CAD_RELATED_WTPARTS
|
Collects WTParts related to a CAD document, including parts described by or built from the CAD model.
|
|
FAMILY
|
Collects the complete family table when a CAD document belonging to a family is shared, including the generic and all instances.
|
|
FAMILY_GENERICS
|
Collects the generic CAD document associated with a shared instance, ensuring that the source object is always available.
|
|
WTPART_RELATED_CADS
|
Collects CAD documents associated with a WTPart through describe or build relationships.
|
|
CAD_RELATED_DRAWINGS
|
Collects drawings associated with a CAD model. This rule applies only to original seed objects and is not recursive.
|
Some collection rules work together or have specific behaviors that affect how complete data is collected.
Scope of Collection Rules
Scheduled Synchronization uses a predefined set of collection rules to determine which related objects are included in a project.
These rules are limited in scope and differ from the broader set of rules available during manual synchronization.
Additional rule names observed in logs, such as those generated by the UICollector logger, may include rules that apply only to manual synchronization and are not used during Scheduled Synchronization.
When a WTPart is shared, the following structure expansion behavior is applied:
• All child parts are collected recursively
• The full BOM structure is preserved
• Occurrence data is included
When a CAD document that is part of a family table is shared, the following family handling behavior is applied:
• The entire family is collected
• The collection includes the generic and all instances
Generic Collection from Instances
When an instance is shared:
• Its corresponding generic is automatically collected
• It ensures consistency of family data
Combined Family Behavior
• FAMILY and FAMILY_GENERICS rules work together
• Even partial input results in complete family collection
After objects are collected using these rules, the system performs an additional step to determine whether the collected objects can be added to the project.
Permission-based Filtering
After all collection rules are applied, the system validates permissions for each collected object.
To be included in the project, the synchronization user must have:
• Read permission
• Download permission
• Change permissions access
If any required permission is missing, the object is excluded.
For example, when a synchronization user is assigned and a CAD document is shared to a project, Scheduled Synchronization runs to collect related objects.
If the synchronization user does not have the required permissions, related objects are not added to the project. However, after the necessary permissions are granted, all eligible related objects are successfully collected and shared during the next synchronization cycle.
Even with correct permissions, you might observe differences in behavior depending on how synchronization is performed.
Scheduled Synchronization vs Manual Synchronization
Scheduled Synchronization differs from manual project updates in how collection rules are applied.
• Scheduled Synchronization applies all predefined rules automatically
• Manual Synchronization depends on the selected collection options
• Scheduled Synchronization may collect more objects by default
In addition to these differences, note that some relationships are not handled during Scheduled Synchronization.
Objects Not Collected by Scheduled Synchronization
Certain relationships are excluded and require manual synchronization.
Examples include:
• Document-to-part relationships
• Specification structures
• Certain enterprise and ECAD relationships
Understanding both inclusion and exclusion behavior helps explain why certain objects appear or do not appear in a project.
Scheduled Synchronization behavior includes the following key aspects:
• Scheduled Synchronization automatically collects related objects
• Recursive relationships expand object coverage
• Family data is always completed for consistency
• Permission filtering determines final inclusion
• Some objects require manual synchronization
Control Over Object Collection
Collection rules used during Scheduled Synchronization are predefined and cannot be directly modified.
Object collection behavior can be influenced only through:
• Access permissions
• Object relationships
• Manual synchronization options
As a result, certain related objects may be automatically included based on predefined relationships. To exclude such objects, update the underlying relationships or adjust permissions where applicable.