Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Milestones

Typical Activities

Deliverables

Status

Scoping

Identify use cases that may use services in domain addressed by this BB in its workflow. Define journey within these use-cases with episodic serial logical steps that groups activities that happen in parallel.

Logical process blueprint describing use-case journey with episodic steps

Completed v1
(April 2022)

Map activities within a logical process step (episode) and identify activities which are handled by specific BBs. Create list of BB microservices needed in each episode.

Logical process blueprint updated with list of BB microservices needed with priority(current/future scope/  needed but from  other BBs)

Completed v1
(May 2022)

Describe Scenarios of service calls

Define unique scenarios in which each microservice may be consumed with different inputs and outputs

BB Use-Case Scenarios defined for all prioritized BB microservices

Completed v1
(May 2022)

For each unique scenario, describe the preconditions, assumptions, actors, data inputs, normal and alternate internal workflows, outputs and post conditions, exceptions, dependency on other BBs (egress calls from this BB) expected to deliver the requested service.

Use-case scenario definition and link updated in relevant  BB specification docs

Completed v1
(June 2022)

Defining Key digital Functionalities (KDF) 

Identify key functionalities needed within each BBs in order to provide a specific microservice.

KDF updated in relevant BB specification docs

Completed v1
(April 2022)

Define assumption and prerequisites to use each  functionality

Functional requirement section of respective BB specification documents updated in BB definition document with relevant references to standard practices / features  Enumerate candidate  s/w products that might satisfy some of the functional requirements

Completed v1
(May 2022)

Identify common internal functional blocks that may be required to orchestrate all KDS of the BB

Completed v1
(May 2022)

Layout internal functional blocks and workflow along with block diagrams, flowchart, etc. for each KDF

Completed v1
(May 2022)

Defining Data Structures

Identify data elements, groups and schema needed by functional blocks to orchestrate services of this BB in a MVP footprint

Resource model defined in BB specifications with references to relevant standards

Cross cutting requirements

Describe Completed v1
(June 2022)

Cross cutting requirements

Describe security and architectural deviations if any needed in this BB that is in addition to or exclusion of those defined in Govstack Security and Architecture specification documents

Define deviations with justification and populate links to other compliant sections of BB security and Architecture guidelines

Completed v1
(May 2022)

Key decisions

Comprehensively Log any key decisions taken either internally or due to external feedback from reviews along with references and justifications

Updated key decisions log in bb specification

Completed v1
(June 2022)

Terminology

Identify and describe new terms if any, used in the BB specifications for this BB

Terminology document with links inserted in Glossary of BB specification

Completed v1
(May 2022)

TAC Review

Finalized BB definition template submitted and presented for review by Tech-advisory group review

BB Spec presentation PPTS, draft documents signed off by BB leads

Completed v1
(May 2022)

TAC feedbacks collection and assessment, discuss recommendations leading to corrections/pun into future or out of scope bins

Current specs updated with changes or posting for future scope / not in scope signed off by BB leads

Completed v1
(June 2022)

Functional specification Publication

Clean up presentation for typos, consistency, clarity and reader friendly presentation.

BB specifications verified for accuracy and signed off by BB leads

Completed v1
(August 2022)

Specification with appropriate versioning details published on Govstack and other sites

BB documents hosted publicly and Govstack Website links updated accordingly

Completed v1
(October 2022)

Open API Interface Definition

Define interaction with external applications/BBs specified in workflow during ingress and egress service calls of this building block

Interaction protocol flowcharts with associated data fields defined in English into BB definition document with references to relevant standards

Completed v1
(August 2022)

Open API specification of service calls and return formats for success/error/exception conditions

Swagger OPENAPI V3.0+ service APIs

Completed v1
(October 2022)

BB API compliance Tests

Define Rest-Api according to service request-response protocols and data structure from BB specs

APIs in Open-API V3.0 Yaml/JSON format

Completed v1
(November 2022)

For each API write test requirements in English including all associated API calls (both ingress and egress requests)

Set of test cases with expected requests and responses for service calls landing on the BB and calls emanating from this BB to other BBs

In progress v1
(December 2022)

Develop stubs with mock requestor-responder code or API adapter (if BB code exists) to cover set of test cases

Dockerized Stubs with mock requestor-responders / BB Adapters

In progress v1
(December 2022)

Launch Mocks with Stubs and run test cases between requestor and responder stub endpoints

APIs qualified for compliance with BB specs

In progress v1
(December 2022)

BB API Integration Tests

Add IM interface into Mock requestor/responder code

BB APIs mock/adapter codes upgraded with IM interface and protocols

Integrate with information mediator

BB Apis adopted into IM (service discovery and access)

Run same test cases with IM in between the requestor and responder stubs

BB service integration qualified to work with same requests coming through IM

BB API Interoperability Tests

Replace requestor stubs with other IM integrated BBs (stubs/adaptors)

BB configured to access APIs of other BBs on Govstack as well as receive service requests through info med

Run interoperability tests with other BBs that are integrated as consumers / service providers for the BB under test

BB APIs qualified to interoperate with APIs of other integrated BBs (both ingress and egress)

API Publication

Document qualified APIs and associated test case definitions as part of BB specifications

Published Open API interface specifications

User journey integration

Integrate Qualified APIs into Sandbox

Sandbox updated with qualified BB APIs

Develop cross-building block workflows at backend and application front end according to logical process flow

Application frontend (screen flow) and backend(workflow) developed according to logical process blueprint

Conduct tests of logical process flow

Test automation scripts and mock applications, test results

Create automated demo presentations

Hosting of qualified demos

...