representing_document

NOTE The template has been defined in the context of the capability representing_documents which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description of related templates.

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

This template describes how to represent the version history of a document. This is primarily achieved through use of the Document_version and Product_version_relationship entities.

The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "representing_document_history". The text highlighted in blue shows the template parameters.

The following input parameters are defined for this template:

The following classes and their sub-classes can be used:

classifications: [Sequential_version_relationship]

Error RDL1: The class Sequential_version_relationship does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
[Derived_version_relationship]

Error RDL1: The class Derived_version_relationship does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
[Hierarchical_version_relationship]

Error RDL1: The class Hierarchical_version_relationship does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml

The following reference parameters are defined for this template:

Allow the Document_version entity instantiated in this path to be referenced when this template is used.

Note: The Document_version entity can be referenced in a template path by:

%^target = $representing_document_history.relating_doc_version%

where target is the parameter to which the Document_version is bound.

Allow the Document_version entity instantiated in this path to be referenced when this template is used.

Note: The Document_version entity can be referenced in a template path by:

%^target = $representing_document_history.related_doc_version%

where target is the parameter to which the Document_version is bound.

The instantiation path shown below specifies the entities that are to be instantiated by the template.

A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.

Product_version_relationship

-- Create the Product_version_relationship entity
-- Set the attributes
Product_version_relationship.relation_type = '/IGNORE'
Product_version_relationship.description = '/IGNORE'
Product_version_relationship.relating_version -> @relating_doc_version
Product_version_relationship.related_version -> @related_doc_version

-- provide the role of the relationship by classifying the file_relationship
/assigning_reference_data(
    items=Product_version_relationship,
    class_name=@version_reln_class_name,
    ecl_id=@version_reln_ecl_id)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Product_version_relationship.relation_type	'/IGNORE'	—
Product_version_relationship.description	'/IGNORE'	—

The instance diagram in Figure 3 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/representing_document_history(version_reln_class_name='Document', version_reln_ecl_id='urn:plcs:rdl:std')/

(an illustration of the consolidated representing_document_history template is shown in Figure 4 below.)

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is:


				DATA;
				#8 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$);
				#7 = EXTERNAL_CLASS('/IGNORE','Document','/IGNORE',#8);
				#6 = CLASSIFICATION_ASSIGNMENT(#7,(#1),'/IGNORE');
				#4 = DOCUMENT('/IGNORE','/IGNORE','/IGNORE');
				#3 = DOCUMENT_VERSION('/IGNORE','/IGNORE',#4);
				#2 = DOCUMENT_VERSION('/IGNORE','/IGNORE',#4);
				#1 = PRODUCT_VERSION_RELATIONSHIP('/IGNORE','/IGNORE',#2,#3);
				ENDSEC;

The instance model in STEP XML exchange file format (ISO 10303 Part 28 ed.2 syntax) is:

The instance diagram in Figure 4 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/representing_document_history(version_reln_class_name='Document', version_reln_ecl_id='urn:plcs:rdl:std')/

The following section details how the representing_document_history template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

The following characterizations may apply:

Characterization Assigning time

NOTE this characterization is optional.

Dates and time can be associated with a historical version of a document by using one of the templates assigning_time, or assigning_calendar_date (deprecated).

Figure 5 — Characterization by time of document version history

A creation date is commonly assigned to the template representing_document_history. The date and time assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date (and time) when the document version was actually created.