PTC Document Control Domain
The PTC Document Control (DocumentControl) domain provides access to the training record capabilities of Windchill. The domain enables you to retrieve information about training records, the control document associated with a training record, and the control document details.
You can work with training records in the PTC Document Control domain only if the Document Control Module (pre-configured best practice module with training tracking functionality) is installed.
The domain contains the TrainingRecord OData entity that represents the training record objects in Windchill, and provides the TrainingRecords entity set that enables clients to read the training records available in the Windchill system.
Training records can be assigned to any type of control document that is configured in Windchill. The documents can contain corporate policies and procedures or work instructions.
 |
If a document is deleted, the associated training records are deleted. Administrators must assign document permissions accordingly.
|
The PTC Document Control domain extends the PTC Quality domain.
The following table lists the significant OData entities available in the Document Control domain. To see all the OData entities available in the Document Control domain, refer to the entity data model (EDM) of the domain. The domain EDM is available at the metadata URL, /Windchill/servlet/odata/DocumentControl/$metadata
|
Items
|
OData Entities
|
Description
|
|---|---|---|
|
Training records
|
TrainingRecord
|
The TrainingRecord entity represents the training record objects.
A training record object helps to track the training assigned to a particular principal or assignee (user).
|
|
Control documents
|
ControlDocument
|
The ControlDocument entity represents the control document object associated with a training record. A training record has only one control document associated with it.
A control document object holds the training material information for a particular training.
|
Navigation Properties Available for the TrainingRecord Entity
The following are some of the important navigation properties available for the TrainingRecord entity:
• SubjectControlDocument—Retrieves the control document object associated with a training record.
• Assignee—Retrieves the assignee (user) for a training record.
Navigation Properties Available for the ControlDocument Entity
The following are some of the important navigation properties available for the ControlDocument entity:
• Representations—Retrieves the representations for a training record.
Example URI:
GET /Windchill/servlet/odata/DocumentControl/TrainingRecords('OR:com.ptc.qualitymanagement.qms.trainingtracking.TrainingRecord:306394')/SubjectControlDocument/Representations('OR:wt.viewmarkup.DerivedImage:786687')
The request returns the following URLs, which you can use to launch Creo View, view the representations, and download the data:
◦ CreoViewURL—The URL used to launch the Creo View Desktop and open the representation.
◦ ThreeDThumbnailURL—The URL for 3D thumbnail.
◦ TwoDThumbnailURL—The URL for 2D thumbnail.
◦ AdditionalFiles—The URL used to download additional files corresponding to a representation. These files are non-native Creo View files.
Along with the URLs, the request also returns the attributes such as FileSize, MimeType, FileName, Format, and so on for the 3D thumbnail, 2D thumbnail, and additional files.
For more information about Windchill representations, see PTC Visualization Domain.
• Attachments—Retrieves the attachments for a training record.
• Thumbnails—Retrieves the thumbnails.
Example URI:
GET /Windchill/servlet/odata/DocumentControl/TrainingRecords('OR:com.ptc.qualitymanagement.qms.trainingtracking.TrainingRecord:306394')/SubjectControlDocument?$expand=Thumbnails
• SmallThumbnails—Retrieves the small thumbnails.
Example URI:
GET /Windchill/servlet/odata/DocumentControl/TrainingRecords('OR:com.ptc.qualitymanagement.qms.trainingtracking.TrainingRecord:306394')/SubjectControlDocument?$expand=SmallThumbnails
• PrimaryContent—Retrieves the primary content for a training record.
Refer to the domain EDM for a complete list of navigation properties.