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

Feature request: addition of "Label" field to objects containing a "Description" field #92

Open
ArnoClaeys opened this issue Jan 30, 2024 · 0 comments

Comments

@ArnoClaeys
Copy link
Contributor

In ISA-95, each object has an identifier field ("ID"), defined as "A unique identification within the scope of the information exchanged.". The Core Component Technical Specification (CCTS) defines an IdentifierType as "A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme.".

Some examples of IDs given in the ISA-95 specification are listed per "scope" below:

  • Personnel: "Employee 23", "Widget assembly operator" "Class 1 Certified", "Class 1 Widget Assembly Certification Test", "T5568700827"
  • Equipment: "Jig 347", "WJ6672892", "Run Rate", "WAJTT-101", "FQ101/01-10-2000"
  • Material: "Polymer sheet stock 1001A", "Sheet stock 1443a", "L66738-99"

We discussed using the ID field in various research projects with technology providers. For type objects, a functional name can be utilized as an identifier as long as it is unique (e.g., PersonnelClass "Operator", MaterialClass "Fastener"). However, from a technical point of view, there may be some restrictions (e.g., only alphanumeric or "_"). A data repository will mainly contain instance objects. Here, each object should be uniquely identifiable for accurate information retrieval. In this case, global unique identifiers (GUIDs) are typically used.

Due to the criteria to define unique and unambiguous identifiers, these identifiers are often not human-friendly.
In ISA-95, a description field is provided. However, a description mainly gives additional information and explanations about the object (in addition to a human-friendly label). Therefore, we request that all objects be extended with a (multilingual) label field ("Label") to represent objects in a human-friendly way. Below, an example of the usage of a label field is illustrated.

If there is agreement upon this request, I can create a pull request to add the Label elements to the relevant objects (fork).

<?xml version="1.0" encoding="utf-16"?>
<WorkMaster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.mesa.org/xml/B2MML">
  <ID>c19448d0-0e9c-463c-90eb-e7f7e6203866</ID>
  <Label languageID="en">Example task</Label>
  <Label languageID="nl">Voorbeeld taak</Label>
  <Description languageID="en">Example task for illustrating the use of the Label field</Description>
  <Description languageID="nl">Voorbeeld taak om het gebruik van het Label veld te illustreren </Description>
  <WorkflowSpecification>
    <ID>6f0db0f4-0aa7-419b-8fec-3dc4ac85c92d</ID>
    <Label languageID="en">Example workflow</Label>
    <Label languageID="nl">Voorbeeld workflow</Label>
    <Description languageID="en">Example workflow for illustrating the use of the Label field</Description>
    <Description languageID="nl">Voorbeeld workflow om het gebruik van het Label veld te illustreren </Description>
    <WorkflowSpecificationNode>
      <ID>b89f087c-0d49-49ea-b5fd-f710c9ee888e</ID>
      <Label languageID="en">Start</Label>
      <Label languageID="nl">Start</Label>
      <Description languageID="en">Workflow start node</Description>
      <Description languageID="nl">Workflow start node</Description>
      <WorkflowSpecificationNodeTypeID>StartNode</WorkflowSpecificationNodeTypeID>
    </WorkflowSpecificationNode>
    <WorkflowSpecificationNode>
      <ID>2f01fa91-95f7-476e-b2e1-672a1a6b2669</ID>
      <Label languageID="en">Step 1</Label>
      <Label languageID="nl">Stap 1</Label>
      <Description languageID="en">Description of what should be done in step 1</Description>
      <Description languageID="nl">Beschrijving van wat er moet gebeuren in stap 1</Description>
      <WorkflowSpecificationNodeTypeID>Step</WorkflowSpecificationNodeTypeID>
    </WorkflowSpecificationNode>
    <WorkflowSpecificationNode>
      <ID>b669d67a-9e10-41bf-ab3a-6c0de3ceff3e</ID>
      <Label languageID="en">Step 2</Label>
      <Label languageID="nl">Stap 2</Label>
      <Description languageID="en">Description of what should be done in step 2</Description>
      <Description languageID="nl">Beschrijving van wat er moet gebeuren in stap 2</Description>
      <WorkflowSpecificationNodeTypeID>Step</WorkflowSpecificationNodeTypeID>
    </WorkflowSpecificationNode>
    <WorkflowSpecificationNode>
      <ID>f1dc8041-de6e-4855-8853-4edd2dd277b1</ID>
      <Label languageID="en">Step 3</Label>
      <Label languageID="nl">Stap 3</Label>
      <Description languageID="en">Description of what should be done in step 3</Description>
      <Description languageID="nl">Beschrijving van wat er moet gebeuren in stap 3</Description>
      <WorkflowSpecificationNodeTypeID>Step</WorkflowSpecificationNodeTypeID>
    </WorkflowSpecificationNode>
    <WorkflowSpecificationNode>
      <ID>9e51bbb8-de3e-4f59-a213-aa8a53232ded</ID>
      <Label languageID="en">End</Label>
      <Label languageID="nl">Einde</Label>
      <Description languageID="en">Workflow end node</Description>
      <Description languageID="nl">Workflow eind node</Description>
      <WorkflowSpecificationNodeTypeID>EndNode</WorkflowSpecificationNodeTypeID>
    </WorkflowSpecificationNode>
    <WorkflowSpecificationConnection>
      <ID>76a9fbce-f0b7-4cdd-97d2-559143b7e390</ID>
      <Label languageID="en">Start to step 1</Label>
      <Label languageID="nl">Start naar stap 1</Label>
      <Description languageID="en">Connection from start to step 1</Description>
      <Description languageID="nl">Verbinding van start naar stap 1</Description>
      <WorkflowSpecificationConnectionTypeID>SequenceFlow</WorkflowSpecificationConnectionTypeID>
      <FromWSNodeID>b89f087c-0d49-49ea-b5fd-f710c9ee888e</FromWSNodeID>
      <ToWSNodeID>2f01fa91-95f7-476e-b2e1-672a1a6b2669</ToWSNodeID>
      <Dependency>AfterEnd</Dependency>
    </WorkflowSpecificationConnection>
    <WorkflowSpecificationConnection>
      <ID>6cc5ce9e-9998-46d3-b039-acbaf1b824d1</ID>
      <Label languageID="en">Step 1 to step 2</Label>
      <Label languageID="nl">Stap 1 naar stap 2</Label>
      <Description languageID="en">Connection from step 1 to step 2</Description>
      <Description languageID="nl">Verbinding van stap 1 naar stap 2</Description>
      <WorkflowSpecificationConnectionTypeID>SequenceFlow</WorkflowSpecificationConnectionTypeID>
      <FromWSNodeID>2f01fa91-95f7-476e-b2e1-672a1a6b2669</FromWSNodeID>
      <ToWSNodeID>b669d67a-9e10-41bf-ab3a-6c0de3ceff3e</ToWSNodeID>
      <Dependency>AfterEnd</Dependency>
    </WorkflowSpecificationConnection>
    <WorkflowSpecificationConnection>
      <ID>4881fc3b-fe76-471c-9840-eee1e99a1c10</ID>
      <Label languageID="en">Step 2 to step 3</Label>
      <Label languageID="nl">Stap 2 naar stap 3</Label>
      <Description languageID="en">Connection from step 2 to step 3</Description>
      <Description languageID="nl">Verbinding van stap 2 naar stap 3</Description>
      <WorkflowSpecificationConnectionTypeID>SequenceFlow</WorkflowSpecificationConnectionTypeID>
      <FromWSNodeID>b669d67a-9e10-41bf-ab3a-6c0de3ceff3e</FromWSNodeID>
      <ToWSNodeID>f1dc8041-de6e-4855-8853-4edd2dd277b1</ToWSNodeID>
      <Dependency>AfterEnd</Dependency>
    </WorkflowSpecificationConnection>
    <WorkflowSpecificationConnection>
      <ID>688ae370-6f71-4b65-9f89-89f2dbad48ec</ID>
      <Label languageID="en">Step 3 to end</Label>
      <Label languageID="nl">Stap 3 naar einde</Label>
      <Description languageID="en">Connection from step 3 to end</Description>
      <Description languageID="nl">Verbinding van stap 3 naar einde</Description>
      <WorkflowSpecificationConnectionTypeID>SequenceFlow</WorkflowSpecificationConnectionTypeID>
      <FromWSNodeID>f1dc8041-de6e-4855-8853-4edd2dd277b1</FromWSNodeID>
      <ToWSNodeID>9e51bbb8-de3e-4f59-a213-aa8a53232ded</ToWSNodeID>
      <Dependency>AfterEnd</Dependency>
    </WorkflowSpecificationConnection>
  </WorkflowSpecification>
</WorkMaster>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant