Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update WorkflowSpecificationNodeTypeType to align with updated ISA-950004 #47

Open
racheliurui opened this issue Aug 28, 2019 · 9 comments
Assignees
Labels
ERDi Issues that need to be fixed in ERDi version Medium MESA Issues that need to be fixed in MISA Version

Comments

@racheliurui
Copy link
Collaborator

racheliurui commented Aug 28, 2019

MESAInternational/B2MML-BatchML#49

Background
Explicitly Align B2MML with updated 950004 Workflow Specification Model, Clause 6.16.7 Workflow specification node type.

Supporting Document
ISA-950004 JWG5 CDV01 version (2019 12)
Clause 6.16.8 Workflow specification node type
Table 43 – Workflow specification node type relationship roles
Table 44 – Workflow specification node type attributes

Impacted Types and Solution
Related Issues #48, #50, #51
complexType name = "WorkflowSpecificationNodeTypeType"

  1. Global Element
    1.1. ADD <xsd:element name = "WorkflowSpecificationNodeType" type = "WorkflowSpecificationNodeTypeType" />

  2. Transaction Elements
    2.1. ADD: All transaction elements for WorkflowSpecificationNodeType

  3. Simple & Complex Types
    3.1. ADD: to incorporate new proposed element

  1. WorkflowSpecificationNodeTypeType Transaction Types
    4.1. ADD All transaction types for WorkflowSpecificationNodeTypeType
racheliurui referenced this issue Aug 28, 2019
ERDi, MESA:  complexType name = "WorkflowSpecificationInformationType">
CHANGE:  
- element name = "WorkflowSpecificationType"   type = "WorkflowSpecificationTypeType"  TO
     "WorkflowSpecificationNodeType"   type = "WorkflowSpecificationNodeTypeType" 
ADD:
- element name = "WorkflowSpecificationConnectionType"   type = "WorkflowSpecificationConnectionTypeType" minOccurs = "0" maxOccurs = "unbounded"/>

ERDi, MESA:  complexType name = "WorkflowSpecificationType">
CHANGE:
- element name = "Node" minOccurs = "0" maxOccurs = "unbounded"/> TO 
     "WorkflowSpecificationNode" minOccurs = "1" maxOccurs = "unbounded"/>
- element name = "Connection" TO "WorkflowSpecificationConnection"
- element name = "WorkflowSpecificationProperty" type = "WorkflowPropertyType" TO 
     "WorkflowSpecificationProperty" type = "WorkflowSpecificationPropertyType" 
- element name = "IncludesThePropertiesOf" TO "WorkflowSpecificationNodeParent"
ADD:
- element name = "DefinitionType", type = "DefinitionTypeType", minOccurs = "0"/>

ERDi, MESA:  complexType name = "WorkflowPropertyType", 
CHANGE: 
- complexType name = "WorkflowPropertyType" TO  "WorkflowSpecificationPropertyType"
- element name = "WorkflowProperty" TO "WorkflowSpecificationPropertyChild"
DELETE:
- element name = "EvaluatedPropertyReference"
- element name = "TestResult"

ERDI, MESA: DELETE complexType name = "WorkflowSpecificationTypeType",  This is an intermediate type which simply refers to WorkflowSpecificationNodeTypeType and WorkflowSpecificationConnectionTypeType.  It is simply not needed especially since these types are individually exchanged as first order objects as master data.  Also, the name, WorkflowSpecificationType, is confusing since it implies that there is a type of Workflow Specification which there is not in the updated ISA-95 Part 2. 

ERDi, MESA: complexType name = "WorkflowSpecificationNodeType">
ADD:
- element name = "Version", type = "VersionType"  minOccurs = "0"/>
- element name = "EffectiveFrom", type = "DateTimeType"  minOccurs = "0" />	    
- element name = "EffectiveTo", type = "DateTimeType" minOccurs = "0" />
CHANGE: 
- element name = "NodeType" type = "IdentifierType" /> TO 
     "WorkflowSpecificationNodeTypeID type = "IdentifierType" minOccurs = "0" maxOccurs = "1"/>
- element name = "Property", type = "WorkflowSpecificationPropertyType" TO
      "WorkflowSpecifictionNodeProperty", type = "WorkflowSpecificationNodePropertyType"   
- element name = "IncludesThePropertiesOf" TO "WorkflowSpecificationNodeParent"
ADD: 
- element name = "WorkMasterID", type = "IdentifierType" />, minOccurs = "0" maxOccurs = "unbounded"/>
- element name = "WorkDirectiveID",type ="IdentifierType" />, minOccurs = "0" maxOccurs = "unbounded"/>

ERDi, MESA:  complexType name = "WorkflowSpecificationConnectionType"> 
CHANGE:
- element name = "ConnectionType" type = "IdentifierType" /> TO 
     "WorkflowSpecificationConnectionTypeID type = "IdentifierType" minOccurs = "0" maxOccurs = "1"/>
- element name = "FromNodeID" TO "FromWSNodeID" 
- element name = "ToNodeID" TO "ToWSNodeID" 
- element name = "Property", type = "WorkflowSpecificationPropertyType" TO
      "WorkflowSpecifictionConnectionProperty", type = "WorkflowSpecificationConnectionPropertyType"   
        
ERDi, MESA:  complexType name = "WorkflowSpecificationNodeTypeType"
ADD:
- element name = "Version", type = "VersionType"  minOccurs = "0"/>
- element name = "EffectiveFrom", type = "DateTimeType"  minOccurs = "0" />	    
- element name = "EffectiveTo", type = "DateTimeType" minOccurs = "0" />
CHANGE:
- element name = "Property", type = "WorkflowSpecificationPropertyType" TO
      "WorkflowSpecifictionNodeTypeProperty", type = "WorkflowSpecificationNodeTypePropertyType"   

ERDi, MESA:  complexType name = "WorkflowSpecificationConnectionTypeType"
ADD:
- element name = "Version", type = "VersionType"  minOccurs = "0"/>
- element name = "EffectiveFrom", type = "DateTimeType"  minOccurs = "0" />	    
- element name = "EffectiveTo", type = "DateTimeType" minOccurs = "0" />
CHANGE:
- element name = "Property", type = "WorkflowSpecificationPropertyType" TO
      "WorkflowSpecifictionConnectionTypeProperty", type = "WorkflowSpecificationConnectionTypePropertyType"
@racheliurui racheliurui added ERDi Issues that need to be fixed in ERDi version MESA Issues that need to be fixed in MISA Version labels Aug 28, 2019
racheliurui referenced this issue Aug 28, 2019
ERDi, MESA: complexType name = "WorkflowSpecificationType"  to align with updated Part 2 Workflow Specification Model.
CHANGE:  element name = "WorkflowSpecificationParent", type = "IdentifierType"   minOccurs = "0" maxOccurs = "unbounded"/> 
     TO minOccurs = "0" maxOccurs = "1"/>

ERDi, MESA: complexType name = "WorkflowSpecificationNodeType" to align with updated Part 2 Workflow Specification Model.
CHANGE:  element name = "WorkflowSpecificationNodeParent", type = "IdentifierType"   minOccurs = "0" maxOccurs = "unbounded"/>
      TO minOccurs = "0" maxOccurs = "1"/>

ERDi, MESA:  xsd:complexType name = "WorkflowSpecificationConnectionType"  to align with updated Part 2 Workflow Specification Model.
ADD:  
- element name = "Dependency", type="DependencyType"/>
- element name="DependencyFactor", type="ValueType" minOccurs="0"/>

ERDi, MESA:  complexType name = "WorkflowSpecificationNodeTypeType" to align with updated Part 2 Workflow Specification Model.
ADD:  element name = "HierarchyScope", type = "HierarchyScopeType" minOccurs = "0"/> to align with updated Part 2 best practice to apply Hierarchy Scope to 1st class objects, this addition was added and comment submitted to ISA-95 for consideration.

ERDi, MESA:  complexType name = "WorkflowSpecificationConnectionTypeType" to align with updated Part 2 Workflow Specification Model.
ADD:  
- element name = "HierarchyScope", type = "HierarchyScopeType" minOccurs = "0"/> to align with updated Part 2 best practice to apply Hierarchy Scope to 1st class objects, this addition was added and comment submitted to ISA-95 for consideration.
- element name = "FromWSNodeMultiplicity", type = "DescriptionType"  minOccurs = "0"/>
- element name = "ToWSNodeMultiplicity", type = "DescriptionType"  minOccurs = "0"/>
- element name = "Dependency" type="DependencyType"/>
- element name = "DependencyFactor" type="ValueType"  minOccurs="0"/>

ERDi, MESA:  DELETE the "Common group for all elements" types and replace with specific types to align with updated Part 2 Test Specification model.  These common group schema make relationship elements between common group schema very confusing.  
ADD: 
- complexType name = "WorkflowSpecificationNodePropertyType".  
- complexType name = "WorkflowSpecificationNodeTypePropertyType".  
- complexType name = "WorkflowSpecificationConnectionPropertyType".
-  complexType name = "WorkflowSpecificationConnectionTypePropertyType".  

ERDi, MESA:  complexType name = "WorkflowSpecificationPropertyType".  This type as defined in updated Part 2 Workflow Specification model is specific to the Workflow Specification object.  B2MML attempts to use as a "common group" schema for all property objects.  This is very confusing and does not support relationship elements.  
DELETE: 
- element name = "PropertyType". This is a Part 2 attribute for resource properties with defined attributes of class type, instance type, and default type which does not represent the types workflow specification property objects.
CHANGE:  
- element name = "Property" TO "WorkflowSpecificationPropertyChild"
@racheliurui
Copy link
Collaborator Author

racheliurui commented Sep 9, 2019

ADD:
element name = "Version", type = "VersionType" minOccurs = "0"/>
element name = "EffectiveFrom", type = "DateTimeType" minOccurs = "0" />
element name = "EffectiveTo", type = "DateTimeType" minOccurs = "0" />

Similiar as #48, from my perspective, the effective from and to control for a workflow (work specification) should be at work specification level not at Node level.
A node is an action/ service participated in the flow, it might have a different life cycle when participating in different flows.
I agree node can have a version but I didn't see why node needs to "effective from and to."

=========================
This is master data. we are proposing any master data would have Effective From and To.
This might help with avoiding reference an invalid node type for a node.

@racheliurui
Copy link
Collaborator Author

racheliurui commented Sep 9, 2019

ADD: element name = "HierarchyScope", type = "HierarchyScopeType" minOccurs = "0"/> to align with updated Part 2 best practice to apply Hierarchy Scope to 1st class objects, this addition was added and comment submitted to ISA-95 for consideration.

I didn't find supporting document for adding HierarchyScopeType to Node, it makes more sense to describe hierarchy scope in workflow spec.

@CharlieG021163 is proposing a change to ISA95.
It can be used to filter out the qualified nodes for a workflow.

@racheliurui
Copy link
Collaborator Author

racheliurui commented Sep 9, 2019

ADD
element name = "Property", type = "WorkflowSpecificationPropertyType" TO
"WorkflowSpecifictionNodeTypeProperty", type = "WorkflowSpecificationNodeTypePropertyType"

ISA-950004
6.16.9 Workflow specification node type property

And WorkflowSpecificationNodeTypePropertyType itself is a new Type.

Check the comment of #51.
Disagree with using WorkflowSpecifictionNodeTypeProperty.


A lot of dicussion here,
Corrected my understanding: I thought here the workflow's property and node property is mixed together when nest, it's not.
If a workflow is nested, then acting as a workflowspecnode , it's property is inside the workflowspec tag, and the extended property is outside the workflowspec.
Change this to Agree.

@racheliurui racheliurui added this to the AgreedByWorkingGroup milestone Sep 24, 2019
@CharlieG021163 CharlieG021163 changed the title update WorkflowSpecificationNodeTypeType to align with ISA-950004 Update WorkflowSpecificationNodeTypeType to align with ISA-950004 Sep 26, 2019
@CharlieG021163
Copy link
Collaborator

CharlieG021163 commented Oct 15, 2019

Why was this submitted to MESA without 48 and original comment not completed?
Incorrectly labelled as HIGH. Adjusted to LOW.
Decision: Edit or Delete MESA comment.

@vitalJP
Copy link
Collaborator

vitalJP commented Oct 16, 2019

The issue has been closed from the MESA repository.

@CharlieG021163
Copy link
Collaborator

The Change to add Hierarchy Scope to 950004 approved by ISA-95 and JWG5 Committee at Oct 2019 Meeting. Submit Issue to MESA.

@CharlieG021163 CharlieG021163 added Medium and removed Low labels Nov 4, 2019
@CharlieG021163 CharlieG021163 changed the title Update WorkflowSpecificationNodeTypeType to align with ISA-950004 Update WorkflowSpecificationNodeTypeType to align with updated ISA-950004 Jan 22, 2020
CharlieG021163 added a commit that referenced this issue Jan 30, 2020
Global Element: ADD <xsd:element name = "WorkflowSpecificationNodeType" type = "WorkflowSpecificationNodeTypeType" />
Transaction Elements: ADD: All transaction elements for WorkflowSpecificationNodeType
WorkflowSpecificationNodeTypeType Transaction Types: ADD All transaction types for WorkflowSpecificationNodeTypeType
@Dennis-Brandl
Copy link

I agree with the change.

@gerardmoloneyetpartners
Copy link
Collaborator

@Dennis-Brandl This issue has been agreed here.

It needs to be accepted in to the MESA github (I'm not sure how... by pull request?) and committed in to Version 7.0
If you need a hand with doing this, please give myself and John Kirkman and email to arrange it with you.

@Dennis-Brandl
Copy link

Dennis-Brandl commented Sep 7, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ERDi Issues that need to be fixed in ERDi version Medium MESA Issues that need to be fixed in MISA Version
Projects
None yet
Development

No branches or pull requests

6 participants