canada-ca / architecture Goto Github PK

Place holder to quickly upload Wiki Images
Dont enter real issues into this ticket :)

User Story

As a Canada-ca/architecture contributor
I want a cross walk between GC policy instruments and Archimate artifacts
So that I can effectively decompose GC Elements into Archimate elements

Work to date:

This is an ongoing attempt to create such a crosswalk for my own architectures, however it has not been vetted or validated by the community.
MappingTogafArchimate2GovernmentOfCanada Comments are welcome, or ask to contribute

User Story

As a GC EA Architect
I want to generate EA artifacts automatically from authoritative sources
So that EA components can be automatically generated, and updated instead of each EA Architect needing to re-model these components

EA Artifact Sources

• Web Sources

  • Parliamentary Bills: All Bills for the Current Session (42nd Parliament, 1st Session)
  • Laws and Legislation: eg Security of Information Act
  • Regulations: eg Grosse Isle, P.Q., Prohibited Place Order
  • Codes: Values and Ethics Code for the Public Sector
  • Policy Frameworks: eg Policy Framework for Information and Technology
  • Policies: Eg Policy on Management of Information Technology
  • Directives: eg Directive on Management of Information Technology
  • standards: eg Standard on Web Interoperability
  • Guidelines: Eg Guideline on Service Management
  • Tools: Related policies, directives, standards, guidelines, etc.

• Open Data Sources:

  • Departments:
    • List of legal department names and their respective numbers
  • Legislation:
    • List of Acts and Regulations
    • Consolidated Acts and regulations in XML
    • Consolidated federal Acts and regulations - Bulk XML file
  • policies:
    • All policies are linked together by way of an HTML encoded policy hierarchy

Background

*It should be possible to generate a new baseline GC EA architecture at the business and motivation level on a daily basis. This is one proposal how

• Each law has a HTML representation (eg https://laws-lois.justice.gc.ca/eng/acts/C-15.31/)
• For each law with an HTML representation there is a machine readable XML version (eg. https://laws-lois.justice.gc.ca/eng/XML/C-15.31.xml)
• XSLT is a transformation language to convert XML into various others forms including other XML formats. (https://www.w3schools.com/xml/xsl_intro.asp)
• Archimate is an openly documented modeling language specification
• The Archimate Model Exchange File Format is an XML representation of an archimate model
• software compliant to the Archimate exchange format can import and export Archimate exchange files
• Archi is an example of such an open source compliant tool
• Archi has a collaboration extension that allows architects to use Git as a version controlled EA repository Repository to manage EA elements
• canada-ca/architecture repository leverages GitHub as an example of a public implementation of Git
• GCCode Internal Link is an internal Git repository that uses [GitLab Community Edition]( as the interface
• The Archimate collaboration plugin converts each EA object into a mini Archimate Model Exchange file format. For example this is what a Requirement Element in the canada-ca/architecture model looks like:

<archimate:Requirement
    xmlns:archimate="http://www.archimatetool.com/archimate"
    name="C.2.3.3.2"
    id="02ff40fd-da1f-4970-955a-4937850196a8"
documentation="Make an audit trail available for all transactions to ensure accountability and non repudiation"/>

• converting various EA elements from their native XML representation (eg policies and laws) to the archimate exchange format can aid with easily updating EA elements
• These processes, if automated can run regularly (eg daily)

Therefore, it should be possible to generate a new baseline GC EA architecture at the business and motivation level on a daily basis.

Initial Implementation Details

• Start with Values and Ethics Code for the Public Sector and then work down each level of the hierarchy
• Test with a small sample of elements
• Use Python as a human friendly scripting language that has a lower barrier to entry to handle the management of the creation of these elements
• Develop an XSLT transformation for the EA elements
• Run the transfomation
• Create separate elements that can be added to the canada-ca/architecture repository
• Create a single Archimate exchange file containing ALL the elements for easy import outside of the canada-ca/architecture repository

Future upgrades

• add relationships to linked elements within a "policy"
  • "Related Laws"
  • "Supporting Tools"
  • "More information"
  • "Hierarchy"
• break large elements (eg a policy) into smaller components (eg sections and sub-sections)
• provide XSLT transformations to the managers of the web locations and assets so that canada.ca can provide native XML as well as Archimate compliant XML representations of all of GC EA elements

Future work

• Create a plugin for Archi that can Create, Read, Update, Delete elements in a model based on various "Policy" sources (as listed above)
  • [ ]scan internet sources
  • search for changes,
  • read sources,
  • transform from native formats to archimate,
  • import one or more elements into the model,
  • update the model,

User Story

As a canada-ca/architecture contributor
I want a method to extract select architectural elements from this repository
So that I can use individual or groups of architectural elements in my own architectures.

Implementation details

Currently you can start a project and import a full archimate model and then remove the elements you don't want but this approach is a little cumbersome.

Related issues:

Archi Tool [Feature] Allow the copy/past, move, import/export of specific elements between models

User Story:
As a contributing architect to canada-ca/architecture
I want a scalable model for contributing architectural models to canada-ca/architecture
So that it is clear when different git workflows apply (eg branches vs forks)

As a gc architect
I want a gc da level project board
So that I can coordinate tasks with others and be made aware what status is for a group of issues

Details
https://help.github.com/en/articles/about-project-boards

As per:
https://help.github.com/en/articles/creating-issue-templates-for-your-repository

Creating issue templates for your repository
When you create issue templates for your repository using the issue template builder, they'll be available for contributors to use when they open new issues in the repository.

Suggested templates:
User Story Template Example

## User Story:
(Please describe the task or feature you are requesting)

As a <User Role>
I want <Describe Feature>
So that <Describe Goal>

## Implementation Details:
(Please include any additional details required to describe this issue)
* .
* .

## Related Issues
(Please include links to other related issues by using the #number auto link syntax)
* .

## Service Desk Issues
( Please include any links to existing service desk issues related to this issue)
* [Issue Name](http://link.to.issue)


## Business Value:
(Please select a single business value based on the MoSCoW model. Deafult: Must Have)
* [x] Must Have
* [ ] Should Have
* [ ] Could Have
* [ ] Would Like to Have

## User Story Points (Effort)
( Please estimate the number of User Story points you this this issue deserves. Default: 10)
* [ ] Unknown
* [ ] 0
* [ ] 1
* [ ] 2
* [ ] 3
* [ ] 5
* [ ] 8
* [x] 10
* [ ] 15
* [ ] 25
* [ ] 50
* [ ] 100
* [ ] Infinity

As a contributor to canada-ca/architecture repository
I want a style guide to follow to help guide how objects are captured
So that my efforts as a contributor can derive the greatest value.