Supplementary_directives_Rules_for_the_structure_and_drafting_of_SC4_standards_for_industrial_data.doc

ISO TC 184/SC 4 N2412

2008-12-16 ISO Technical Committee ISO/TC 184, Automation systems and integration, Subcommittee SC 4, Industrial data

SC 4 Supplementary directives — Rules for the structure and drafting of SC 4 standards for industrial data Edition 4

This standing document cancels and replace the Supplementary directives for the drafting and presentation of ISO 10303 (SC 4 N1217).

The SC 4 Quality Committee recommends that this document shall be used with immediate effect by all SC 4 projects.

PDF disclaimer

This PDF file may contain embedded typefaces. In accordance with Adobe's licensing policy, this file may be printed or viewed but shall not be edited unless the typefaces which are embedded are licensed to and installed on the computer performing the editing. In downloading this file, parties accept therein the responsibility of not infringing Adobe's licensing policy. The ISO/TC 184/SC 4 Secretariat accepts no liability in this area.

Adobe is a trademark of Adobe Systems Incorporated.

Details of the software products used to create this PDF file can be found in the General Info relative to the file; the PDF-creation parameters were optimized for printing. Every care has been taken to ensure that the file is suitable for use by ISO member bodies. In the unlikely event that a problem relating to it is found, please inform the ISO TC 184/SC 4 Secretariat at the address given below.

This document may be freely copied and distributed.

SC 4 standing documents specify procedures, methods, and guidelines for the development of SC 4 standards for industrial data. SC 4 standing documents, together with additional documents such as templates and checklists, can be obtained from the Internet:

SC 4 Standing Documents Folder ISO TC 184/SC 4 Secretariat DISA IN, Interoperability Directorate Rm 614, 5600 Columbia Pike Falls Church, VA 22041-2717, USA email: sc4sec@tc184-sc4.org

Contents Page

Scope

Normative References Terms, definitions and abbreviations 3.1 Terms defined in ISO 10303-1 3.2 Terms defined in ISO 10303-31 3.3 Terms defined in ISO 10303-202 3.4 Terms defined in ISO/IEC Directives, Part 2 3.5 Other terms and definitions 3.6 Abbreviations Requirements for the structure and content of parts of SC 4 standards 4.1 Preliminary elements 4.1.1 Cover page 4.1.2 Copyright statement 4.1.3 Table of contents 4.1.4 Foreword 4.1.5 Introduction 4.2 Normative elements 4.2.1 Clauses and subclauses 4.2.2 Title 4.2.3 Scope 4.2.4 Normative references 4.2.5 Terms and definitions 4.2.6 Clauses specifying requirements 4.2.7 Normative annexes 4.3 Supplementary Elements 4.3.1 Informative annexes 4.3.2 Bibliography 4.3.3 Index 4.4 Figures, tables, notes, examples, and footnotes 4.4.1 Figures 4.4.2 Tables 4.4.3 Notes 4.4.4 Examples 4.4.5 Footnotes 4.5 Lists 4.6 References within the text 4.6.1 References to this International Standard 4.6.2 References to other International Standards and documents 4.6.3 References to subdivisions of the text 4.7 Punctuation of words in a series 4.8 Acceptable wording 4.8.1 Using “shall” and “shall not” 4.8.2 Using “must” and “must not” 4.8.3 Using “should” and “should not” 4.8.4 Use of “may” and “need not” 4.8.5 Use of “can” and “cannot” 4.8.6 Use of “i.e.”, “e.g.”, and “etc.”

4.8.7 Use of quotation marks 4.8.8 Spelling 4.9 Hyphenation 4.10 Words to avoid 4.11 Frequently used words 4.12 Representation of dates Format and layout of SC 4 standards 5.1 Page size, fonts, and spacing 5.1.1 Page size and margin settings 5.1.2 Acceptable digital formats 5.1.3 Acceptable fonts 5.1.4 Vertical spacing 5.2 Instructions for the page layout for parts of SC 4 standards 5.2.1 Page headers and footers 5.2.2 Use of blank pages 5.3 General format and layout instructions 5.3.1 Format and layout of clauses and subclauses 5.3.2 Format and layout of lists 5.3.3 Format and layout of figures 5.3.4 Format and layout of tables 5.3.5 Layout and format of notes 5.3.6 Layout and format for examples 5.4 Format and layout of specific elements 5.4.1 Format and layout of the table of contents 5.4.2 Placement of the foreword 5.4.3 Placement of the introduction 5.4.4 Format and layout of the title element 5.4.5 Layout and format of normative references 5.4.6 Layout and format of terms and definitions 5.4.7 Format for the index EXPRESS presentation style 6.1 Layout rules 6.1.1 Organization of the schema elements 6.1.2 Use of the colon 6.1.3 Use of the semicolon 6.1.4 Commenting conventions 6.1.5 Indentation 6.1.6 Layout of a schema 6.1.7 Layout of interface statements 6.1.8 Layout of a constant declaration 6.1.9 TYPE layout 6.1.10 Algorithm layout 6.1.11 Entity data type declaration layout 6.2 Style rules 6.2.1 Use of case 6.2.2 Names 6.3 EXPRESS usage style requirements 6.3.1 Use of local domain (WHERE) rules 6.3.2 Labelling UNIQUE and WHERE rules 6.3.3 Definition of constraints 6.4 EXPRESS schema documentation 6.4.1 General requirements 6.4.2 Components of a clause that specifies an EXPRESS schema 6.4.3 Schema documentation requirements 6.4.4 Introduction to schema 6.4.5 Fundamental concepts and assumptions 6.4.6 Documentation of formal propositions 6.4.7 Documentation of informal propositions 6.4.8 Type documentation requirements 6.4.9 Entity data type documentation 6.4.10 Rule documentation requirements 6.4.11 Subtype constraint documentation requirements 6.4.12 Function (procedure) documentation requirements 6.4.13 End of schema declaration 6.5 EXPRESS-G diagram style Documentation of integrated resources series of parts of ISO 10303 7.1 Documentation of scope 7.2 Documentation of normative references 7.3 Documentation of terms, definitions, symbols, and abbreviations 7.4 Documentation of requirements 7.5 Documentation of annexes 7.5.1 Normative annexes 7.5.2 Required informative annexes 7.5.3 Optional informative annexes 7.6 Bibliography 7.7 Documentation of the index Documentation of the application interpreted construct series of parts of ISO 10303 8.1 Documentation of scope 8.2 Documentation of normative references 8.3 Documentation of definitions 8.4 Documentation of EXPRESS short listing 8.5 Documentation of annexes 8.5.1 Normative annexes 8.5.2 Required informative annexes 8.5.3 Optional informative annexes 8.6 Bibliography 8.7 Documentation of index Documentation of the application protocol series of parts for ISO 10303 9.1 Application protocols developed using integrated resources and AICs 9.1.1 Documentation of the table of contents 9.1.2 Documentation of the introduction 9.1.3 Documentation of scope 9.1.4 Documentation of normative references 9.1.5 Documentation of terms and definitions 9.1.6 Documentation of information requirements 9.1.7 Documentation of application interpreted model 9.1.8 Documenting conformance requirements 9.1.9 Documentation of annexes 9.1.10 Bibliography 9.1.11 Documentation of index 9.2 Application protocols developed using modules 9.2.1 Documentation of the table of contents 9.2.2 Documentation of the foreword 9.2.3 Documentation of the introduction 9.2.4 Documentation of scope 9.2.5 Documentation of normative references 9.2.6 Documentation of terms, definitions and abbreviations 9.2.7 Documentation of information requirements 9.2.8 Documentation of module interpreted model 9.2.9 Documentation of conformance requirements 9.2.10 Documentation of annexes Annex A (normative) EXPRESS expanded listings Annex C (normative) Implementation method specific requirements 9.2.11 Bibliography 9.2.12 Documentation of index Documentation of abstract test suite series of parts of ISO 10303 10.1 Title 10.2 Documentation of the table of contents 10.3 Documentation of the introduction 10.4 Documentation of scope 10.5 Documentation of normative references 10.6 Documentation of terms and definitions 10.7 Documentation of test purposes 10.7.1 Application element test purposes 10.7.2 AIM test purposes 10.7.3 Implementation method test purposes 10.7.4 Domain test purposes 10.7.5 Other test purposes 10.8 Documentation of general test purposes and verdict criteria 10.8.1 General test purposes 10.8.2 General verdict criteria for all abstract test cases 10.8.3 General verdict criteria for preprocessor abstract test cases 10.8.4 General verdict criteria for postprocessor abstract test cases 10.9 Documentation of abstract test cases 10.9.1 Abstract test cases 10.10 Documentation of annexes 10.10.1 Conformance classes (Annex A) 10.10.2 Computer interpretable postprocessor input specification (Annex B) 10.10.3 Information object registration (Annex C) Documentation of the application module series of parts of ISO 10303 11.1 Module naming 11.2 Documentation of the introduction 11.3 Documentation of scope 11.4 Documentation of normative references 11.5 Documentation of terms, definitions and abbreviations 11.6 Documentation of information requirements 11.6.1 The referenced application module ARMs 11.6.2 The ARM type definitions 11.6.3 The application objects as ARM entity definitions 11.6.4 ARM function definitions 11.6.5 ARM rule definitions 11.6.6 EXPRESS ARM documentation 11.7 Documentation of module interpreted model 11.7.1 The mapping specification 11.7.2 The MIM short form 11.8 Documentation of annexes:

11.8.1 Normative annexes 11.8.2 Required informative annexes 11.8.3 Optional informative annexes 11.9 Bibliography 11.10 Documentation of index 11.11 Conformance testing concepts Documentation of the parts of ISO 13584 12.1 Layout and format 12.2 Scope clause Documentation of the parts of ISO 15531 Documentation of the parts of ISO 15926 14.1 Format and layout 14.2 Foreword 14.3 Wording of the introduction 14.4 Terms and definitions Documentation of the parts of ISO 18629 Documentation of the parts of ISO 18876 16.1 Format and layout 16.2 Foreword 16.3 Terms and definitions Documentation of standards that are produced jointly with other committees Technical Corrigenda 18.1 Content of Technical Corrigenda 18.1.1 Cover page and introduction 18.1.2 Headers and footers 18.1.3 Documentation of changes 18.2 Format of Technical Corrigenda Annex A (normative) Cover pages Annex B (normative) Use of ASN.1 Identifiers in SC 4 standards Annex C (informative) Examples Annex D (informative) Criteria for lexical definitions Annex E (informative) Checklists and approval procedures Annex F (informative) Extract from Guide to using the ISO technical programme Annex G (informative) Revision history Bibliography Index

Figures xiiFigure 1 — Model of situation in creating a standard.

Figure 2 — Interaction between end-users, standards developers, and IT providers xiii Figure 3 — Page layout Figure 4 — Page layout for figures or tables in landscape mode Figure 5 — Examples showing the format and layout of notes Figure 6 — Examples showing the format and layout of examples Figure 7 - Data planning model

Tables xiTable 1 — Revision history

Table 2 — Arrangement of elements Table 3 — Acceptable fonts for PDF file creation Table 4 — Fonts, font sizes, and enhancements for SC 4 standards Table 5 — Vertical spacing Table 6 — Wording for document reference in page headers Table 7 — Typical “special” page/header elements Table 8 — Order of declarations of schema elements Table 9 — Contents of an integrated resource part Table 10 — Contents of an application interpreted construct Table 11 — Contents of an application protocol Table 12 — Contents of a modular application protocol Table 13 — Contents of an abstract test suite part Table 14 — Contents of an application module Table F.1 — ISO stages and abbreviations Table G.1 — Expanded revision history

Foreword

ISO (the International Organization for Standardization) is a worldwide federation of national standards bodies (ISO member bodies). The work of preparing International Standards is normally carried out through ISO technical committees. Each member body interested in a subject for which a technical committee has been established has the right to be represented on that committee. International organizations, governmental and non-governmental, in liaison with ISO, also take part in the work. ISO collaborates closely with the International Electrotechnical Commission (IEC) on all matters of electrotechnical standardization.

This standing document was prepared by Technical Committee ISO/TC 184, Industrial automation systems and integration, Subcommittee SC 4, Industrial data.

The following standing documents provide guidelines for developing International Standards produced by ISO/TC 184/SC 4:

· ISO/TC 184/SC 4 Organization handbook;

· SC 4 Quality manual;

· SC 4 Supplementary directives.

The following standing documents provide additional guidelines for developing parts of ISO 10303 “Product data representation and exchange”:

· Application module development points within the application protocol development process

· Guidelines for application interpreted construct development;

· Guidelines for application interpreted model development;

· Guidelines for the development and approval of STEP application protocols;

· Guidelines for the development of abstract test suites;

· Guidelines for the development of mapping specifications.

The following standing documents provide additional guidelines for developing and publishing SC 4 parts:

· Standard industrial data framework;

· Common resources and guidelines for the identification of common resources;

· Guidelines for the format and layout of SC 4 standards using HTML;

· Procedures for transposing externally developed specifications into ISO deliverables.

This standing document cancels and replaces the Supplementary directives for the drafting and presentation of ISO 10303 (SC 4 N1217).

This SC 4 standing document is applicable with immediate effect to all SC 4 projects.

0 Introduction

0.1 Overview of this standing document

This standing document specifies requirements for the content, layout, and style for the standards developed by ISO TC 184/SC 4.

This standing document augments the 2004 edition of ISO/IEC Directives, Part 2 and does not supersede it.

This standing document is subdivided into clauses as follows:

· clause 1 specifies the scope and field of application of this standing document;

· clause 2 identifies additional documents that, through references in this standing document, constitute provisions of this standing document;

· clause 3 defines the terms used in this standing document;

· clause 4 describes the structure of SC 4 standards;

· clause 5 specifies the format and layout of SC 4 standards;

· clause 6 specifies rules and guidelines for documenting EXPRESS schemas;

· clause 7 specifies rules and guidelines for documenting the integrated resources series of ISO 10303;

· clause 8 specifies rules and guidelines for documenting the application interpreted construct series of ISO 10303;

· clause 9 specifies rules and guidelines for documenting the application protocol series of ISO 10303;

· clause 10 specifies rules and guidelines for documenting the abstract test suite series of ISO 10303;

· clause 11 specifies rules and guidelines for documenting the application module series of ISO 10303;

· clause 12 is a placeholder for rules and guidelines for documenting parts of ISO 13584;

· clause 13 is a placeholder for rules and guidelines for documenting parts of ISO 15531;

· clause 14 is a placeholder for rules and guidelines for documenting parts of ISO 15926;

· clause 15 is a placeholder for rules and guidelines for documenting parts of ISO 18629;

· clause 16 is a placeholder for rules and guidelines for documenting parts of ISO 18876;

· clause 17 is a placeholder for rules and guidelines for documenting parts of ISO standards produced jointly with other ISO or IEC committees;

· clause 18 specifies rules and guidance for documenting Technical Corrigenda.

This standing document is partially derived from the 2004 edition of the ISO/IEC Directives Part 2 - Rules for structure and drafting of international standards ) that specifies the general requirements, form, and language for the production of an International Standard. This standing document includes requirements specific to the standards developed by SC 4. Some of these requirements apply to all SC 4 standards; others are specific to ISO 10303. The ISO/IEC Directives Part 2 and these Supplementary directives provide the set of rules for creating an SC 4 standard.

0.2 Changes from the previous edition

Table 1 summarizes the major revisions of this standing document.

Table 1 — Revision history

The main changes with respect to the previous version of Supplementary directives for the drafting and presentation of ISO 10303 (SC 4 N1217) are listed below:

· update of hypertext links to pages of the SC4ONLINE website;

· addition of new SC 4 Standing Documents since the publication of the previous edition of this document;

· addition of provision for modular architecture;

· addition of provision for HTML parts;

· update to accommodate ISO Directives Part 2:2004;

· correction of SEDS (342, 343, 379, 681, 682, 827, 858, 883, 903, 967, 974, 975, 1040);

· integration of SC 4 N1686 for content of modular APs (covers SEDS 976, 1021, 1022);

· integration of SC 4 N1685 for content of modules (covers SEDS 933, 965-967).

A complete list of changes is available in the standing document ballot issues log [8].

0.3 Target audiences

This document is intended for use by editors of SC 4 standards, and by developers of supporting tools such as DTDs, style sheets, XML components, XSLT scripts and templates related to SC 4 standards.

0.4 Characteristics of a standard

Standards communicate to identified target users a technical specification that is unambiguous to the extent that two parties who

· have not taken part in developing the standard, and

· are not working together can create implementations of the standard (normally software) that conform to the stated requirements of the standard and are mutually consistent. Producing a standard means developing drafts that must be technically accurate and communicate the information the intended users need.

Project teams are responsible for developing a standard whose scope is defined by an approved New Work Item. The team produces drafts of the proposed standard and revises them based on industry reviews, ballot results, and ballot comments. Figure 1 summarizes team activities to produce a standard. Several levels of reviews happen before the document goes for balloting:

· internal project reviews;

· reviews by industry sponsors and participants;

· “wide industry reviews” (previously referred to as Committee Draft for Comment);

· peer review by other experts in the same Working Group (common in some of SC 4’s working groups, including WG2, WG3, WG11, and WG12).

Figure 1 — Model of situation in creating a standard.

Developers of SC 4 standards should note that their work is driven by the needs to two different target audiences: end-users in industry who formulate and validate the problems and requirements that SC 4 standards address, and information technology providers who implement the standards and deliver solutions to end-users (see Figure 2).

Figure 2 — Interaction between end-users, standards developers, and IT providers

The following points summarize key factors that project teams should take into account when preparing a draft standard.

· Treat writing the draft as a process that involves a series of recursive steps (preparing and planning, researching, organizing, drafting, and revising).

· Treat the user profile as the driving force behind all writing decisions.

· Understand what the user needs to know.

· Help the user understand the material through definitions, visuals, writing style, and reduction of ambiguities.

· Know what the users will do or what the team wants the users to do with the material.

· Ask that there be as many reviews for expression as there are for technical content.

0.5 Conventions

This standing document uses the following convention to delineate text that is to be included in an SC 4 standard (boilerplate) from the rest of the text.

· Required text is enclosed in a box.

· All text that is required in each ISO standard begins with “ [ISO required]” and ends with “[end required]”.

· All text that is required in each SC 4 standard begins with “ [SC 4 required]” and ends with “[end required]”.

· All text that is required in each part of ISO xxxxx begins with “ [ISO xxxxx required]” and ends with “[end required]”.

This standing document uses the following convention to identify text that is to be supplied by the part editor (normally within boilerplate text).

· Information that is to be supplied by the part editor is specified within angle brackets (< … >).

This standing document uses the following convention to present examples of the format and layout of text in SC 4 standards.

· Examples that show specific formats or layouts to be used in SC 4 standards are distinguished from other text by a light grey background.

· Such examples use the font sizes and weights typically used the element of the standard that is illustrated by the example, rather than the font size and weight normally used for the text of examples.

This standing document conforms to its own requirements where they are applicable. However, the format and layout of this document are not intended to be a model for the format and layout of an SC 4 standard; where there is any discrepancy between the text of this document and its format and layout, the text has precedence.

SC 4 Supplementary directives — Rules for the structure and drafting of SC 4 standards for industrial data 1 Scope

This standing document specifies requirements for the content, layout, and style for the standards developed by ISO TC 184/SC 4. These standards include the following:

· ISO 10303 XE "ISO 10303" , Product data representation and exchange;

· ISO 13584 XE "ISO 13584" , Parts library;

· ISO 15531 XE "ISO 15531" , Manufacturing management data;

· ISO 15926 XE "ISO 15926" , Integration of life-cycle data for process plants including oil and gas production facilities;

· ISO 18629 XE "ISO 18629" , Process specification language;

· ISO 18876 XE "ISO 18876" , Integration of industrial data for exchange, access, and sharing.

This standing document specifies the elements that make up SC 4 standards, provides wording to be used to prepare those elements, and sets out rules for the appearance of those elements.

NOTE

In this standing document, “SC 4 standard” refers to any of the deliverables of SC 4 projects that are published by ISO. These include International Standards, Technical Specifications, Publicly Available Specifications, and Technical Reports. Where it is necessary to refer to a part (of a multi-part standard), this standing document uses “SC 4 part”.

All provisions of this standing document apply to SC 4 standards that are to be delivered to ISO as Portable Document Format (PDF XE "PDF" ) files. All provisions of this standing document apart from those specified in clause 5 apply to SC 4 standards that are to be delivered as HTML files.

The following are within the scope of this standing document:

· specification of rules and guidelines that apply to preliminary elements (see 3.4.2);

· specification of rules and guidelines that apply to normative elements (see 3.4.1);

· specification of rules and guidelines that apply to supplementary elements (see 3.4.3);

· guidelines for formatting the elements of the standard.

The following is outside the scope of this standing document:

· the technical content of SC 4 standards.

2 Normative References

The following referenced documents are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

However, editors of SC 4 standards are encouraged to investigate the possibility of applying the most recent editions of the documents indicated below.

ISO 690, Documentation — Bibliographic references — Content, form and structure ISO 690-2, Information and documentation — Bibliographic references — Part 2: Electronic documents or parts thereof ISO 8601, Data elements and interchange formats — Information interchange — Representation of dates and times ISO 10303-1, Industrial automation systems and integration — Product data representation and exchange — Part 1: Overview and fundamental principles ISO 10303-11, Industrial automation systems and integration — Product data representation and exchange — Part 11: Description methods: The EXPRESS language reference manual ISO 10303-11, Industrial automation systems and integration — Product data representation and exchange — Part 11: Description methods: The EXPRESS language reference manual ISO 10303-41), Industrial automation systems and integration — Product data representation and exchange — Part 41: Integrated generic resource: Fundamentals of product description and support ISO 10303-202, Industrial automation systems and integration — Product data representation and exchange — Part 202: Associative draughting ISO 10241, International terminology standards — Preparation and layout IEC/ISO Directives, Part 2, Rules for the structure and drafting of International Standards, Fifth edition, 2004

IEEE Std 1320.1-1998, Standard for Functional Modeling Language - Syntax and Semantics for IDEF0 IEEE Std 1320.2-1998, Standard for Conceptual Modeling Language - Syntax and Semantics for IDEF1X Thompson, Della (ed). The Concise Oxford English Dictionary of Current English. 9th ed. Oxford: Oxford University Press, 1995

The following SC 4 standing documents contain provisions, which, through reference in this text, constitute provisions of this standing document. At the time of adoption, the revisions of the documents indicated were valid. All documents are subject to revision, and users of this standing document are encouraged to investigate the possibility of applying the most recent revisions of the documents indicated below.

ISO TC 184/SC 4 N534:1997, Guidelines for application interpreted construct development ISO TC 184/SC 4 N532:1997, Guidelines for application interpreted model development ISO TC 184/SC 4 N535:1998, Guidelines for the development and approval of STEP application protocols ISO TC 184/SC 4 N1290:2002), Guidelines for the development of abstract test suites, edition 2

ISO TC 184/SC 4 N1190:2001, Guidelines for the development of mapping specifications

NOTE

A list of current SC 4 standing documents and other material to be used by developers of SC 4 standards is available from the Internet:

http://www.tc184-sc4.org/SC4_Open/SC4_Standards_Developers_Info/maindisp.cfm?bk=1724 3 Terms, definitions and abbreviations

3.1 Terms defined in ISO 10303-1

For the purposes of this document, the following terms defined in ISO 10303-1 (repeated below for convenience) apply.

abstract test suite XE “abstract test suite”

ATS

part of ISO 10303 that contains the set of abstract test cases necessary for conformance testing of an implementation of an application protocol application XE “application” group of one or more processes creating or using product data application activity model XE “application activity model”

AAM

model that describes an application in terms of its processes and information flows application interpreted model XE “application interpreted model”

AIM

information model that uses the integrated resources necessary to satisfy the information requirements and constraints of an application reference model, within an application protocol application object XE “application object” atomic element of an application reference model that defines a unique concept of the application and contains attributes specifying the data elements of the object application reference model XE “application reference model”

ARM

information model that describes the information requirements and constraints of a specific application context conformance class XE “conformance class” subset of an application protocol for which conformance may be claimed data XE “data” representation of information in a formal manner suitable for communication, interpretation or processing by human beings or computers information XE “information” facts, concepts or instructions information model XE “information model” formal model of a bounded set of facts, concepts, or instructions to meet a specified requirement interpretation XE “interpretation” process of adapting a resource construct from the integrated resources to satisfy a requirement of an application protocol

NOTE This may involve the addition of restrictions on attributes, the addition of constraints, or the addition of relationships among resource constructs.

PICS proforma XE “PICS proforma” standardized document in the form of a questionnaire, which, when completed for a particular implementation, becomes the protocol implementation conformance statement (PICS) product XE “product” a thing or substance produced by a natural or artificial process product data XE “product data” representation of information about a product in a formal manner suitable for communication, interpretation, or processing by human beings or by computers resource construct XE “resource construct” collection of EXPRESS ENTITIES, TYPES, FUNCTIONS, RULES, and REFERENCES that together define a valid description of an aspect of product data unit of functionality XE “unit of functionality” UoF collection of application objects and their relationships that defines one or more concepts with the application context such that removal of any component would render the concepts incomplete or ambiguous

3.2 Terms defined in ISO 10303-31

For the purposes of this document, the following term defined in ISO 10303-31 (repeated below for convenience) applies.

abstract test case XE “abstract test case”

ATC

specification, encapsulating at least one test purpose, that provides the formal basis from which executable test cases are derived. It is independent of both the implementation and the values abstract test method XE “abstract test method” description of how an implementation is to be tested, given at the appropriate level of abstraction to make the description independent of any particular implementation of testing tools or procedures, but with sufficient detail to enable these tools and procedures to be produced conformance testing XE “conformance testing” the testing of a candidate product for the existence of specific characteristics required by a standard in order to determine the extent to which that product is a conforming implementation.

3.3 Terms defined in ISO 10303-202

For the purposes of this document, the following term defined in ISO 10303-202 (repeated below for convenience) applies.

application interpreted construct

XE “application interpreted construct” AIC logical grouping of interpreted constructs that supports a specific function for the usage of product data across multiple application contexts

3.4 Terms defined in ISO/IEC Directives, Part 2

For the purposes of this document, the following terms defined in ISO/IEC Directives Part 2 (repeated below for convenience) apply.

normative elements XE “normative element” elements setting out the provisions to which it is necessary to conform in order to be able to claim compliance with the standard preliminary elements XE “preliminary element” elements that identify the document, introduce its content and explain its background, its development and its relationship with other standards supplementary elements XE “supplementary element” elements that provide additional information intended to assist the understanding or use of the standard

3.5 Other terms and definitions

application element XE "application element" application object, attribute of an application object, or assertion of a relationship between two application objects application module XE "application element"

AM

reusable collection of a scope statement, information requirements, mappings and module interpreted model that supports a specific usage of product data across multiple application contexts application protocol XE “application protocol”

AP

part of ISO 10303 that specifies an application interpreted model satisfying the scope and information requirements for a specific application

NOTE 1

This definition differs from the definition used in open system interconnection (OSI) standards. However, because ISO 10303 will not be used directly with OSI communications, no confusion should arise.

NOTE 2

Adapted from ISO 10303-1.

AP module XE "application element" application module that specifies the complete information model for an AP common resource XE "common resource" part of an SC 4 standard that defines a group of resource constructs that can be used or interpreted in other SC 4 standards

NOTE 1

The constructs defined in a common resource may be used or interpreted in all other SC 4 standards or in a subset of the other SC 4 standards.

NOTE 2

Common resources include the integrated resources, application interpreted constructs, and application modules parts of ISO 10303, together with a number of designated parts of other SC 4 standards such as ISO 13584-20 and ISO 15531-42.

data planning model XE "data planning model" model that describes the primary concepts of an application domain and the relationships among the concepts foundation module XE "application element" application module that specifies highly re-usable generic information model capabilites. Foundation modules may aggregate other foundation modules. A foundation module is not independently implementable implementation method XE “implementation method” part of ISO 10303 that specifies a technique used by computer systems to exchange product data that are described using the EXPRESS language

NOTE

implementation module XE "application element" module that is a collection of one or more application modules that specifies an implementable capability against which conformance classes may be defined integrated resource XE “integrated resource”

IR

part of ISO 10303 that defines a group of resource constructs used as the basis for product data mapping signature XE "mapping signature" definition of the format to be used for a template call mapping specification XE "mapping specification" element of an application protocol that shows how the interpretation of integrated resources is used to meet the information requirements of the application mapping template XE "mapping template" reusable portion of a reference path that defines a commonly used part of the structure of an application interpreted model planning model XE " planning model" model that illustrates the primary concepts of an application domain and the general relationships among the major concepts. The planning model does not describe the relationships, e.g. meaning, cardinality, or direction. The planning model provides an overview of the scope of the AP

3.6 Abbreviations

For the purposes of this document, the following abbreviations apply.

AAM

application activity model (see 3.1.3)

AR

application resource

AIC

application interpreted construct (see 3.3.1)

AIM

application interpreted model (see 3.1.4)

AM

application module (see 3.5.2)

AP

application protocol (see 3.5.3)

ARM

application reference model (see 3.1.6)

ATS

abstract test suite (see 3.1.1)

CC

conformance class

CD

Committee Draft

DIS

Draft International Standard

(E) English

FDIS

Final Draft International Standard

GR

generic resource

IR

integrated resource (see 3.5.10)

IS

International Standard

ISO

International Organization for Standardization

MIM

module interpreted model

MS

mapping specification

PDF

Portable Document Format

PAS

Publicly Available Specification

SC 4

Subcommittee 4

TC 184

Technical Committee 184

TS

Technical Specification

UoF unit of functionality (see 3.1.16)

URL

uniform resource locator

WD

working draft

4 Requirements for the structure and content of parts of SC 4 standards

Table 1 lists the elements that comprise the content of parts of SC 4 standards.

Table 2 — Arrangement of elements XE "elements:arrangement of"

Text

Note(s)

Footnote(s)

Figure(s)

Table(s)

Note(s)

Example(s)

Table 2 (continued)

Figure(s)

Table(s)

Note(s)

Footnote(s)

Symbols and abbreviated terms

Clause(s) specifying requirementsd

Normative annexd Text

Figure(s)

Table(s)

Note(s)

Example(s)

Footnote(s)

Figure(s)

Table(s)

Note(s)

Table 2 (continued)

a Bold type = required element; Roman (non-italic) type = normative element; italic type = informative element.

b Roman type = required content; italic type = optional content.

c The final cover page is generated by the ISO Central Secretariat.

d Each part of ISO 10303 shall contain a normative references clause, at least one requirements clause, and at least one normative annex. These elements may not be required for parts of other SC 4 standards.

e Informative annexes may not contain normative elements unless these elements constitute optional provisions. For example, a test method that is optional may contain provisions.

ISO/IEC Directives Part 2 specify some elements as optional while they are mandatory for all SC 4 standards. For example, all SC 4 standards are required to include an introduction and one index.

Many of the elements in an SC 4 standard require specific wording. The convention used to delineate required wording from the other text of this document is specified in the introduction.

SC 4 has agreed with ISO Central Secretariat that the parts of each SC 4 standard shall be prepared and published only in the English language.

NOTE

Translation of SC 4 standards into other languages is not recommended (see 4.1.5.3). National bodies wishing to translate SC 4 standards into other languages for publication should base the translation on the corrected proof of the English language edition.

4.1 Preliminary elements XE "preliminary element"

XE "preliminary element"

XE "elements:preliminary"

XE "cover page" Preliminary elements are those elements that introduce a standard. A list of preliminary elements for parts of SC 4 standards is given in Table 2.

4.1.1 Cover page

The ISO Central Secretariat will prepare the final cover page. For all stages prior to IS or TS publication, each SC 4 standard shall have a cover page that summarizes the status of the SC 4 standard in the standardization process. This page serves as a cover for the SC 4 standard until ISO prepares the official version, and shall be attached to all documents distributed for comment.

The requirements specified in 4.1.1.1, 4.1.1.2, and 4.1.1.3 apply to all SC 4 standards. The requirements specified in 4.1.1.4 only apply to parts of ISO 10303.

4.1.1.1 Contents of the cover page

The cover page shall contain the following information:

· the N-number (assigned by a working group or by SC 4) that identifies the document;

NOTE

See the SC 4 Quality manual [28], 7.2, for information on N-numbers.

· the N-number that identifies the previous version of the document (if any);

· the document reference (see 5.2.1.1, Table 6);

· the edition number;

· the document title (see 4.2.2);

· the date on which the document is published or distributed;

· a copyright statement (see 4.1.1.2);

· information about the approval status of the document (see 0);

· an abstract that summarizes the content of the standard using the concepts and wording of the scope clause;

NOTE 1 If there is no abstract provided, the scope statement will be provided as the abstract.

· a list of keywords that can be used in an information retrieval system to indicate the content of the standard.

The cover page may contain the following additional information:

· contact information for the project leader and part editor;

NOTE 2

SC 4 encourages including this contact information; however, in accordance with the ISO Technical Management Board’s policy on privacy, the project leader or part editor may elect to omit this information.

· information telling readers where and how they can submit comments against the document.

4.1.1.2 Copyright information to be included on the cover page XE "copyright" The cover page shall include copyright information. Use the following wording for working draft and Committee Draft documents:

[SC 4 required]

This ISO document is a working draft or Committee Draft and is copyright protected by ISO. While the reproduction of working drafts or Committee Drafts in any form for use by Participants in the ISO standards development process is permitted without prior permission from ISO, neither this document nor any extract from it may be reproduced, stored or transmitted in any form for any other purpose without prior written permission from ISO.

Requests for permission to reproduce this document for the purposes of selling it should be addressed as shown below (via the ISO TC 184/SC 4 Secretariat’s member body) or to ISO's member body in the country of the requester.

Copyright Manager

ANSI

11 West 42nd Street New York, New York 10036

USA

phone: +1-212-642-4900 fax: +1-212-398-0023

Reproduction for sales purposes may be subject to royalty payments or a licensing agreement.

Violators may be prosecuted.

[end required]

NOTE

See the introduction of this standing document for a description of the convention used to delineate text to be included in SC 4 standards.

Use the following wording for Draft International Standard and Final Draft International Standard documents:

[ISO required]

This ISO document is a <insert “Draft International Standard” or “Final Draft International Standard” as appropriate> and is copyright-protected by ISO. Except as permitted under the applicable laws of the user's country, neither this ISO draft nor any extract from it may be reproduced, stored in a retrieval system or transmitted in any form or by any means, electronic, photocopying, recording, or otherwise, without prior written permission being secured.

Requests for permission to reproduce should be addressed to ISO at the address below or ISO's member body in the country of the requester:

ISO copyright office Case postale 56. CH-1211 Geneva 20 Tel. + 41 22 749 01 11 Fax + 41 22 734 10 79 E-mail copyright@iso.ch Reproduction for sales purposes for any of the above-mentioned documents may be subject to royalty payments or a licensing agreement.

Violators may be prosecuted.

[end required]

All drafts submitted for comment shall include on the cover page the following text:

[ISO required]

Recipients of this draft are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.

[end required]

4.1.1.3 Required text for approval status XE "approval:required text" Use the following wording to indicate the review(s) and approval(s) that apply to the document.

NOTE 1

The “Comments to reader” section of the cover page template in A.1 can be used for this information.

NOTE 2

Procedures for review and approval of SC 4 standards are specified in the SC 4 Organization handbook [27] and the SC 4 Quality manual [28].

Use the following if a document is being distributed after the internal review has been completed but before the project leader and convener reviews have been done:

[SC 4 required]

This document has been reviewed using the internal review checklist (see <N- number of completed checklist>).

[end required]

Use the following if a document is being distributed after the internal review and project leader have been completed but before the convener review has been done:

[SC 4 required]

This document has been reviewed using the internal review checklist (see <N- number of completed checklist>) and the project leader checklist (see <N- number of completed checklist>).

[end required]

NOTE 3

SC 4 does not require publication of documents at these intermediate points in the review and approval process; see the SC 4 Quality manual [28] for details of the review, approval, and publication procedures.

Use the following wording when the document has completed the review and approval process and is being submitted for ballot or publication:

[SC 4 required]

This document has been reviewed using the internal review checklist (see <N- number of completed checklist>), the project leader checklist (see <N- number of completed checklist>), and the convener checklist (see <N- number of completed checklist>), and is ready for this ballot cycle.

[end required]

In the last case, if the document is ready for publication (IS or TS) rather than balloting, substitute the phrase “… and is ready for publication”.

These wording forms should be used after a document has been through the note review stage(s); do not, for example, put the text from the boilerplate preceding NOTE 3 above in the comments to reader if the document is being submitted for project leader review.

4.1.1.4 Additional requirements for parts of ISO 10303 XE "ISO 10303" A sample cover page for ISO 10303 parts is presented in A.1 of this standing document. Use this sample as the basis for the cover page for each part of ISO 10303.

4.1.2 Copyright statement XE "copyright"

The ISO Central Secretariat will prepare the reverse of the final cover page (page ii). For all stages prior to IS or TS publication, each SC 4 standard shall include a copyright notice at the bottom of page ii. Do not place other text (apart from the standard header and footer) on this page. The text for the copyright notice is follows:

[ISO required]

© ISO <year of publication>

All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from either ISO at the address below or ISO’s member body in the country of the requester.

ISO copyright office Case postale 56. CH-1211 Geneva 20 Tel. + 41 22 749 01 11 Fax + 41 22 734 10 79 E-mail copyright@iso.ch Web www.iso.ch

[end required]

4.1.3 Table of contents XE "contents:table of"

XE "table of contents" The table of contents shall begin on page iii. The title of the table of contents shall be “Contents”. The table of contents consists of three parts, as follows:

· a list of clauses, higher level subclauses, annexes, the bibliography (if present), and the index;

NOTE

In this standing document, the term “subclause” is used to refer to any subdivision of a clause or annex, independent of its level. For example, 4.1 and 4.1.2 are both referred to as “subclauses”.

· a list of figures (which may be omitted if the document does not include figures);

· a list of tables (which may be omitted if the document does not include tables).

The list of clauses begins with an entry for the scope clause and includes the complete title of each clause and higher-level subclause in the main body of the document and the page number on which each begins. Except for ISO 10303 application protocols and abstract test suites, the table of contents shall contain entries to the second level of subclause (to the subsubclause level) of the document. See 9.1.1 for requirements that apply to the table of contents of an AP and 10.2 for those that apply to the table of contents of an ATS. The table of contents does not include the terms defined in clause 3 of the standard.

The list of annexes shall include the complete title of each annex and the number of the page on which each begins. The index entries in the table of contents shall have the following form:

<ISO required>

Annex <letter> (<normative or informative>) <Annex title>

<end required>

NOTE

This form is required by ISO/IEC Directives Part 2:2004 and differs from that prescribed in earlier versions of the Directives. Do not use older standards as examples.

If the document includes a bibliography, list it in the table of contents and include the number of the page on which the bibliography begins.

The entry for the index shall include the page number on which the index begins.

If present, the list of figures shall be introduced by the heading “Figures” and include the number, complete title, and page number of each figure.

If present, the list of tables shall be introduced by the heading “Tables” and include the number, complete title, and page number of each table.

NOTE

See C.4 for an example of a table of contents.

The table of contents shall be generated automatically and not created manually.

4.1.4 Foreword XE "foreword"

A foreword shall appear in each SC 4 standard. It shall not contain requirements, figures or tables. It consists of a general part (supplied by the ISO Central Secretariat) and a specific part (supplied by SC 4). The wording to be used in the foreword depends on the type of the standard and its status.

NOTE

The text of the foreword may be amended by the ISO Central Secretariat prior to publication as an International Standard or Technical Specification.

The following instructions outline which paragraphs are required and which are optional. Each description is followed by the wording to be used to compose that part of the foreword. Any information not covered by the text described here does not belong in the foreword.