What Is the OpenDocs Pipeline?
The OpenDocs pipeline is a connection between Visual Paradigm Desktop diagrams and OpenDocs
documents. It allows diagrams to be published as pipeline artifacts, tracked through project
revisions, and inserted into documents when needed.
This workflow is useful for software specifications, system design documents, business
requirements, architecture documentation, project proposals, and other deliverables that
contain Visual Paradigm diagrams.
How the Diagram Revision Workflow Works
A diagram is not automatically added to the OpenDocs pipeline. You must manually send the
diagram to the pipeline at least once. After the initial send, future project commits
automatically generate new revisions for that diagram.
- Open the diagram in Visual Paradigm Desktop.
- Open the drawer on the right side of the diagram.
- Click Send to OpenDocs Pipeline.
- Optionally enter a comment to describe the change.
- Click OK to send the diagram to the pipeline.
- Commit subsequent project changes to generate new diagram revisions automatically.
The optional comment can help team members understand why a diagram was sent or what changed
between revisions. For example, you might record that a use case diagram was updated to
reflect a new authentication flow.
Desktop-Based and Online-Based Diagram Revisions
Revision availability depends on where the diagram is managed.
Diagrams Created in Visual Paradigm Desktop
After a desktop-based diagram has been sent to the pipeline once, every project commit
creates a new revision. This makes it possible to select an earlier or more recent version
when maintaining a document.
Online-Based Diagrams
For online-based diagrams, OpenDocs displays the latest revision together with any revisions
that were sent manually. This provides access to the current version while also preserving
selected revisions for documentation purposes.
How to Open OpenDocs
- In Visual Paradigm, open the Tools menu.
- Select Apps.
- Launch OpenDocs.
Once OpenDocs is open, you can create or edit a document and insert diagrams from the
pipeline.
How to Insert a Diagram into an OpenDocs Document
- Open the document in OpenDocs.
- Place the cursor where you want the diagram to appear.
- Click Insert.
- Select Pipeline.
- Click the required artifact to insert its current or latest revision.
If you need to insert a particular version rather than the latest revision, click the
revision icon associated with the artifact. You can then review the available revisions and
select the version required for your document.
How to Select a Specific Diagram Revision
OpenDocs allows you to choose the revision that best matches the content and purpose of your
document. This is especially useful when a document describes a specific project milestone,
release, or design baseline.
- Open the document’s pipeline panel.
- Locate the diagram artifact.
- Click the revision icon.
- Review the available revisions.
- Select the revision you want to insert or use in the document.
Selecting a specific revision helps prevent a document from unintentionally displaying a
diagram that reflects changes made after the document was approved.
How to Update a Diagram Already Used in a Document
The OpenDocs pipeline panel shows the artifacts available to the project and the artifacts
currently associated with the document. When a diagram used in the document is updated, an
indicator appears in the panel.
- Open the document’s pipeline panel.
- Find the artifact with the update indicator.
- Click the indicator to view the available revisions.
- Compare the available revisions with the revision currently in use.
- Select the preferred revision to update the document.
You can choose the latest revision or another available revision, depending on whether the
document should reflect the newest project changes or remain aligned with a particular
baseline.
Benefits of Using the OpenDocs Pipeline
- Consistent documentation: Keep diagrams and written content aligned with
project changes.
- Revision control: Choose the diagram version that belongs in a specific
document or project milestone.
- Efficient updates: Identify changed artifacts through visual indicators
in the pipeline panel.
- Better collaboration: Make it easier for project teams, analysts,
developers, and stakeholders to work with the same diagram versions.
- Reduced manual work: Avoid repeatedly exporting and replacing diagrams
when project revisions are available through the pipeline.
Recommended Workflow for Teams
- Finalize the initial version of a diagram before sending it to the OpenDocs pipeline.
- Add a meaningful comment when sending the diagram, especially when documenting a major
design change.
- Commit project changes regularly so that new diagram revisions are recorded.
- Insert the appropriate diagram revision into the OpenDocs document.
- Check the pipeline panel before publishing or approving the document.
- Review update indicators and decide whether the document should use the latest revision
or a specific earlier revision.
Availability and Requirements
The OpenDocs pipeline feature is available in the Professional Edition or above.
It works when both the repository and the project are hosted in Visual Paradigm Online.
Before using the workflow, confirm that your Visual Paradigm edition supports the feature and
that the relevant repository and project meet the hosting requirements.
Frequently Asked Questions
Are all Visual Paradigm Desktop diagrams automatically added to the pipeline?
No. A diagram must be manually sent to the OpenDocs pipeline at least once. After that
initial action, project commits can generate new revisions for the diagram.
What happens after I send a diagram to the pipeline?
The diagram becomes available as a pipeline artifact. Future project commits generate new
revisions, allowing you to insert or update the diagram in OpenDocs.
Can I insert an older diagram revision into a document?
Yes. Open the pipeline panel, click the artifact’s revision icon, and select the revision
required for the document.
How do I know when a diagram in my document has changed?
An update indicator appears in the OpenDocs pipeline panel when an artifact used in the
document has a newer available revision.
Can I choose whether to use the latest revision?
Yes. You can insert the current or latest revision, or select a specific revision from the
available revision list.
Which Visual Paradigm edition supports this feature?
The feature is available in the Professional Edition or above.
Where must the repository and project be hosted?
Both the repository and the project must be hosted in Visual Paradigm Online.
Conclusion
The OpenDocs pipeline provides a practical way to connect Visual Paradigm diagrams with
structured project documentation. By manually publishing a diagram once, tracking later
revisions, and selecting the appropriate version during document editing, teams can keep
technical and business documents accurate without losing control over document baselines.
This workflow is particularly valuable for teams that regularly update system models,
software architecture diagrams, process models, and requirements documentation.
