Revision 0 · 2021. 1. 19. · PPA AP-907-005.003 Rev. 0 Page 2 of 35 Prepared By: Dwight L....

PPA AP-907-005.003 Common Dynamic Instruction Model

(CDIM)

DECEMBER 30TH, 2020

Revision 0

Common Dynamic Instruction Model (CDIM)

PPA AP-907-005.003 Rev. 0

Page 2 of 35

Prepared By: Dwight L. Hargett, PPA Director of Projects and Johanna Oxstrand, Principal Investigator at Idaho National Laboratories. Reviewed By: DIRECTOR Project Leads and Core Team Members listed on Attachment 3, Acknowledgements along with an independent technical and editorial review by David Linders, Procedures Consultant, BCP Engineers and Consultants. Approved On: December 30th, 2020 Approved By: Linda Mar, PPA Chair Notice Neither PPA nor any of its employees, members, supporting organizations, contractors, or consultants make any warranty, expressed or implied, or assume any legal responsibility for the accuracy or completeness of, or assume any liability for damages resulting from any use of any information apparatus, methods, or process disclosed in this standard or that such may not infringe privately owned rights. © Copyright 2020. This information is the property of the Procedure Professionals Association, Inc. (PPA). All rights reserved. ___________________________________________________________________________


PPA AP-907-005.003 Rev. 0

Page 3 of 35

REVISION SUMMARY DESCRIPTION

New supporting document for PPA AP-907-005, Procedure Writer's Manual, that provides a standard set of XML Elements and Attributes for digitally executed instructions on how to perform a task. Developing within the CDIM structure will allow for dynamic instructions to be shared, viewed, converted, and understood between adopters of the CDIM.


PPA AP-907-005.003 Rev. 0

Page 4 of 35

TABLE OF CONTENTS

SECTION .......................................................................................................................... PAGE

1.0 PURPOSE ..................................................................................................................... 6

2.0 SCOPE .......................................................................................................................... 6

3.0 DEFINITIONS ................................................................................................................ 6

4.0 INSTRUCTIONS ............................................................................................................ 6

4.1 CDIM XML Schema ....................................................................................................... 6

5.0 GENERAL INFO AND ACKNOWLEDGEMENTS .......................................................... 7

6.0 REFERENCES AND COMMITMENTS .......................................................................... 7

ATTACHMENT 1 – List of Acronyms .......................................................................................... 8

ATTACHMENT 2 – PPA XML Schema Summary Report ........................................................... 9

1.0 Schema ......................................................................................................................... 9

1.1 Global Elements ............................................................................................................ 9

1.2 Schema Elements, Attributes, Attribute Groups, and Simple Types ............................ 11 1.2.1 Element – DynamicInstructionSet ................................................................................ 11 1.2.2 Element – DynamicInstructionInfo ............................................................................... 12 1.2.3 Element – Section ....................................................................................................... 13 1.2.4 Element – StepInfo ...................................................................................................... 14 1.2.5 Element – StepAction .................................................................................................. 15 1.2.6 Element – NumericDataEntry ...................................................................................... 17 1.2.7 Element – TextDataEntry ............................................................................................. 18 1.2.8 Element – DateDataEntry ............................................................................................ 19 1.2.9 Element – BooleanDataEntry ...................................................................................... 20 1.2.10 Element – AttachmentDataEntry ................................................................................. 20 1.2.11 Element – Alarm .......................................................................................................... 21 1.2.12 Element – Note ............................................................................................................ 21 1.2.13 Element – Caution ....................................................................................................... 22 1.2.14 Element – Warning ...................................................................................................... 22 1.2.15 Element – Figure ......................................................................................................... 22 1.2.16 Element – HTMLTable ................................................................................................. 23 1.2.17 Element – Repositions ................................................................................................. 23 1.2.18 Element – Reposition .................................................................................................. 24 1.2.19 Element – Status ......................................................................................................... 24 1.2.20 Element – CALSTable ................................................................................................. 25 1.2.21 Element – table ............................................................................................................ 25


PPA AP-907-005.003 Rev. 0

Page 5 of 35 1.2.22 Element – row .............................................................................................................. 25 1.2.23 Element – entry ........................................................................................................... 26 1.2.24 Element – VariableData ............................................................................................... 26 1.2.25 Attribute Group – StepAttribs ....................................................................................... 27 1.2.26 Attribute Group – ActionStepAttribs ............................................................................. 27 1.2.27 Simple Type – Verbs ................................................................................................... 28 1.2.28 Attribute Group – DataInfo ........................................................................................... 28 1.2.29 Attribute Group – ComponentInfo ................................................................................ 29 1.2.30 Attribute – StatusValue ................................................................................................ 29 1.2.31 Element – GoTo .......................................................................................................... 29 1.2.32 Attribute – Number ...................................................................................................... 30 1.2.33 Element – Paragraph ................................................................................................... 30 1.2.34 Element – Verification .................................................................................................. 30 1.2.35 Element – Data ............................................................................................................ 31 1.2.36 Element – RepositionData ........................................................................................... 31 1.2.37 Element – AdHocDataCaptured .................................................................................. 31 1.2.38 Element – Form ........................................................................................................... 32 1.2.39 Element – Fragment .................................................................................................... 32 1.2.40 SimpleType – ID .......................................................................................................... 33 1.2.41 Element – Link ............................................................................................................. 33 1.2.42 Element – Revisions .................................................................................................... 33 1.2.43 Element – Revision ...................................................................................................... 34 1.2.44 Element – Change ....................................................................................................... 34 1.2.45 Element – Basis ........................................................................................................... 35


PPA AP-907-005.003 Rev. 0

Page 6 of 35 1.0 PURPOSE

1. This document captures a content summary report output from the XML Schema for a Common Dynamic Instruction Model (CDIM). This model was developed by a broad spectrum of Energy Sector document specialist as part of an Idaho National Laboratory (INL) and Procedure Professionals Association, Inc. (PPA) co-sponsored initiative titled Dynamic Instructions Editing Tool Requirements (DIRECTOR).

2. This document and associated XML Schema work in concert with AP-907-005.002, Dynamic Instruction Set Editor Functional Requirements.

3. This document and associated XML Schema are designed to work in concert with AP-907-005.002, Dynamic Instruction Set Editor Functional Requirements. As new desired functional requirements are added to AP-907-005.002, the CDIM is enhanced to provide a standard structure that supports implementation of the new functionality.

2.0 SCOPE

1. Presentation of a basic summary of the PPA CDIM XML Schema.

3.0 DEFINITIONS

1. None

4.0 INSTRUCTIONS

4.1 CDIM XML Schema

1. Refer to Attachment 1, PPA XML Schema Summary Report, for an XML Report that lists the key Elements and Attributes of the PPA CDIM XML Schema. The content of this report is generated directly from the PPA CDIM XML Schema using an XML Editor.

2. While this report captures the principle Elements and Attributes of the PPA CDIM, it is not a comprehensive output of the XML code. For a more complete review, contact PPA to obtain a copy of the PPA CDIM and review using an XML Editor.

3. While the PPA CDIM is presented using XML, this is not intended to imply that XML is the only software solution that can be used to implement this schema.


PPA AP-907-005.003 Rev. 0

Page 7 of 35 5.0 GENERAL INFO AND ACKNOWLEDGEMENTS

1. The initiative that created this report, Dynamic Instructions Editing Tool Requirements (DIRECTOR) was initiated by Johanna Oxstrand, Principle Investigator at INL and co-sponsored by PPA with Dwight Hargett, PPA Director of Projects serving as PPA Lead.

2. Refer to AP-907-005.002, Dynamic Instruction Set Editor Functional Requirements and Implementation Considerations for a more complete description of the DIRECTOR initiative and acknowledgements.

6.0 REFERENCES AND COMMITMENTS

1. AP-907-005 Rev. 3, Procedure Writer's Manual

2. AP-907-005.001 Rev. 0, Functional Requirements for Advanced and Adaptive Smart Documents.

3. AP-907-005.002 Rev. 0, Dynamic Instruction Set Editor Functional Requirements

4. XML Schema Definition

https://en.m.wikipedia.org/wiki/XML_Schema_(W3C)

Dynamic Instruction Set Editor Functional Requirements

PPA AP-907-005.003 Rev. 0

Page 8 of 35

ATTACHMENT 1 Page 1 of 1

List of Acronyms

CDIM Common Dynamic Instruction Model

DIRECTOR Dynamic Instructions Editing Tool Requirements

INL Idaho National Laboratory

PPA Procedure Professionals Association, Inc.

Dynamic Instruction Set Editor Functional Requirements

PPA AP-907-005.003 Rev. 0

Page 9 of 35

ATTACHMENT 2 Page 1 of 27

PPA XML Schema Summary Report

1.0 Schema

1.1 Global Elements

Element Name Description

DynamicInstructionSet

Main Root Element. A controlled and organized set of digital instructions designed to improve human performance by clearly providing the purpose, specific intent, and sequenced direction for an activity, program, or process using a digital form of data display that takes advantage of the computational capabilities of the digital platform to further improve the human performance and efficiency of work execution while also enabling improved data management and analytics through interfaces to supporting digital systems and programs.

DynamicInstructionInfo Metadata about this document.

Section A sequence of steps that have their own heading and are intended to be executed in a stand-alone manner. StepInfo An information step that provides information (does not direct action). StepAction An action step that directs the user to perform an action against an object. NumericDataEntry Used to define numeric input information. TextDataEntry Used to define text input information. DateDataEntry Used to define date input information. BooleanDataEntry Used to define boolean input information. AttachmentDataEntry Used to define information about the requested attachment information. Alarm Defines an alarm checked after data entry.

Note A statement that provides explanatory information to support a step or series of steps.

Caution

A statement displayed immediately prior or in conjunction with applicable step(s) that informs users of undesirable equipment results such as potential for equipment damage, plant transients, or conditions that may adversely affect plant operation.

Warning A statement displayed immediately prior or in conjunction with applicable steps to warn users of potential for personnel injury, loss of life, or health hazards.

Figure A diagram or pictorial illustration of textual matter.

HTMLTable A systematic arrangement of data usually in rows and columns for ready reference.

Common Dynamic Instruction Model (CDIM) PPA AP-907-005.003 Rev. 0

Page 10 of 35 ATTACHMENT 2

Page 2 of 27

PPA XML Schema Summary Report (cont.)

Element Name Description Repositions A group of component repositions. Reposition A reposition step for a specific component. Status Section that records status changes. CALSTable Defines a CALS formatted data structure of a table representation. table CALS table object. row CALS row object. entry CALS entry object.

VariableData Used to dynamically change variables within a generic document to a specific instance. GoTo Used to control flow in a document. Paragraph Generic Paragraph element. Verification Data Element: Added during execution. Holds verification data. Data Data Element: Added during execution. Holds user entered data. RepositionData Data Element: Added during execution. Holds reposition data.

AdHocDataCaptured Data Element: Additional information gathered/entered the execution of the data.

Form Specialized content model for the type of content typically needed in technical forms. Fragment Reference to dynamic content to emplace when creating the document.

Link Reference to external linked document to be launched outside of this document. Revisions Collection of revision elements. Revision Information about a document revision. Change Details of a change to the document associated with a revision.

Basis Captures the basic information that explains what the step is about and any regulatory drivers for the step. Table 1 - Global Elements



Page 3 of 27


1.2 Schema Elements, Attributes, Attribute Groups, and Simple Types

1.2.1 Element – DynamicInstructionSet

1. Main Root Element - A controlled and organized set of digital instructions designed to improve human performance by clearly providing the purpose, specific intent, and sequenced direction for an activity, program, or process using a digital form of data display that takes advantage of the computational capabilities of the digital platform to further improve the human performance and efficiency of work execution while also enabling improved data management and analytics through interfaces to supporting digital systems and programs.

2. Children are:

Element Type Min Max DynamicInstructionInfo 1 1 Section 1 unbounded AdHocDataCaptured 0 1 Form 0 unbounded Notes 0 unbounded Fragment 0 unbounded Link 0 unbounded Revisions 0 1 VariableData 0 1

Table 2 - Children of Element DynamicInstructionSet

Total Children 1 to unbounded



Page 4 of 27


1.2.2 Element – DynamicInstructionInfo

1. Meta data about this document.

2. Attributes are:

Name Use Type Restrictions Annotation

WorkAgainst optional string Component that a Work Order is written against.

Template optional string This can capture the Model WO Number, Work Scope Library Number, Work Job Plan Number, etc.

ID required Unique object ID within this document.

UniqueID optional string Max length:50 Unique document ID within the document library. Title optional string Max length:100

Number optional string Max length:25

Revision optional string Max length:25

Objective optional string

EffectiveDate optional date

Type required string High-level document type (ex: Procedure...). SubType optional string Max length:50 Refinement of document type.

LevelOfUse optional Choices: Continuous Use; Information Use; Reference Use

DocumentNamespace optional anyURI

RelatedDocumentID optional string Max length:50

Facility optional string

Unit optional string

SafetyClass optional string

ResponsibleDept optional string Owning department of this document.

QualCode optional string Specific qualification required to be able to perform this task. Table 3 - Attributes of Element DynamicInstructionInfo



Page 5 of 27


3. Children are:

Element Type Min Max SpecialConsideration 0 unbounded UserDefinedAttribute 0 unbounded ReviewAndApproval 0 unbounded QualCode 0 unbounded

Table 4 - Children of DynamicInstructionInfo


1.2.3 Element – Section

1. A sequence of steps that have their own heading and are intended to be executed in a stand-alone manner.

2. Attributes are:

Name Use Type Restrictions Annotation ID required optional

Title optional string Describes what will be accomplished.

Applicability optional string

Equation that is solved to test whether or not this section is applicable.

NumberedChildren optional boolean

If true, child steps are numbered and will be executed sequentially. If false, child steps are bulleted and executed in any order.

Table 5 - Attributes of Element Section



Page 6 of 27


3. Children are:

Element Type Min Max StepAction 0 unbounded StepInfo 0 unbounded Note 0 unbounded Caution 0 unbounded Warning 0 unbounded Paragraph 0 unbounded Figure 0 unbounded GoTo 0 1 Section 0 unbounded Form 0 unbounded Link 0 unbounded QualCode 0 unbounded

Table 6 - Children of Element Section


1.2.4 Element – StepInfo

1. An information step that provides information (does not direct action).

2. Attributes are:

Name Use Type Restrictions Annotation ID required

Text required string

StepAttribs optional Table 7 - Attributes of Element StepInfo



Page 7 of 27


3. Children are:

Element Type Min Max Paragraph 0 unbounded Link 0 unbounded Basis 0 unbounded

Table 8 - Children of Element StepInfo


1.2.5 Element – StepAction

1. An action step that directs the user to perform an action against an object.

2. Attributes are:


StepType required string

Choices: Simple action; If Then; When Then; While

Condition optional string

Action optional string

ItemType optional string Max length:25

HoldPointStart optional boolean

HoldPointEnd optional boolean

AdditionalInfo optional string

QualCode optional string

Specific qualification required to be able to perform this task.

ResponsiblePerformer optional Department/staff responsible for executing step.

ActionStepAttribs optional

ComponentInfo optional



Page 8 of 27


Table 9 - Attributes of StepAction

3. Children are:

Element Type Min Max Note 0 unbounded Caution 0 unbounded Warning 0 unbounded Paragraph 0 unbounded Reposition 0 1 Repositions 0 1 Status 0 unbounded Verification 0 unbounded NumericDataEntry 0 unbounded TextDataEntry 0 unbounded BooleanDataEntry 0 unbounded DateDataEntry 0 unbounded AttachmentDataEntry 0 unbounded Figure 0 1 HTMLTable 0 unbounded RefNote 0 unbounded StepAction 0 unbounded Link 0 unbounded StepInfo 0 unbounded Basis 0 unbounded

Table 10 - Children of Element StepAction




Page 9 of 27


1.2.6 Element – NumericDataEntry

1. Used to define numeric input information.

2. Attributes are:


Units optional string Max length:10 Engineering units of the gathered value.

Minimum optional float Expected minimum value. Maximum optional float Expected maximum value. DataInfo optional

Table 11 - Attributes of Element NumericDataEntry

3. Children are:

Element Type Min Max Alarm 0 unbounded Data 0 1

Table 12 - Children of Element NumericDataEntry




Page 10 of 27


1.2.7 Element – TextDataEntry

1. Used to define text input information.

2. Attributes are:


AllowOther optional boolean

DataInfo optional Table 13 - Attributes of Element TextDataEntry

3. Children are:

Element Type Min Max Choice 0 unbounded Alarm 0 unbounded Data 0 1

Table 14 - Children of Element TextDataEntry




Page 11 of 27


1.2.8 Element – DateDataEntry

1. Used to define date input information.

2. Attributes are:


Minimum optional dateTime

Maximum optional dateTime

DataInfo optional Table 15 - Attributes of Element DateDataEntry

3. Children are:


Table 16 - Children of Element DateDataEntry




Page 12 of 27


1.2.9 Element – BooleanDataEntry

1. Used to define boolean input information.

2. Attributes are:


TrueValue optional string

FalseValue optional string

DataInfo optional Table 17 - Attributes of Element BooleanDataEntry

3. Children are:


Table 18 - Children of Element BooleanDataEntry


1.2.10 Element – AttachmentDataEntry

1. Used to define information about the requested attachment information.

2. Attributes are:


DataInfo optional Table 19 - Attributes of Element AttachmentDataEntry

3. Children are:

Element Type Min Max Data 0 1

Table 20 - Children of Element AttachmentDataEntry




Page 13 of 27


1.2.11 Element – Alarm

1. Defines an alarm checked after data entry.

2. Attributes are:


Setpoint optional string

ComparisonOperator optional string

Choices: Less than; Less than or equal to; Equal to; Greater than or equal to; Greater than; Not equal to; etc.

Equation optional

AlarmMessage required string

InAlarm optional boolean Table 21 - Attributes of Element Alarm

1.2.12 Element – Note

1. A statement that provides explanatory information to support a step or series of steps.

2. Attributes are:


Note optional string Table 22 - Attributes of Element Note

3. Sequence is:

Element Min Max AppliesTo min=0 max=unbounded

Table 23 - Sequence for Element Note



Page 14 of 27


1.2.13 Element – Caution

1. A statement displayed immediately prior or in conjunction with applicable step(s) that informs users of undesirable equipment results such as potential for equipment damage, plant transients, or conditions that may adversely affect plant operation.

2. Attributes are:


Number optional

Cause optional string Max length:100

Effect optional string Table 24 - Attributes of Element Caution

1.2.14 Element – Warning

1. A statement displayed immediately prior or in conjunction with applicable steps to warn users of potential for personnel injury, loss of life, or health hazards.

2. Attributes are:


Number optional

Cause optional string

Effect optional string Table 25 - Attributes of Element Warning

1.2.15 Element – Figure

1. A diagram or pictorial illustration of textual matter.

2. Attributes are:


FileName required anyURI

Caption optional string Table 26 - Attributes of Element Figure



Page 15 of 27


1.2.16 Element – HTMLTable

1. A systematic arrangement of data usually in rows and columns for ready reference.

2. Attributes are:


HTML optional string Table 27 - Attributes of Element HTML Table

1.2.17 Element – Repositions

1. A group of component repositions.

2. Attributes are:


HowMany optional int

Ordered optional boolean Table 28 - Attributes of Element Repositions

3. Sequence is:

Element Min Max Reposition min=1 max=unbounded

Table 29 - Sequence for Element Repositions



Page 16 of 27


1.2.18 Element – Reposition

1. A reposition step for a specific component.

2. Attributes are:


Status required string Max length:50

Temporary required string Choices:Temporary;Final;

Position required string

ExpectedPosition optional string

ComponentInfo optional Table 30 - Attributes of Element Reposition

3. Sequence is:

Element Min Max RepositionData min=1 max=1

Table 31 - Sequence for Element Reposition

1.2.19 Element – Status

1. Section that records status changes.

2. Attributes are:

Name Use Type Restrictions Annotation StatusValue optional string

StatusBy required string Name/ID of performer StatusDate required dateTime

Notes optional string Captures reason for N/A of a non-conditional step.

NAApprovedBy optional string Supervisor approving N/A of a non-conditional step. Table 32 - Attributes of Element Status



Page 17 of 27


1.2.20 Element – CALSTable

1. Defines a CALS formatted data structure of a table representation.

2. Sequence is:

Element Min Max table min=1 max=1

Table 33 - Seqence for Element CALSTable

1.2.21 Element – table

1. CALS table object.

2. Attributes are:

Name Use Type Restrictions Annotation rows optional int

Number optional string Table 34 - Attributes of Element table

3. Sequence is:

Element Min Max tgroup min=1 max=1

Table 35 - Sequence for Element table

1.2.22 Element – row

1. CALS row object.

2. Attributes are:

Name Use Type Restrictions Annotation num optional int

Table 36 - Attributes of Element row

3. Sequence is:

Element Min Max entry min=0 max=unbounded

Table 37 - Sequence for Element row



Page 18 of 27


1.2.23 Element – entry

1. CALS entry object.

2. Attributes are:

Name Use Type Restrictions Annotation valign optional string Choices: top

num optional int Table 38 - Attributes of Element entry

3. Children are:

Element Type Min Max Paragraph 0 1 NumericDataEntry 0 1 DateDataEntry 0 1 BooleanDataEntry 0 1 TextDataEntry 0 1

Table 39 - Children of Element entry


1.2.24 Element – VariableData

1. Used to dynamically change variables within a generic document to a specific instance.

2. Sequence is:

Element Min Max Variable min=1 max=unbounded Table 40 - Sequence for Element VariableData



Page 19 of 27


1.2.25 Attribute Group – StepAttribs

1. Attributes are:

Name Use Type Restrictions Annotation Number optional

Status optional string

Max length:15 Choices: Not started; In Progress; Completed

Table 41 - Attributes of Attribute Group StepAttribs

1.2.26 Attribute Group – ActionStepAttribs

1. Attributes are:

Name Use Type Restrictions Annotation CriticalLocation optional string

ActionVerb optional Verbs The action verb for the caption item. Object optional

CriticalSupplementalInformation optional

RequiresIV optional boolean

RequiresCV optional boolean

RequiresQA optional boolean

RequiresPC optional boolean

Applicability optional string

Equation that is solved to test whether or not this section is applicable.

Critical optional boolean Table 42 - Attributes of Attribute Group ActionStepAttribs



Page 20 of 27


1.2.27 Simple Type – Verbs

1. Defined list of expected verbs. Also allows any verb.

a. Base: string

(1) Choices: Annotate; Complete; Continue; Determine; Document; Ensure; Identify, Install; Obtain; Open; Perform; Restore; Unlock; Unlock and Close; Refer To; GoTo; etc.

b. Base: string

• Max length:25

• Any value

1.2.28 Attribute Group – DataInfo

1. Attributes are:

Name Use Type Restrictions Annotation Unnumbered optional boolean

Number optional string Max length:15

Prompt required string

Varname required string Max length:50 Unique identifier for this value (PointID for example).

Required optional boolean Table 43 - Attributes of Attribute Group DataInfo



Page 21 of 27


1.2.29 Attribute Group – ComponentInfo

1. Attributes are:

Name Use Type Restrictions Annotation CompID optional string Max length:50

CompDescription optional string Max length:200

Building optional string Max length:25

Elevation optional string Max length:25

Room optional string Max length:25

Location optional string Max length:100 Table 44 - Attributes of Attribute Group ComponentInfo

1.2.30 Attribute – StatusValue

Type string Choices Not Started; In Progress; Complete; N/A Description List of status values for a step.

Table 45 - Attribute StatusValue

1.2.31 Element – GoTo

1. Used to control flow in a document.

2. Attributes are:


Condition optional Equation to evaluate. StepNo optional

Table 46 - Attributes of Element GoTo



Page 22 of 27


1.2.32 Attribute – Number

Type string Max length 18 Description Defines restrictions on the document number.

Table 47 - Attribute Number

1.2.33 Element – Paragraph

1. Generic Paragraph element.

2. Attributes are:

Name Use Type Restrictions Annotation ID required int

Number optional

Text optional string

Important optional Table 48 - Attributes of Element Paragraph

1.2.34 Element – Verification

1. Data Element: Added during execution. Holds verification data.

2. Attributes are:


VerificationType required string Choices: Independent; Concurrent; QA; Peer

VerifiedBy required string

VerificationDate required dateTime Table 49 - Attributes of Element Verification



Page 23 of 27


1.2.35 Element – Data

1. Data Element: Added during execution. Holds user entered data.

2. Attributes are:

Name Use Type Restrictions Annotation Value optional string

GatheredBy optional string

GatheredDate optional dateTime

InAlarm optional boolean

Notes optional string Table 50 - Attributes of Element Data

1.2.36 Element – RepositionData

1. Data Element: Added during execution. Holds reposition data.

2. Attributes are:

Name Use Type Restrictions Annotation Position optional string

PositionedBy optional string

PositionedDate optional dateTime

Alarm optional boolean

Notes optional string Table 51 - Attributes of Element RepositionData

1.2.37 Element – AdHocDataCaptured

1. Data Element: Added during execution. Additional information gathered and entered during execution.

2. Sequence is:

Element Min Max Data min=0 max=unbounded Table 52 - Sequence for Element AdHocDataCapture



Page 24 of 27


1.2.38 Element – Form

1. Specialized content model for the type of content typically needed in technical forms.

2. Attributes are:

Name Use Type Restrictions Annotation Number optional string

Title optional

Reference optional anyURI

ID required int Table 53 - Attributes of Element Form

3. Sequence is:

Element Min Max Paragraph min=0 max=unbounded CALSTable min=0 max=unbounded FixedLayout min=0 max=unbounded

Table 54 - Sequence for Element Form

1.2.39 Element – Fragment

1. Reference to dynamic content to emplace when creating the document.

2. Attributes are:

Name Use Type Restrictions Annotation ID required int

RefID required int

TargetID optional int Table 55 - Attributes of Element Fragment



Page 25 of 27


1.2.40 SimpleType – ID

1. Unique object ID within this document.

• Base: int

• Any value

1.2.41 Element – Link

1. Reference to external linked document to be launched outside of this document.

2. Attributes are:

Name Use Type Restrictions Annotation Caption optional string

URI required anyURI URL or filepath of the link.

Target optional string Specific point within the linked media (bookmark, page, frame...)

Notes optional string Table 56 - Attributes of Element Link

1.2.42 Element – Revisions

1. Collection of revision elements.

2. Sequence is:

Element Min Max Revision min=0 max=unbounded

Table 57 - Sequence for Element Revisions



Page 26 of 27


1.2.43 Element – Revision

1. Information about a document revision.

2. Attributes are:

Name Use Type Restrictions Annotation RevNo optional

CreatedBy optional string

EditedBy optional string Table 58 - Attributes of Element Revision

3. Sequence is:

Element Min Max Change min=0 max=unbounded

Table 59 - Sequence for Element Revision

1.2.44 Element – Change

1. Details of a change to the document associated with a revision.

2. Attributes are:


Type optional string Choices: Add; Edit; Delete Type of change being made.

ID optional int Unique Key of the entity changed.

Number optional Not necessary, but convenient.

AttName optional Name of the attribute that was changed.

OriginalValue optional

UpdatedValue optional

Comments optional Table 60 - Attributes of Element Change



Page 27 of 27


1.2.45 Element – Basis

1. Captures the basic information that explains what the step is about and any regulatory drivers for the step.

2. Attributes are:

Name Use Type Restrictions Annotation ID optional

Source optional string

Title optional string

Requirement optional string

Notes optional string Table 61 - Attributes of Element Basis

1.0 PURPOSE2.0 SCOPE3.0 DEFINITIONS4.0 INSTRUCTIONS4.1 CDIM XML Schema

5.0 GENERAL INFO AND ACKNOWLEDGEMENTS6.0 REFERENCES AND COMMITMENTS1.0 Schema1.1 Global Elements1.2 Schema Elements, Attributes, Attribute Groups, and Simple Types1.2.1 Element – DynamicInstructionSet1.2.2 Element – DynamicInstructionInfo1.2.3 Element – Section1.2.4 Element – StepInfo1.2.5 Element – StepAction1.2.6 Element – NumericDataEntry1.2.7 Element – TextDataEntry1.2.8 Element – DateDataEntry1.2.9 Element – BooleanDataEntry1.2.10 Element – AttachmentDataEntry1.2.11 Element – Alarm1.2.12 Element – Note1.2.13 Element – Caution1.2.14 Element – Warning1.2.15 Element – Figure1.2.16 Element – HTMLTable1.2.17 Element – Repositions1.2.18 Element – Reposition1.2.19 Element – Status1.2.20 Element – CALSTable1.2.21 Element – table1.2.22 Element – row1.2.23 Element – entry1.2.24 Element – VariableData1.2.25 Attribute Group – StepAttribs1.2.26 Attribute Group – ActionStepAttribs1.2.27 Simple Type – Verbs1.2.28 Attribute Group – DataInfo1.2.29 Attribute Group – ComponentInfo1.2.30 Attribute – StatusValue1.2.31 Element – GoTo1.2.32 Attribute – Number1.2.33 Element – Paragraph1.2.34 Element – Verification1.2.35 Element – Data1.2.36 Element – RepositionData1.2.37 Element – AdHocDataCaptured1.2.38 Element – Form1.2.39 Element – Fragment1.2.40 SimpleType – ID1.2.41 Element – Link1.2.42 Element – Revisions1.2.43 Element – Revision1.2.44 Element – Change1.2.45 Element – Basis

Date post:	10-Feb-2021
Category:	Documents
Upload:	others
View:	5 times
Download:	0 times