PDM-UG: Constrained Document or File Reference
From WikiSTEP
This page belongs to the PDM Usage Guide.
Constraints may be specified on the association of documents or files with product data, in order to distinguish a portion of the entire document or file that applies in the reference.
The Instance Model: EXPRESS entities and attributes
The EXPRESS entities and attributes used to support the requirements of constrained document or file association to product data are illustrated in Diagram 44.
Diagram 44: Constrained Document Association to Product Data Instance Diagram
Document usage constraint
The document_usage_constraint entity identifies a portion of a document that is applicable for a given usage.
Attributes
- The source attribute references the complete document or file of which a portion is distinguished.
- The subject_element attribute describes the portion or element of the complete document.
- The subject_element_value attribute conveys a specific value of the subject_element.
| ENTITY document_usage_constraint | Attribute Population | Remarks |
| source | type: entity = document | May be document_file in the case of an external file reference |
| subject_element | type: label = string | |
| subject_element_value | type: text = string |
===Preprocessor Recommendations=== The subject_element should identify the relevant portion or section of the document that is applicable. The subject_element_value describes how the subject_element is to be interpreted.
===Postprocessor Recommendations=== Postprocessors should interpret the subject_element as an indication of the relevant portion of the entire document.
===Related Entities=== There are no specific related entities.
Applied document usage constraint assignment
The applied_document_usage_constraint_assignment entity is a subtype of document_usage_constraint_assignment. It supports the constrained assignment of a document to product data. A constrained assignment identifies only a portion of the entire document that is relevant in the assignment.
Attributes
- The assigned_document_usage attribute references the associated document_usage_constraint.
- The role attribute identifies the role of the assignment.
- The items attribute references the product data to which the partial document is assigned.
| ENTITY applied_document_usage_constraint_assignment | Attribute Population | Remarks |
| assigned_document_usage | type: entity = document_usage_constraint | |
| role | type: entity = document_usage_role | |
| items | type : documents_reference_item = select |
===Preprocessor Recommendations=== There are no specific preprocessor recommendations.
===Postprocessor Recommendations=== There are no specific postprocessor recommendations.
===Related Entities=== There are no specific related entities.
Document usage role
The document_usage_role entity identifies the role of the constrained document assignment.
Attributes
- The name attribute identifies the role of the document assignment.
- The description attribute is optional.
| ENTITY document_usage_role | Attribute Population | Remarks |
| name | type : label = string 'mandatory', 'informative', other | Other string values are valid based on requirements found in APs that utilize the PDM schema. |
| description | type : text = string | OPTIONAL |
===Preprocessor Recommendations=== The name attribute should have the value 'mandatory' or 'informative' if the required semantics to be captured is to indicate if the associated document reference is required or optional, respectively. APs using the PDM schema may have other values for the name attribute that the preprocessor will need to handle.
===Postprocessor Recommendations=== The postprocessor should interpret name attribute as 'mandatory' or 'informative' when the required semantics being exchanged is to indicate if the associated document reference is required or optional, respectively. APs using the PDM schema may have other values for the name attribute that the postprocessor will need to handle.
===Related Entities=== There are no specific related entities.
The Instance Model: STEP exchange file format (ISO10303 Part 21 syntax)
#180=DOCUMENT_TYPE('geometry');
#190=DOCUMENT_FILE('plot_1','plot data',$,#180,'', $);
#200=DOCUMENT_USAGE_CONSTRAINT(#190,'sheet','one');
#210=DOCUMENT_USAGE_ROLE('informative',$);
#220=APPLIED_DOCUMENT_USAGE_CONSTRAINT_ASSIGNMENT(#200,#210,(#90));
#230=DOCUMENT_REPRESENTATION_TYPE('physical',#190);
The following section combines the above-discussed concepts and segments in a complete example. The concepts instantiated in the example are illustrated in Figure 11.
Figure 11: Schematic Overview of Complete Document and File Example
The Instance Model: EXPRESS entities and attributes
The EXPRESS entities and attributes used to support the requirements of constrained document or file association to product data are illustrated in Diagram 45, Diagram 46, Diagram 47, and Diagram 48.
Diagram 45: Part Master Instance Diagram
0Diagram 46: External File Reference to Part View Definition Instance Diagram
Diagram 47: Constrained External File Reference to Part View Definition Instance Diagram
Diagram 48: Document and Constituent File Association Instance Diagram
The Instance Model: STEP exchange file format (ISO10303 Part 21 syntax)
ISO-10303-21;
HEADER;
FILE_DESCRIPTION(('pdm_schema data', 'pdm_schema'), '2;1');
FILE_NAME('C:document_xample.stp', '1999-5-20 T12:39:1', (''), (), '', '', '');
FILE_SCHEMA(('PDM_SCHEMA {1.2}'));
ENDSEC;
DATA;
/* Entities #10 - #20 define part master data */
/* To the product_definition #90 is a life cycle specific view on */
/* that part to which documents and external files */
/* are assigned in the following sections of this file */
#30=PRODUCT_DEFINITION_CONTEXT_ROLE('',$);
#40=APPLICATION_CONTEXT('mechanical design');
#45=APPLICATION_PROTOCOL_DEFINITION('version 1.2','pdm_schema',2000,#40);
#50=PRODUCT_DEFINITION_CONTEXT('part definition',#40,'design');
#60=PRODUCT_CONTEXT('',#40,'');
#70=PRODUCT('MP-03-2','my part',$,(#60));
#80=PRODUCT_DEFINITION_FORMATION('03','3rd modification',#70);
#90=PRODUCT_DEFINITION('/NULL',$,#80,#50);
#100=PRODUCT_DEFINITION_CONTEXT_ASSOCIATION(#90,#50,#30);
#110=PRODUCT_RELATED_PRODUCT_CATEGORY('part',$,(#70));
/* Entities #120 to #170 model the assignment of */
/* digital file data to the product_definition #90 */
#120=DOCUMENT_TYPE('geometry');
#130=DOCUMENT_FILE('m1','',$,#120,'',$);
#140=APPLIED_DOCUMENT_REFERENCE(#130,,(#90));
#150=OBJECT_ROLE('informative',$);
#160=ROLE_ASSOCIATION(#150,#140);
#170=DOCUMENT_REPRESENTATION_TYPE('digital',#130);
/* Entities #180 to #230 model the assignment of hardcopy document */
/* data to the product_definition #90 */
/* This assignment is partial, i.e., in addition the information is */
/* conveyed that only sheet one of the hardcopy (plots) shall be */
/* logically assigned */
#180=DOCUMENT_TYPE('geometry');
#190=DOCUMENT_FILE('p1','',$,#180,'',$);
#200=DOCUMENT_USAGE_CONSTRAINT(#190,'sheet','one');
#210=DOCUMENT_USAGE_ROLE('informative',$);
#220=APPLIED_DOCUMENT_USAGE_CONSTRAINT_ASSIGNMENT(#200,#210,(#90));
#230=DOCUMENT_REPRESENTATION_TYPE('physical',#190);
/* Entities #240 to #350 model a managed document (document */
/* as product) For this document two versions are specified */
/*(#280 and #330)To version 3.2 (#330) two files (#320, #340) */
/* that constitute the document are defined */
#240=APPLICATION_CONTEXT('');
#250=PRODUCT_DEFINITION_CONTEXT('digital document definition',#240,);
#260=PRODUCT_CONTEXT('',#240,'');
#270=PRODUCT('doc_4711','packaging guide’, ‘packaging guideline for part',(#260));
#280=PRODUCT_DEFINITION_FORMATION('ver3.1','version 3.1',#270);
#290=PRODUCT_DEFINITION('id of digital document','digital document for representing guideline ver3.1',#280,#250);
#300=PRODUCT_RELATED_PRODUCT_CATEGORY('document',$,(#270));
#310=DOCUMENT_TYPE('unspecified');
#320=DOCUMENT_FILE('t1','',$,#310,'',$);
#330=PRODUCT_DEFINITION_FORMATION('ver3.2','version 3.2',#270);
#340=DOCUMENT_FILE('l1','','file with logo for the guide',#310,'',$);
#350=PRODUCT_DEFINITION_WITH_ASSOCIATED_DOCUMENTS('rep_id_3.2','representation of version 3.2',#330,#250,(#340,#320));
/* Entities #360 to #410 establish the association of the */
/* managed document version #280 (packaging guide) with the view */
/* of the part modeled via product_definition #90 */
#360=DOCUMENT_PRODUCT_EQUIVALENCE('equivalence',$,#370,#280);
#370=DOCUMENT('','',$,#380);
#380=DOCUMENT_TYPE('configuration controlled document version');
#390=APPLIED_DOCUMENT_REFERENCE(#370,'',(#90));
#400=ROLE_ASSOCIATION(#410,#390);
#410=OBJECT_ROLE('mandatory',$);
ENDSEC;
END-ISO-10303-21;
