- 1. About
- 2. Library file : LibRagnar2.xml
- 3. Library file : eendraadschema.xml (Electrical diagrams)
- 4. Remark: the Draw.io library file-format
This repository provides recommendations, libraries, templates and samples for the diagramming software Draw.io. The online diagramming tool Draw.io is a free and open source service supporting multiple browsers. This online tool can be run both online or locally using a portable executable - thus no local administrator access, network access, expensive license and no vendor lock-in. The native file format is fully xml-based (so it can be parsed) and the application supports multiple import/export formats. Additionally: Draw.io has many build-in diagram libraries, you can import your own online libraries (ex: maintained on GitHub), save-to & preview-in online services (ex: Google Drive), share & edit concurrently, use container shapes and even has basic add-on support.
Enough sales pitch, they are not paying me, this is just my personal viewpoint... go here for info: https://about.draw.io/.
Diagram choices often depend upon the company culture, target deployment stack and audience. Creating diagrams should make you think hard about what you want to represent and achieve. You should be able to start abstract and high level while completing and become more specific as you progress.
As we move along we might provide some recommendations and opinions, here are already some opinionated suggestions:
- Avoid using the following diagrams by default: flowcharts & UML
- Consider starting with: BPMN, ArchiMate, DFD (updated style).
- Refine details with: sequence diagram or more specialized [area-specific] diagrams.
- For Project Management, the following sequence has been most useful to me: mindmap a WBS (tasks & group activities) > PERT (graph dependencies automated) > CPM (path analysis & duration) > Gantt (simplified)
TODO: include demo and sample links.
- Electrical one-line diagram (in Dutch: eendraadschema).
RAW link: https://raw.githubusercontent.com/rlodbrok/draw.io/master/LibRagnar2.xml (can be used for directly loading library into draw.io).
DFD represents flow of data for a logical process or a physical system, providing context for the outputs and inputs of each entity. DFD is an excellent communication tool between User, System Designer and System Engineers.
DFD has NO control flow, no decision rules, no loops. This is actually an advantage in early analysis, when requiring additional control operations you can use something like flowcharts, while for detailed interface communication dialogues you can use diagrams like: time-sequence / flow-control.
DFD is quite compatible with UML Deployment diagrams and can even be extended with ArchiMate symbols. With 3 shapes and one arrow you can represent most of what is required by a Systems Analyst in the early project stages after initial requirements gathering.
Preferences:
- Diagram style DFD Gane & Sarson;
- Shapes using Archimate symbols;
- Flows include extensive flexibility and annotation.
Reminder: DFD arrows represents the direction of the data-flow, NOT the direction of network/application communication (communication can have multiple steps, go back/forth with different intervals). As mentioned before, for network handshake and detailed network communication you use diagrams like: time-sequence / flow-control.
- Reminder: arrow direction indicates data flow direction!
- Mid-arrow information should provide context, like: PUSH/PULL, protocol(s), ...
- Arrow ends can contain optional properties, examples: network ports for (S)ource & (D)estination, IP addresses, ...
- Alternative adapter designations are also possible (abbreviated): (I)nitiator, (S)erver, (P)rovider, ... TODO: elaborate on why certain terminology can cause confusion
Besides identifying the Initiator by specifying PUSH/PULL in the flow direction you shall also specify the used protocols. Important protocol details often differ based on the target audience, therefore we recommend the following Pattern:
Network Protocol(s) / Application Protocol(s) / File Format(s)
Examples
- HTTPS / REST / JSON
- HTTP / SOAP / XML
- SAPRFC / ALE / IDOC
Electrical one-line diagram symbols.
RAW link: https://raw.githubusercontent.com/rlodbrok/draw.io/master/eendraadschema.xml (can be used for directly loading library into draw.io).
This library contains basic shapes for electrical one-line diagram symbols. Be aware, the names in the library are in Dutch (English version on demand only).
De standard draw.io bibliotheek voor electrische diagrammen is waarschijnlijk (nog) niet geschikt voor reglementaire eendraadschema's. De symbolen in deze bibliotheek zijn een eerste versie voor het tekenen van elektrische eendraadschema's. Je kan de RAW link direct gebruiken om de bibliotheek te openen in de editor via: File > Open Library.
TODO: include sample link to position/situation and wire diagram.
Earlier I mentioned it is xml-based, but after investigation you notice it does not seem that way - so what is going-on here? The native format is a compressed xml mxGraph using base64 encoding. While it is easy to decode, if you want to save it directly in a readable format you should export it as "uncompressed xml".