[Enterprise Architect] #15. Documentation & HTML

Hello, this is Danappa, a system engineer.

In this post, we will briefly look at the function to output models designed in Enterprise Architect (EA) in PDF, Word file, and HTML format.

1. You can output the document as a PDF or Word file using ‘Publish → Model Reports → Report Builder’. (Or select ‘Documentation → Generate Documentation’ from the hamburger menu button in the Project Browser) When you select this function, the ‘Generate Documentation’ window is activated.

This image shows the Generate Documentation window where you can output the designed model as a document.

2. ‘Generate Documentation’ 창에서, ‘Package’ 란에 설정된 Package 하위의 모든 다이어그램 및 엘리먼트들이 보고서로 생성됩니다.

3. ‘Output to File’ 섹션에서 파일 형식을 RTF, PDF, Docx 중에서 선택할 수 있습니다.

4. 커버 페이지 및 다양한 컨텐츠를 사용자의 요구에 맞게 수정할 수 있습니다.

5. 보고서의 형식과 디자인은 조직마다 다를 수 있으므로, 조직의 요구사항에 맞게 커스터마이즈 할 수 있습니다.

Enterprise Architect (EA)’s HTML report generation feature allows you to output models as HTML files. This feature is very useful when you want to share your project in the form of a web page. The HTML report creation process is as follows:

1. Access the HTML report creation function through the path ‘Publish → Model Reports → HTML → Standard HTML Report’. When you click on the function, the ‘Publish as HTML’ window will be activated.

image 84

2. Select the package to be created in HTML.

3. You can set the report’s Title, Theme, and Header Image at the top of the web page.

4. When you press the ‘Generate’ button, HTML, CSS, and JavaScript files will be created in the selected folder.

5. Click on the created ‘Index.html’ file to see how the web page is structured.

The ‘Save to Image’ feature in Enterprise Architect (EA) is an effective tool that can be used to easily save diagrams as image files or copy them to the clipboard. This feature is useful when you don’t need to output the entire model as a document or HTML, and can be used as follows:

1. You can save the diagram on the canvas as a picture file using the ‘Publish → Save’ ribbon sub-function.

image 85

2. You can select specific elements on the diagram and paste them directly into another document such as Word, PowerPoint, etc. using the ‘Copy & Paste’ (Ctrl+C, V) function.

This feature allows you to save diagrams as images or paste them into other documents directly within EA without using the system capture tool, making the process of writing reports or preparing presentations simpler and more efficient. By actively utilizing the various functions of EA, the results of modeling work can be shared and utilized more easily.

In this post, we briefly looked at how to create documents and HTML files and how to save diagrams as image files.

This concludes the Sparx Enterprise Architect (EA) basics series. In the future, we plan to additionally cover SysML and necessary EA functions.

There may still be some shortcomings, but I hope you understand, and I look forward to continuing to improve my writing skills through continuous posting and to provide you with more useful information.

Thank you for your continued interest and support.

[Enterprise Architect] #14. Trace, Relation, Navigation, composition

[Enterprise Architect] #13. Project Browser, Focus Window

[Enterprise Architect] #12. Other useful functions when creating diagrams

[Enterprise Architect] #11. Useful functions of the Layout menu

[Enterprise Architect] #10. Diagram views

[Enterprise Architect] #9. Enterprise Architect Usage Basics 2

[Enterprise Architect] #8. Enterprise Architect Usage Basics

[Enterprise Architect] #7. EA Modeling Component

[Enterprise Architect] #6. Publish Ribbon

[Enterprise Architect] #5. Layout Ribbon

[Enterprise Architect] #4. Design Ribbon

[Enterprise Architect] #3. Start Ribbon

[Enterprise Architect] #2. Organizing your EA work Desktop

[Enterprise Architect] #1. File Management & Explore Panel

Leave a Comment