Title

CDISC Library data pipeline

Purpose

This Work Instruction describes the steps for deploying CDISC standards metadata to CDISC Library using data pipelines.

Scope

This Work Instruction covers content deployment to CDISC Library's dev and qa environments.

Prerequisites

Indicates if any pre-requisite(s) prior to carrying out this Work Instruction. Put "Not applicable." if this section is not applicable.

Definitions

List terms (abbreviations, acronyms, technical jargon) referenced in this Work Instruction useful at adding clarity. Put "Not applicable." if this section is not applicable.

TermDefinition
OAS3Open API Specification Version 3. https://www.openapis.org/


Roles & Responsibilities

Lists all roles and their responsibilities relevant to this Work Instruction.

RoleResponsibilities
CDISC Library API ArchitectDesign and maintain API specification.
CDISC Library Software DeveloperCreate programming code to Implement software.


Instructions

Describe each step to be taken to complete the scope of this Work Instruction in the prescribed sequence. Use active verb in the Instructions column.

Step #RoleInstructionsNotes
1.0CDISC Library API ArchitectDesign API specification in OAS3 format in team workspace hosted by Swaggerhub.
1.1CDISC Library API ArchitectInform CDISC Library Software Developer when API specification is ready for implementation.
2.0CDISC Library Software DeveloperImplement API endpoints based on the API specification.
2.1CDISC Library Software DeveloperMake update suggestions where applicable.
3.0CDISC Library Software DeveloperDeploy software code to the development environment.
1.0Standards Development Project ManagerInforms Metadata Analyst a CDISC standard is ready for loading into CDISC Library.
2.0Metadata AnalystInspects standard's high-level metadata, where applicable.SDTMIG's Content Control wiki is an example.
2.1Metadata AnalystDocuments unique characteristics and specifics about this CDISC standard to a DevOps wiki.A DevOps wiki includes, but not limited to source metadata location, changes to predecessor, exception handling, etc.
3.0Metadata AnalystInforms CDISC Library Software Developer to execute the data pipeline.
3.1Metadata AnalystInforms Data Science Leadership a new data pipeline is required for novel CDISC contents.
4.0CDISC Library Software DeveloperCollects run parameters from Metadata Analyst or DevOps wiki that are required to execute the data pipeline.
5.0CDISC Library Software DeveloperInspects program log.
5.1CDISC Library Software DeveloperCommunicates errors and warnings in program log with Metadata Analyst.
5.2Metadata AnalystDetermines action plan with the Standards Development Project Manager.Repeats from 1.0 until all relevant issues are remediated and/or documented.
6.0Metadata AnalystInforms CDISC Library Software Developer metadata is ready to be loaded into the CDISC Library's dev environment.
7.0CDISC Library Software DeveloperUploads metadata content to the project repository in DevOps.
7.1Metadata AnalystPerforms metadata review using tools include, but not limited to Data Standards Browser and Diff report.
7.2Metadata AnalystCommunicates review observations with CDISC Library Software Developer.
7.3CDISC Library Software DeveloperAdjusts data pipeline programming code and re-runs data pipeline.

Repeats from 7.0 until all relevant issues are remediated and/or documented.

For changes outside of data pipeline, refer to Software Development Work Instruction.

8.0Metadata AnalystInforms CDISC Library Software Developer metadata is ready to be loaded into the CDISC Library's qa environment.
8.1CDISC Library Software DeveloperPromotes metadata content to the qa environment.

General Workflow

Include a general workflow diagram that summarizes this Work Instruction.

Diagram to be inserted.

References

List references pertinent to this Work Instruction, e.g., COP-001.

  • No labels