Template:— representing_physical_document (rep_phys_doc) Capability:representing_documents |
Date: 2009/03/18 11:52:56 Revision: 1.5
|
XML references to the Template
These can be cut and pasted into the XML as required.
representing_physical_document
Set up a hyperlink to the template definition.
<template_ref name="representing_physical_document" capability="representing_documents"/>
Set up a table of the template parameters.
<template_table figure_id="?" instance="" name="representing_physical_document" capability="representing_documents">
<param name="doc_id">
<param_value></param_value>
<description></description>
</param>
<param name="doc_id_class_name">
<param_value>Document_identification_code</param_value>
<description></description>
</param>
<param name="doc_id_ecl_id">
<param_value>urn:plcs:rdl:std</param_value>
<description></description>
</param>
<param name="doc_org_id">
<param_value></param_value>
<description></description>
</param>
<param name="doc_org_id_class_name">
<param_value>Organization_name</param_value>
<description></description>
</param>
<param name="doc_org_id_ecl_id">
<param_value>urn:plcs:rdl:std</param_value>
<description></description>
</param>
<param name="doc_vn_id">
<param_value></param_value>
<description></description>
</param>
<param name="doc_vn_id_class_name">
<param_value>Version_identification_code</param_value>
<description></description>
</param>
<param name="doc_vn_id_ecl_id">
<param_value>urn:plcs:rdl:std</param_value>
<description></description>
</param>
<param name="doc_vn_org_id">
<param_value></param_value>
<description></description>
</param>
<param name="doc_vn_org_id_class_name">
<param_value>Organization_name</param_value>
<description></description>
</param>
<param name="doc_vn_org_id_ecl_id">
<param_value>urn:plcs:rdl:std</param_value>
<description></description>
</param>
<param name="domain">
<param_value>Product_life_cycle_support</param_value>
<description></description>
</param>
<param name="domain_ecl_id">
<param_value>urn:plcs:rdl:std</param_value>
<description></description>
</param>
<param name="life_cycle_stage">
<param_value>Support_stage</param_value>
<description></description>
</param>
<param name="life_cycle_stage_ecl_id">
<param_value>urn:plcs:rdl:std</param_value>
<description></description>
</param>
<param name="hardcopy">
<param_value></param_value>
<description></description>
</param>
</template_table>
Setup a template_example:
<template_example name="representing_physical_document">
<param_in name="doc_id" value=""/>
<param_in name="doc_id_class_name" value="Document_identification_code"/>
<param_in name="doc_id_ecl_id" value="urn:plcs:rdl:std"/>
<param_in name="doc_org_id" value=""/>
<param_in name="doc_org_id_class_name" value="Organization_name"/>
<param_in name="doc_org_id_ecl_id" value="urn:plcs:rdl:std"/>
<param_in name="doc_vn_id" value=""/>
<param_in name="doc_vn_id_class_name" value="Version_identification_code"/>
<param_in name="doc_vn_id_ecl_id" value="urn:plcs:rdl:std"/>
<param_in name="doc_vn_org_id" value=""/>
<param_in name="doc_vn_org_id_class_name" value="Organization_name"/>
<param_in name="doc_vn_org_id_ecl_id" value="urn:plcs:rdl:std"/>
<param_in name="domain" value="Product_life_cycle_support"/>
<param_in name="domain_ecl_id" value="urn:plcs:rdl:std"/>
<param_in name="life_cycle_stage" value="Support_stage"/>
<param_in name="life_cycle_stage_ecl_id" value="urn:plcs:rdl:std"/>
<param_in name="hardcopy" value=""/>
</template_example>
/
representing_physical_document(doc_id='', doc_id_class_name='Document_identification_code', doc_id_ecl_id='urn:plcs:rdl:std', doc_org_id='', doc_org_id_class_name='Organization_name', doc_org_id_ecl_id='urn:plcs:rdl:std', doc_vn_id='', doc_vn_id_class_name='Version_identification_code', doc_vn_id_ecl_id='urn:plcs:rdl:std', doc_vn_org_id='', doc_vn_org_id_class_name='Organization_name', doc_vn_org_id_ecl_id='urn:plcs:rdl:std', domain='Product_life_cycle_support', domain_ecl_id='urn:plcs:rdl:std', life_cycle_stage='Support_stage', life_cycle_stage_ecl_id='urn:plcs:rdl:std', hardcopy='')/
Path
Document-- Mark the Document entity as -- referable when this template is used by binding it to the reference -- parameter id_assgn %^document =
Document%
Document.id = '/IGNORE'
Document.name = '/IGNORE'
Document.description = '/IGNORE'
-- Identify the Document /
assigning_identification(
items=^document,
id=@doc_id,
id_class_name=@doc_id_class_name,
id_ecl_id=@doc_id_ecl_id,
org_id=@doc_org_id,
org_id_class_name=@doc_org_id_class_name,
org_id_ecl_id=@doc_org_id_ecl_id )/
Document_version-- Mark the Document_version entity as -- referable when this template is used by binding it to the reference -- parameter ^document_version %^document_version =
Document_version%
Document_version.id = '/IGNORE'
Document_version.description = '/IGNORE'
-- Relate the document_version to the document Document_version.of_product ->
Document-- Identify the Document_version /
assigning_identification(
items=^document_version,
id=@doc_vn_id,
id_class_name=@doc_vn_id_class_name,
id_ecl_id=@doc_vn_id_ecl_id,
org_id=@doc_vn_org_id,
org_id_class_name=@doc_vn_org_id_class_name,
org_id_ecl_id=@doc_vn_org_id_ecl_id )/
Physical_document_definition-- Mark the Physical_document_definition entity as -- referable when this template is used by binding it to the reference -- parameter ^physical_document_definition %^physical_document_definition =
Physical_document_definition%
Physical_document_definition.id = '/IGNORE'
-- n/a as (DER) Physical_document_definition.description = '/IGNORE' Physical_document_definition.additional_characterization = '/IGNORE'
-- If an optional hardcopy is provided, then link it to the physical doc definition Physical_document_definition.components ->
@hardcopy-- Relate the document_version to the document Physical_document_definition.defined_version ->
Document_version-- Assign an identifier to the digital document to distinguish from others. View_definition_context-- Mark the View_definition_context entity as -- referable when this template is used by binding it to the reference -- parameter ^view_definition_context %^view_definition_context =
View_definition_context%
-- Ignore the attributes View_definition_context.application_domain = '/IGNORE'
View_definition_context.life_cycle_stage = '/IGNORE'
View_definition_context.description = '/IGNORE'
-- provide the application domain of the view definition by classification /
assigning_reference_data(
items=^view_definition_context,
class_name=@life_cycle_stage,
ecl_id=@life_cycle_stage_ecl_id)/
-- provide the life cycle stage of the view definition by classification /
assigning_reference_data(
items=^view_definition_context,
class_name=@domain,
ecl_id=@domain_ecl_id)/
-- Relate the physical_document_definition to the View_definition_context Physical_document_definition.initial_context ->
View_definition_context
The following entities are instantiated with attributes as specified:
XML representation of path
<refpath
template="representing_physical_document">
<instantiate
entity="Document"
context="">
</instantiate>
<comment>
Mark the Document entity as
</comment>
<comment>
referable when this template is used by binding it to the reference
</comment>
<comment>
parameter id_assgn
</comment>
<bind
parameter="document">
<express_entity
entity="Document"
context="">
</express_entity>
</bind>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Document"
attribute="id"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Document"
attribute="name"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Document"
attribute="description"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<comment>
Identify the Document
</comment>
<call_template
name="assigning_identification"
business_context="">
<param_in
name="items"
value="^document">
</param_in>
<param_in
name="id"
value="@doc_id">
</param_in>
<param_in
name="id_class_name"
value="@doc_id_class_name">
</param_in>
<param_in
name="id_ecl_id"
value="@doc_id_ecl_id">
</param_in>
<param_in
name="org_id"
value="@doc_org_id">
</param_in>
<param_in
name="org_id_class_name"
value="@doc_org_id_class_name">
</param_in>
<param_in
name="org_id_ecl_id"
value="@doc_org_id_ecl_id ">
</param_in>
</call_template>
<instantiate
entity="Document_version"
context="">
</instantiate>
<comment>
Mark the Document_version entity as
</comment>
<comment>
referable when this template is used by binding it to the reference
</comment>
<comment>
parameter ^document_version
</comment>
<bind
parameter="document_version">
<express_entity
entity="Document_version"
context="">
</express_entity>
</bind>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Document_version"
attribute="id"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Document_version"
attribute="description"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<comment>
Relate the document_version to the document
</comment>
<assign
assignment_type="points-to">
<target>
<express_attribute
entity="Document_version"
attribute="of_product"
context="">
</express_attribute>
</target>
<source>
<express_entity
entity="Document"
context="">
</express_entity>
</source>
</assign>
<comment>
Identify the Document_version
</comment>
<call_template
name="assigning_identification"
business_context="">
<param_in
name="items"
value="^document_version">
</param_in>
<param_in
name="id"
value="@doc_vn_id">
</param_in>
<param_in
name="id_class_name"
value="@doc_vn_id_class_name">
</param_in>
<param_in
name="id_ecl_id"
value="@doc_vn_id_ecl_id">
</param_in>
<param_in
name="org_id"
value="@doc_vn_org_id">
</param_in>
<param_in
name="org_id_class_name"
value="@doc_vn_org_id_class_name">
</param_in>
<param_in
name="org_id_ecl_id"
value="@doc_vn_org_id_ecl_id ">
</param_in>
</call_template>
<instantiate
entity="Physical_document_definition"
context="">
</instantiate>
<comment>
Mark the Physical_document_definition entity as
</comment>
<comment>
referable when this template is used by binding it to the reference
</comment>
<comment>
parameter ^physical_document_definition
</comment>
<bind
parameter="physical_document_definition">
<express_entity
entity="Physical_document_definition"
context="">
</express_entity>
</bind>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Physical_document_definition"
attribute="id"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<comment>
n/a as (DER) Physical_document_definition.description = '/IGNORE'
</comment>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="Physical_document_definition"
attribute="additional_characterization"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<comment>
If an optional hardcopy is provided, then link it to the physical doc definition
</comment>
<assign
assignment_type="points-to">
<target>
<express_attribute
entity="Physical_document_definition"
attribute="components"
context="">
</express_attribute>
</target>
<source>
<param_in_ref
name="hardcopy">
</param_in_ref>
</source>
</assign>
<comment>
Relate the document_version to the document
</comment>
<assign
assignment_type="points-to">
<target>
<express_attribute
entity="Physical_document_definition"
attribute="defined_version"
context="">
</express_attribute>
</target>
<source>
<express_entity
entity="Document_version"
context="">
</express_entity>
</source>
</assign>
<comment>
Assign an identifier to the digital document to distinguish from others.
</comment>
<instantiate
entity="View_definition_context"
context="">
</instantiate>
<comment>
Mark the View_definition_context entity as
</comment>
<comment>
referable when this template is used by binding it to the reference
</comment>
<comment>
parameter ^view_definition_context
</comment>
<bind
parameter="view_definition_context">
<express_entity
entity="View_definition_context"
context="">
</express_entity>
</bind>
<comment>
Ignore the attributes
</comment>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="View_definition_context"
attribute="application_domain"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="View_definition_context"
attribute="life_cycle_stage"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<assign
assignment_type="equals"
context="">
<target>
<express_attribute
entity="View_definition_context"
attribute="description"
context="">
</express_attribute>
</target>
<source>
<string
value=" '/IGNORE' ">
</string>
</source>
</assign>
<comment>
provide the application domain of the view definition by classification
</comment>
<call_template
name="assigning_reference_data"
business_context="">
<param_in
name="items"
value="^view_definition_context">
</param_in>
<param_in
name="class_name"
value="@life_cycle_stage">
</param_in>
<param_in
name="ecl_id"
value="@life_cycle_stage_ecl_id">
</param_in>
</call_template>
<comment>
provide the life cycle stage of the view definition by classification
</comment>
<call_template
name="assigning_reference_data"
business_context="">
<param_in
name="items"
value="^view_definition_context">
</param_in>
<param_in
name="class_name"
value="@domain">
</param_in>
<param_in
name="ecl_id"
value="@domain_ecl_id">
</param_in>
</call_template>
<comment>
Relate the physical_document_definition to the View_definition_context
</comment>
<assign
assignment_type="points-to">
<target>
<express_attribute
entity="Physical_document_definition"
attribute="initial_context"
context="">
</express_attribute>
</target>
<source>
<express_entity
entity="View_definition_context"
context="">
</express_entity>
</source>
</assign>
</refpath>