| Business DEX (NDLO007):— Represent_documents_and_their_applicability | Date: 2007/10/12 12:27:18 Revision: 1.41 |
Purpose
This NDLO-DEX shall exchange data about documents subject to configuration management, through all Life Cycle Stages, as input to management processes, technical analyses and support.
Usage
The NDLO-DEX provides input data for document and configuration management processes of the life cycle stages. Typical usage is to manage document versions and applicability for past, current and future versions of product and support elements.
This section provides an overview of business DEXs. To improve readability of the NDLO-DEX has been split up into the following business DEXs, which all have the main document being described in common:
Document identification, references and revisions
The figure below describes a document supporting the product, its references and revisions and how these are linked to the document being described. In the more detailed information model, the concepts identification, references and revisions are each described separately.
Document stakeholders and control
Document stakeholders are names and organizations who are responsible for developing, budgeting, approval, quality assurance, etc.
Document applicability
The figure below describes where a document is applicable, i.e. what lifecycle processes and/or pieces of equipment the document describes or contains information for.
This NDLO-DEX is divided into several supporting business functions (also referred to as steps).The table below indicates which business functions that are available for the various business DEXs. An "x" in the table indicates that the business function is available for the business DEX.
|
Function id |
Function description |
Business constraints |
Document identification |
Document revisions |
Document references |
Document stakeholders and control |
Document applicability |
|---|---|---|---|---|---|---|---|
| 1 | Provide contractor identifier to a document subject to configuration control | A document shall have one Document_number | x | x | x | x | x |
| 1.1 | Classify the document as originating from the main contractor | x | x | x | x | x | |
| 2 | Identify revision number of the document | A Document with Document_number shall be referenced by one or more Document_version with Document_version_number. A Document_version shall have one Document_version_number | x | x | x | x | x |
| 2.1 | Relate the document to its context | For an instance of Document_version with Document_version_number there shall be one or more instance of Selected_item_assignment with Contractor_documents_for_product | x | x | x | x | x |
| 2.2 | Provide context description for the documents | - | - | - | - | x | |
| 2.3 | Provide context identifier for the documents | - | - | - | - | x | |
| 2.4 | Establish a document version instance insensitive to document revisions | - | - | - | x | - | |
| 2.5 | Establish previous document version that has been changed by a revision | - | x | - | - | - | |
| 3 | Identify an individual product (object cost centre) for which a document is generated | For an instance of Product_as_individual with Serial_identification_code_manufacturer there shall be one or more Document with Document_number | x | x | x | x | x |
| 3.1 | Identify the product version that exists as an individual product | For an instance of Product_as_individual with Serial_identification_code_manufacturer there shall be one or more Product_as_realized with Part_version_identification_code | x | - | - | - | x |
| 3.2 | Enable assignment of data to a view of the individual product | A Product_as_realized with Part_version_identification_code shall be referenced by a Product_as_individual_view with Individual_product_view_for_documents | x | - | - | - | x |
| 3.3 | Identify baseline type (development stage) in a product's life cycle to which documents are developed | x | - | x | - | x | |
| 3.4 | Identify application domain for which data are valid | x | x | x | - | x | |
| 3.5 | Identify approval based baseline in a product development process to which documents belong | - | - | - | - | x | |
| 3.6 | Identify the life cycle stage for which the data are valid | - | x | x | - | x | |
| 4 | Relate the version of the document to the program activity that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_program_activity Or | - | - | - | - | x |
| 4.1 | Relate the version of the document to the product zone that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_product_zone Or | - | - | - | - | x |
| 4.2 | Relate the version of the document to the product bloque that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_product_bloque Or | - | - | - | - | x |
| 4.3 | Relate the version of the document to the product module that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_product_module Or | - | - | - | - | x |
| 4.4 | Relate the version of the document to the product work breakdown structure that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_work_breakdown_structure OR | - | - | - | - | x |
| 4.5 | Relate the version of the document to the breakdown element in the product structure that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_breakdown_element_in_product OR | - | - | - | - | x |
| 4.6 | Relate the version of the document to the allowance parts list that the document applies to | A Document_version with Document_version_number shall be referenced by one or more Document_assignment with Document_for_parts_list_item OR | - | - | - | - | x |
| 5 | Relate the document identifier to the organization that assigned the identifier | - | - | - | x | - | |
| 5.1 | Provide identity code to the organization that owns the identifier | A Document_number shall have one Organization_identification_code. A Document_version with Document_version_number shall be referenced by one Organization with Organization_identification_code and Organization_name | - | - | - | x | - |
| 5.2 | Provide name for the organization that owns the identifier | - | - | - | x | - | |
| 6 | Provide customer identifier to a document | A Document with Document_number shall have maximum one Customer_document_number | x | - | - | - | - |
| 7 | Provide title to document | A Document with Customer_document_number shall have one instance of Document_title | x | - | - | - | - |
| 8 | Describe type of document | A Document with Document_number shall have one Document_definition with Refrence_document_data_type | x | - | - | - | - |
| 8.1 | Identify the Document type | x | - | - | - | - | |
| 8.2 | Identify the Document type description | x | - | - | - | - | |
| 9 | Classify representation of the document property | x | - | - | - | - | |
| 11 | Identify program activity code (used for e.g. weight control, change proposals, configuration management) that the document applies to | A Document with Document_number shall have one or more Activity_method with Program_activity_code | - | - | - | - | x |
| 12 | Provide program activity code description (i.e. weight control, change proposals, configuration management) | A Activity_method with Program_activity_code shall have one Program_activity_code_description | - | - | - | - | x |
| 13 | Identify the office or company that has developed the document | A Document_version with Document_version_number shall be referenced by one Organization with Organization_identification_code or Organization_name | - | - | - | x | - |
| 13.1 | Relate the document version and the organization that developed the document | - | - | - | x | - | |
| 14 | Provide name or description of office or company that provides services to the program | A Document_version with Document_version_number shall be referenced by one Organization with Organization_identification_code or Organization_name | - | - | - | x | - |
| 15 | Identify the contractor office with budget responsibility for the document | A Document_version with Document_version_number shall be referenced by one Organization with Budget_responsible_organization_code or Budget_responsible_organization_name | - | - | - | x | - |
| 15.1 | Relate the document version and the contractor organization that has budget responsibility for the document | A Document_version with Document_version_number shall be referenced by maximum one Organization_or_person_in_organization_assignment with Document_budget_responsible | - | - | - | x | - |
| 16 | Provide name or description of contractor budget responsible office | A Document_version with Document_version_number shall be referenced by one Organization with Budget_responsible_organization_code or Budget_responsible_organization_name | - | - | - | x | - |
| 17 | Identity the contractor office responsibile for the document | A Document_version with Document_version_number shall be referenced by one Organization with Document_responsible_office_code | - | - | - | x | - |
| 17.1 | Relate the document version and the document responsible contractor technical office | A Document_version with Document_version_number shall be referenced by maximum one Organization_or_person_in_organization_assignment with Document_responsible_office | - | - | - | x | - |
| 18 | Provide name or description of contractor departments | A Document_version with Document_version_number shall be referenced by one Organization with Document_responsible_office_code | - | - | - | x | - |
| 19 | Identity document status in the technical office that develops the document | A Document_version with Document_version_number shall be referenced by one State_observed with Document_status_code or Document_staus_name | - | - | - | x | - |
| 19.1 | Relate document to the organization that develops the document | - | - | - | x | - | |
| 20 | Provide description of code for document status in the technical office | A Document_version with Document_version_number shall be referenced by one State_observed with Document_status_code or Document_staus_name | - | - | - | x | - |
| 21 | Identify code of zone in the product | - | - | - | - | x | |
| 22 | Provide name identifier to the zone | A Breakdown_element with Part_zone_code shall have a Part_zone_name | - | - | - | - | x |
| 23 | Identify code of block in the product | - | - | - | - | x | |
| 24 | Provide name identifier to the block | A Breakdown_element with Part_block_code shall have a Part_block_name | - | - | - | - | x |
| 25 | Identify code of module in the product | - | - | - | - | x | |
| 26 | Provide name identifier to the module | A Breakdown_element with Part_module_code shall have one Part_module_name | - | - | - | - | x |
| 27 | Identify code of work breakdown structure element (cost group) that the document applies to | - | - | - | - | x | |
| 28 | Provide name identifier to work breakdown structure element (cost group) | A Breakdown_element with Part_work_breakdown_element_code shall have one Part_work_breakdown_element_name | - | - | - | - | x |
| 29 | Identify level of security classification | A Document with Document_number and Document_version_number shall have one Security_classification classified as Document_classification | x | - | - | - | - |
| 30 | Assign level of security classification to a document | x | - | - | - | - | |
| 31 | Identify document author in the organization that develops the document | Organization_or_person_in_organization_assignment with Document_developing_organization and shall have maximum one Person_in_organization with Document_author. A Organization with Document_developing_organization_code shall be referenced by zero or one Person_in_organization classified as Document_author (One instance of first and last name, zero or one for middle name). | - | - | - | x | - |
| 31.1 | Relate document author to the authored document | - | - | - | x | - | |
| 32 | Relate contractor quality assurance acceptance to the document | - | - | - | x | - | |
| 32.1 | Define quality assurance as a type of approval | - | - | - | x | - | |
| 32.2 | Relate quality assurance person to the quality assurance activity | A Document_version with Document_version_number shall be referenced by maximum one Approving_person_organization classified as Contractor_quality_assurance_person and an Organization | - | - | - | x | - |
| 32.3 | Identify status of approval | - | - | - | x | - | |
| 33 | Relate contractor final approval acceptance to the document | - | - | - | x | - | |
| 33.1 | Define final approval as a type of approval | - | - | - | x | - | |
| 33.2 | Relate approving person to the final approval activity | A Document_version with Document_version_number shall be referenced by maximum one Approving_person_organization classified as Contractor_final_approval_person | - | - | - | x | - |
| 34 | Relate document revision date to the revised document | - | x | - | - | - | |
| 34.1 | Assign date of document (revision) | - | - | - | x | - | |
| 35 | Relate document (revision) to date it was sent to the customer | A Organization_or_person_in_organization_assignment with Customer_document shall have one Date_or_date_time_assignment classified as Sending_date_to_customer | - | - | - | x | - |
| 35.1 | Assign date that document was forwarded to the customer | - | - | - | x | - | |
| 35.2 | Provide identitier for the customer organization | A Organization_or_person_in_organization_assignment with Customer_document shall have one Organization with Organization_name | - | - | - | x | - |
| 35.3 | Relate document version to the customer the document applies to | A Document_version with Document_version_number shall be referenced by one Organization_or_person_in_organization_assignment with Customer_document | - | - | - | x | - |
| 36 | Relate customer approval to the document | A Document_version with Document_version_number shall be referenced by maximum one Approval_assignment classified as Document_approval. A Approval_assignment classified as Document_approval shall reference an Approval classified as Approval_by_customer. An Approval classified as Apprroval_by_customer shall have a reference through Approving_person_organization to an Organization with Organization_name | - | - | - | x | - |
| 36.1 | Define type of approval to be by the customer | - | - | - | x | - | |
| 36.2 | Relate document approval date to approving organization | - | - | - | x | - | |
| 37 | Relate document revision to date it was sent to the production department | A Organization_or_person_in_organization_assignment classified as Production_department_document shall be referenced by maximum one Date_or_date_time_assignment classified as Send_date_to_production_department | - | - | - | x | - |
| 37.1 | Assign date document was forwarded to the production department | - | - | - | x | - | |
| 38 | Provide identity code for the production department the document applies to | A Organization_or_person_in_organization_assignment classified as Production_department_document shall be referenced by one Organization with Production_deparment_code | - | - | - | x | - |
| 39 | Relate document version to the production department the document applies to | A Document_version with Document_version_number shall be referenced by maximum one Organization_or_person_in_organization_assignment classified as Production_department_document | - | - | - | x | - |
| 40 | Identify revision status in the production engineering department | A Document_version with Document_version_number shall be referenced by maximum one State_observed with Production_engineering_department_state | - | - | - | x | - |
| 41 | Relate work status in production engineering to the document causing work | A State_observed with Production_engineering_department_state shall have maximum one Applied_state_assignment with Organization_status_versus_document | - | - | - | x | - |
| 41.1 | Relate work status to organization subject to work | A Applied_state_assignment with Organization_status_versus_document shall have maximum one Organization_or_person_in_organization_assignment with Work_status_in_production_engineering | - | - | - | x | - |
| 41.2 | Identify company department name responsible for production engineering | - | - | - | x | - | |
| 42 | Relate a department to its owning company | - | - | - | x | - | |
| 43 | Identify index name or title to the part of the document subject to a specific revision | A Document_version with Document_version_number shall be referenced by minimum one Partial_document_assignment with Document_index_data. A Partial_document_assignment with Document_index_data shall reference a Document_version with Document_version_number, through is_to. A Partial_document_assignment classified as Document_index_data shall reference one Document_version with Document_version_identifier that is also referenced by a Partial_document_assignment classified as Document_revision_description | - | x | - | - | - |
| 43.1 | Define that data represent document page number to the document index | - | x | - | - | - | |
| 43.2 | Identify index name or title to the part of the document subject to a specific revision | - | x | - | - | - | |
| 43.3 | Define that data represent last page number revised | - | x | - | - | - | |
| 44 | Identify page number to first page changed as a consequence of a specific revision | A Partial_document_assignment with Document_index_data shall have minimum one Document_property_representation classified as First_page_revised | - | x | - | - | - |
| 45 | Identify page number to last page changed as a consequence of a specific revision | A Partial_document_assignment with Document_index_data shall have minimum one Document_property_representation classified as Last_page_revised | - | x | - | - | - |
| 46 | Describe an individual revision for a specific document | A Document_version with Document_version_number shall be referenced by minimum one Partial_document_assignment classified as Document_revision_description. A Partial_document_assignment classified as Document_index_data shall reference one Document_version with Document_version_identifier that is also referenced by a Partial_document_assignment classified as Document_revision_description | - | x | - | - | - |
| 47 | Provide identifier to an individual revision notice inside a specific document revision | A Document_version with Document_version_number shall be referenced by minimum one Document with Revision_notice_identifier | - | x | - | x | - |
| 47.1 | Allow versions of a revision notice | A Document with Revision_notice_identifier shall be referenced by minimum one Document_version with Document_version_number | - | x | - | - | x |
| 48 | Characterize the revision notice to the document | A Document with Revision_notice_identifier shall have a Revision_notice_type | - | x | - | - | - |
| 48.1 | Identify the code characterizing the revision notice to the document | - | x | - | - | - | |
| 48.2 | Identify the name characterizing the revision notice to the document | - | x | - | - | - | |
| 49 | Provide identity code for document revision notice status | A Document with Revision_notice_identifier shall have minimum one State_observed with Revision_notice_status_code or Revision_notice_status_name | - | x | - | - | - |
| 49.1 | Classify the assignment of status to a document version | A Document_version with Document_version_number shall have one or more Applied_state_assignment classified as Revision_notice_status | - | x | - | - | - |
| 50 | Provide description of code for document revision notice status | A Document with Revision_notice_identifier shall have minimum one State_observed with Revision_notice_status_code or Revision_notice_status_name | - | x | - | - | - |
| 51 | Assign date when an individual revision notice is implemented in the target document | A Partial_document_assignment classified as Document_revision_description shall have one Revision_notice_date (Calendar_date) | - | x | - | - | - |
| 51.1 | Assign date revision notice was implemented in target document | A Partial_document_assignment classified as Document_revision_description shall have one Revision_notice_date (Calendar_date) | - | x | - | - | - |
| 52 | Identify implementation status for the revision notice in the end product | A Document_version with Document_version_number shall have one or more State_observed with Implementation_status_in_product | - | x | - | - | - |
| 52.1 | Classify relationship between an activity to implement a revision notice and the status of implementation | An Activity classified as Implement_revision_notice_in_product shall have one or more State_observed with Implementation_status_in_product | - | x | - | - | - |
| 52.2 | Relate revision notice to its implementation status via the implementation activity | A Document_version with Document_version_number shall have one or more Applied_activity_assignment with Revision_notice_implementation | - | x | - | - | - |
| 52.3 | Identify the activity needed to implement the revision notice in the end product | - | x | - | - | - | |
| 52.4 | Identify the method used to perform the activity | - | x | - | - | - | |
| 53 | State requirement to notify production control about the revision notice | An Activity classified as Implement_revision_notice_in_product shall have one Activity_relationship with Production_notification_need_indicator | - | x | - | - | - |
| 53.1 | Identify activity to notify production control about the revision notice | - | x | - | - | - | |
| 53.2 | Identify the method used to provide a notification | - | x | - | - | - | |
| 54 | State if production implementation control is informed about the revision notice | An Activity classified as Implement_revision_notice_in_product shall have one or more Applied_state_assignment with Production_notification_status | - | x | - | - | - |
| 54.1 | Identify status of the activity needed to provide a notification | - | x | - | - | - | |
| 55 | Provide name of revision notice author | A Document with Revision_notice_identifier shall have one Person_in_organization classified as Revision_notice_author | - | x | - | - | - |
| 55.1 | Relate revision notice author to the revision notice for the specific document | - | - | - | x | - | |
| 56 | Provide name of contractor person who checks the revision notice | A Document_version with Document_version_number shall have one Approval_assignment classified as Revision_notice_quality_acceptance | - | - | - | x | - |
| 56.1 | Define revision notice quality check as a type of approval | An Approval_assignment classified as Revision_notice_quality_acceptance shall have an Approval classified as Revision_notice_quality_check | - | x | - | - | - |
| 56.2 | Relate person to the revision notice quality check activity | An Approval with Revision_notice_quality_check shall have one Approving_person_organization classified as (tbd) | - | x | - | - | - |
| 57 | Provide name of contractor person who approves the revision notice | A Document_version with Document_version_number shall have one Approval_assignment classified as Revision_notice_approval | - | - | - | x | - |
| 57.1 | Define revision notice approval as a type of approval | An Approval_assignment classified as Revision_notice_approval shall have an Approval classified as Revision_notice_approval | - | x | - | - | - |
| 57.2 | Relate approving person to the revision notice approval | An Approval with Revision_notice_approval shall have maximum one Approving_person_organization classified as Revision_notice_approving_person | - | x | - | - | - |
| 58 | Relate a document to referenced documents | - | - | x | - | - | |
| 58.1 | Identify sequential number of referenced document | - | - | x | - | - | |
| 59 | Provide identifier to a contractor generated document that is referenced by the main document | A Document_assignment with Referenced_document_sequential_identifier shall have one Document with Document_number | - | - | x | - | - |
| 59.1 | Identify version number of the referenced contractor generated document | A Document_assignment with Referenced_document shall have a Document_version with Document_version_number | - | - | x | - | - |
| 59.2 | Provide identifier to a document that is referenced by the main document | - | - | x | - | - | |
| 59.3 | Identify version number of the referenced document | - | - | x | - | - | |
| 60 | Describe type of referenced document | A Document_assignment with Referenced_document_sequential_identifier shall have one Document_definition with Referenced_document_data_type | - | - | x | - | - |
| 60.1 | Identify code to describe semantics (type) of referenced document | - | - | x | - | - | |
| 60.2 | Describe semantics (type) of referenced document | - | - | x | - | - | |
| 61 | Describe the representation of the referenced document type | A Document_definition with Referenced_document_data_type shall have a Referenced_data_format | - | - | x | - | - |
| 61.1 | Identify the code describing the format of the referenced document | - | - | x | - | - | |
| 61.2 | Identify the name describing the format of the referenced document | - | - | x | - | - | |
| 62 | Provide description of the referenced data | A Document with Referenced_document_identifier may have zero or one Document_assignment with Description_of_referenced_data | - | - | x | - | - |
| 63.1 | Identify the first line, or item, in the material list that the referenced document applies to | A Document_assignment with Referenced_document_sequential_identifier shall have maximum one Partial_document_assignment with First_item_referenced_identifier | - | - | x | - | - |
| 64 | Identify the last line, or item, in the material list that the referenced document applies to | A Partial_document_assignment with First_item_referenced_identifier shall have a Last_item_referenced_identifier | - | - | x | - | - |
| 65 | Relate a document to the digital file where the document is located | x | - | - | - | - | |
| 66 | Relate a digital file to its description | A File_location_identification with Path_file_name shall reference a Digital_file with Digital_file_description | x | - | - | - | - |
| 67 | Identify name of server where the digital file for the document is located | A Document with Document_number and Document_version with Document_version_number shall be referenced by one or more File _location_identification with Servername | x | - | - | - | - |
| 68 | Identify path to the digital file where the document is located | A File_location_identification with Servername shall have one or more Path_file_name | x | - | - | - | - |
| 70 | Identify the data system to which a document belongs | A File_location_identification with Servername shall have one Class with Document_repository | x | - | - | - | - |
| 71 | Identify the configuration item for which the document contains information | A Document with Document_number and Document_version with Document_version_number shall be referenced by one or more Breakdown_element with Configuration_item_identification_code | - | - | - | - | x |
| 72 | Identify the maintainable part identifier for which the document contains information | - | - | - | - | x | |
| 73 | Assign manufacturer part number to the maintainable part that the spare part relates to | - | - | - | - | x | |
| 74 | Assign version identifier to the part | - | - | - | - | x |
Table 0 — Business functions present in different business DEXs
© OASIS 2010 — All rights reserved