1. Avoiding Redundancy in the Management of Technical Documentation and Models: Requirements Analysis and Prototypical Implementation for Enterprise Architecture Management
September 19th
Peter Velten – Master’s Thesis – Final Presentation

2. Agenda 1 Motivation and Objective 2 2 Requirements Analyses 7 3
Concept 11 4
Live Demo 19 5
Evaluation 20 6
Outlook 24
Peter Velten
© sebis

3. 1. Motivation - Documentation in Enterprises
Reports
Lorem ipsum dolor sit amet, consectetur adipiscing elit
Specifications
Lorem ipsum dolor sit amet,
ipsum dolor sit amet ipsum dolor sit amet
Policies
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec malesuada auctor nisl, eu vehicula odio elementum sit amet. Proin pellentesque vulputate sapien,
Proper data basis granted
Conenctration of creation of documents
Reports -> support decision making
Regulatory reasons
Protocols
Lorem ipsum dolor sit amet, consectetur
Peter Velten
© sebis

4. 1. Motivation - Documentation in Enterprises
Reports
Lorem ipsum dolor sit amet, consectetur adipiscing elit
Present Problems
Specifications
Lorem ipsum dolor sit amet,
ipsum dolor sit amet ipsum dolor sit amet
Redundancy leads to
Inconsistencies
Formatting issues
No proper repository
Manually processing
Maintenance
Policies
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec malesuada auctor nisl, eu vehicula odio elementum sit amet. Proin pellentesque vulputate sapien,
Redundancies be reusing same components in different documents -> changing provokes inconsistencies -> error-prone
Formatting issues: Problems with exporting to desktop-based formats (ppt and doc). Text is screwed, visualization not in right format and dimensions
E.g Exporting entity from SocioCortex to pdf for archiving reasons
Repository to derive meta data -> how many documents? Which applications are specified? Which policies are missing?
Because of these problems and no parent solutions -> often created manually (copy and past), using templates,
Not consistent in form and content
Protocols
Lorem ipsum dolor sit amet, consectetur
Peter Velten
© sebis

5. 1. Motivation - Problem Statement
Maintenance of redundant information. Output and input of this information is laborious and error-prone.
Reports often created manually due to lack of technology. (e.g. using Word-templates). This is error-prone and cost-intensive. In addition immutability may be desired.
Existing solutions lacking in critical functionality, such as a suitable (graphical) output.
Demand in Enterprises for consistent and redundancy-free reporting and documentation tools
Peter Velten
© sebis

6. “ ” 1. Research Objectives
Avoiding Redundancy in the Management of Technical Documentation and Models: Requirements Analysis and Prototypical Implementation for Enterprise Architecture Management ”
Inquiry and analysis of concrete requirements from industrial partners to a reporting tool
Abstraction of the requirements and conception of a general-purpose solution
Prototypical implementation of the solution approach with subsequent evaluation
Peter Velten
© sebis

7. 2. Requirements Analysis1
Motivation and Objective 2 2
Requirements Analysis 7 3
Concept 11 4
Live Demo 19 5
Evaluation 20 6
Outlook 24
Peter Velten
© sebis

8. 2. Requirements Analysis - Approach
Enterprise 1
Enterprise 1
Specific Require-ments
Specific BusinessCase
General
Require-ments
General
Solution … …
Enterprise n
Enterprise n
Specific Require-ments
Specific BusinessCase
Peter Velten
© sebis

9. 2. Requirements Analysis - Specific RequirementsID
Requirement
R-1
Inclusion of simple parameters
R-2
Inclusion of lists
R-3
Combine text-parts to comprehensive documents
R-4
Support for PDF
R-5
Support for Office-formats …
R-24
Serial generation of reports
Peter Velten
© sebis

10. 2. Requirements Analysis - General Requirements
Priority
Reuse of sub-components
High
Usage of parameters and types
Interface to present data sources
Integration of formatting functions
Serial generation of documents
Medium
Integration of different file formats
Publishing workflow
Low
Document versioning mechanism
Integration of visualizations
Peter Velten
© sebis

11. 3. Concept 1 Motivation and Objective 2 2 Requirements Analysis 7 311 4
Live Demo 19 5
Evaluation 20 6
Outlook 24
Peter Velten
© sebis

12. 3. Concept - Procedure Template Generation Configuration Generation
Report
Generation
3-Step procedure to finally create the required document
Goal: Usage of desktop-based tools in combination with the reporting tool to avoid problem areas
Every step corresponds to a task in the application
Goal: Formatting functionality available.
Microsoft Office
-Meta data reports -
SocioCortex as repository: Each step creates an entity within SocioCortex
Template and Configuration is only done once. End user only creates final Report
Peter Velten
© sebis

13. 3. Concept - Procedure Template Generation Configuration Generation
Report
Generation
Template as basis for further steps
Creation of a template-file within desktop-tools of Microsoft Office (.docx / .pptx)
Define parameters as placeholders instead of concrete content from SocioCortex
Velocity as template-language allows further functionalities like conditions and loops
Template-file gets uploaded within the application for further processing
Peter Velten
© sebis

14. 3. Concept - Procedure Template Generation Configuration Generation
Report
Generation
A configuration is based on a created template
Define MxL-queries for each parameters from the template
Queries are only validated, but not executed
Multiple Configurations for one Template
Example: Template for technical documentations of applications. One Configuration of strategic applications, another for operational applications
Peter Velten
© sebis

15. 3. Concept - Procedure Template Generation Configuration Generation
Report
Generation
Execution of MxL-queries
Replace parameters with retrieved results and provide final documents to end-user
Report always created with up-to-date data
Conversion from .docx to .pdf
Multiple Reports for one Configuration
Peter Velten
© sebis

16. 3. Concept - Interaction of Components
Server-side
Client-side
SocioCortex
Create Template
Get Parameters
Return Parameters
Create Configuration
Validate MxL-Queries
Create Report
Execute MxL-Queries
Return Results
Exchange Parameters
Final Report-file
Peter Velten
© sebis

17. 3. Concept - Interaction of Components
Server-side
Client-side
SocioCortex
Create Template
Get Parameters
Return Parameters
Create Configuration
Validate MxL-Queries
Create Report
Execute MxL-Queries
Return Results
Exchange Parameters
Final Report-file
Peter Velten
© sebis

18. 3. Concept - Interaction of Components
Server-side
Client-side
SocioCortex
Create Template
Get Parameters
Return Parameters
Create Configuration
Validate MxL-Queries
Create Report
Execute MxL-Queries
Return Results
Exchange Parameters
Final Report-file
Peter Velten
© sebis

19. 4. Live Demo 1 Motivation and Objective 2 2 Requirements Analysis 7 3
Concept 11 4
Live Demo 19 5
Evaluation 20 6
Outlook 24
Peter Velten
© sebis

20. 4. Evaluation 1 Motivation and Objective 2 2 Requirements Analysis 7 3
Concept 11 4
Live Demo 19 5
Evaluation 20 6
Outlook 24
Peter Velten
© sebis

21. 4. Evaluation: Scenario-based Approach
Creation of a management report by highlighting crucial applications and their relationships with each other
Creation of technical documentations for each available application in the system
Evaluation by demonstrating the scenarios to 2 interested companies
Assessment of each requirement by discussion on the basis of a questionnaire
Additional quantified assessment (scala of 1 to 5)
Peter Velten
© sebis

22. 4. Evaluation - Quantified
Reuse of sub-components
Usage of parameters and types
Interface to present data sources
Integration of formatting functions
Serial generation of documents
Integration of different file formats
Publishing workflow
Document versioning mechanism
Integration of visualizations
3.5 5 4 3 5 4 1
3.5 1
Peter Velten
© sebis

23. 4. Evaluation - Key Points of Criticism
Enhancement of versioning-mechanism
Version-numbers of documents
Usage of SocioCortex versioning-mechanism
Support for additional file-formats (especially Excel)
Support of visualizations
Creation of more sophisticated templates
Attachment of created documents to concrete entities
Implementation of a publishing workflow
Still different aspects are missing for productive application
Overall the prototype and the approach was considered
as very well and expedient
Peter Velten
© sebis

24. 4. Outlook 1 Motivation and Objective 2 2 Requirements Analysis 7 3
Concept 11 4
Live Demo 19 5
Evaluation 20 6
Outlook 24
Peter Velten
© sebis

25. 4. Outlook Fulfillment of all requirements Visualizations
Publishing workflow
More elaborated integration within SocioCortex
Append templates to entityTypes (“Stylesheet”)
Distribute the documents to the entities
(User will always access up-to-date version)
Usage of SC-Visualizer
The prototype laid the foundation for further developments to prevent
the problems of present EA Documentation
Integration within SocioCortex would enhance the powerfulness
of the system and increase the usability of the end-user
Peter Velten
© sebis

26. Thank you for your attention! Do you have any questions or comments?
Peter Velten
© sebis