(web) service revision - new annotations

[lzehl]

At the moment all informative annotations around the function of a web service are not structured. We assumed so far that this will be delivered through the connected software. I would suggest to make those specific for the service.

SUGGESTIONS (that came up in the EBRAINS service working group):

1. Annotation about the role of a service for a system:

• property name: "systemicRole"
• expected value: 1, linked object (SystemicRoleOfService; new controlledTerms library)
• SystemicRoleOfService terms:
  • "operations": Any service that ensures the overall functionality of a system.
  • "core": Any service that provides key representative functions of a system.
  • "complementary": Any service that provides additional valued functions for a system.

2. Annotation about the overall innovation category:

• property name: "innovationCategory"
• expected value: 1-N (?), linked object (InnovationClass; new controlledTerms library)
• InnovationCategory:
  • "non-science innovation": "Any innovation driven by non-scientific principles, not reliant on scientific research or methodologies, though it may address scientific problems or solutions."
  • "science innovation": "Any innovation grounded in scientific research and methods, aimed at advancing scientific knowledge, solving scientific problems, or creating new scientific solutions."

3. Annotation about the type or function of the service:

• property name: "type" OR "function" OR "functional capability"?? maybe more grouped in category?

• expected value: 1-N (?), linked object (XTBDX; new controlledTerms library)

• XTBDX (schema name to be defined):

  • management categories

    • data management: Ensures the efficient storage, organization, and governance of data, keeping data accessible and secure.
    • metadata management: Ensures the efficient storage, organization, and governance of metadata, keeping data assets findable, accessible, interoperable, and reusable.
    • access management: Ensures appropriate permissions are granted and monitored for authenticated and/or authorized users, keeping digital or physical resources secure.
    • project management: Ensures the planning, coordination, and execution of projects, keeping tasks, resources, and timelines aligned with goals and within scope.
    • identity management: Ensures proper authentication and authorization, keeping user identities secure and controlling access to digital or physical resources.
    • resource management: Ensures the optimal allocation and utilization of digital and/or physical resources, keeping them efficiently managed and maximized.
    • workflow management: Ensures the design, automation, and monitoring of workflows, keeping processes efficient, consistent, and completed within set timelines.
    • configuration management: Ensures consistency across digital and/or physical resource components, keeping configurations aligned with operational standards through version control and proper setup.
    • change management: Ensures the controlled implementation of modifications to digital and/or physical resources, keeping disruptions minimal and facilitating smooth adoption.
    • performance management: Ensures the monitoring and improvement of digital and/or physical resources, keeping operations aligned with goals for maximum efficiency and effectiveness.
    • incident management: Ensures the identification, response, and resolution of incidents, keeping disruptions to digital and/or physical resources minimal and restoring normal operations swiftly.
    • risk management: Ensures the identification, assessment, and mitigation of risks, keeping potential negative impacts on digital and/or physical resources under control.
    • compliance management: Ensures adherence to legal, regulatory, and internal standards, keeping digital and/or physical resources in compliance with necessary requirements.
    • quality management: Ensures that digital and/or physical resources meet established quality standards, keeping continuous improvement as a central focus to enhance outcomes.
    • financial management: Ensures the planning, monitoring, and control of financial resources, keeping budgets and expenses aligned with organizational goals and strategies.

  • monitoring

    • performance monitoring
    • usage monitoring

  • security

    • authentication
    • authorization
    • encryption

  • "computation"

    • "analysis"
    • "simulation"
    • "visualization"
    • "validation"
    • "inference"
    • "modeling"
    • "optimization/training"
    • "prediction"

  • "collaboration"

    • "editing"
      • "real time editing"
      • "asynchronous editing"
    • "communication"
      • "real time communication"
      • "asynchronous communication"

  • "data deposit"

    • digital vs physical storage
    • "storage availability"
      • "online storage" (fast, frequently accessed data with small or medium size)
      • "nearline storage" (medium speed, medium accessed data of any size)
      • "archival storage" (slow, rarely accessed data of any size)
    • "storage architecture"
      • "object storage"
      • "block storage"
      • "file storage"

  • "deployment"

  • "support"

  • "provenance"

  • "version control"

  • "neuromorphic computing"

  • "hardware access"

  • "publishing"

    • "interactive publications" (e.g. live papers?)
    • "static publications"

  • "registry"

  • "acquisition" (may need further sub-elements?) (would in principle match the collection of software functions associated with a service)

4. Annotation about the interfaces of a service:

• property name: "user interface"
• expected value: 1-N (?), linked object (InterfaceType; new controlledTerms library)
• UserInterface:
  • "application programming interface"
  • "command line interface"
  • "graphical user interface"

[lzehl]

@elenimath we can use this issue for further discussion on service types. Feel free to pin who you think should be involved here.

[lzehl]

@openMetadataInitiative/openminds-developers these annotations should be discussed. If we agree on them we can start triggering the respective updates in WebService and Software.

[apdavison]

On "systemicRole":

If this is an "Annotation about the role of a service for a system", then its value depends on both the service and the system (e.g., a given service could be "core" for EBRAINS but "complementary" for some other platform or infrastructure). It cannot therefore be a property of the service; we would need a separate schema, perhaps an embedded schema attached to a property of the infrastructure/platform instance (cf #539).

[apdavison]

On "type" OR "function" OR "functional capability":

There is considerable overlap with SoftwareFeature and SoftwareApplicationCategory

[apdavison]

For point 4:

schema - https://github.com/openMetadataInitiative/openMINDS_controlledTerms/pull/505 instances - https://github.com/openMetadataInitiative/openMINDS_instances/pull/369

[lzehl]

On "type" OR "function" OR "functional capability":

There is considerable overlap with SoftwareFeature and SoftwareApplicationCategory

@apdavison I started revising them for discussion here: https://github.com/openMetadataInitiative/openMINDS_instances/issues/389