FAQ - Frequently asked questions - PlantUML for Confluence

Welcome to our Frequently Asked Questions page! Here, we've gathered some of the most common questions users have about our 'PlantUML for Confluence - Instant Diagrams from Text' app. We have divided them into three categories:

PlantUML

Q: What is PlantUML?
A: PlantUML is a tool that allows you to create UML diagrams using a simple and intuitive language. With PlantUML, you can quickly create diagrams such as sequence, class, and use case diagrams by writing structured text.

Q: Do I need to know how to code to use PlantUML?
A: Not at all. While PlantUML does use a text-based language to generate diagrams, the syntax is designed to be simple and intuitive, even for those without a programming background.

Q: Can PlantUML be used for non-UML diagrams?
A: Yes! While PlantUML is commonly used for UML diagrams, it also supports the creation of various other types of diagrams including Gantt charts, mind maps, and Wireframes.

Confluence

Q: Why do PlantUML diagrams show an error for anonymous or guest users?

A: Due to the current limitations in Forge, apps are not viewable by anonymous or guest users. As a result, the 'PlantUML for Confluence' app cannot be displayed for these users. They may encounter an error message stating "Something went wrong - User did not have access to specified resource(s)" or "Error loading the extension!". This is a known issue. For updates on this, you can track its progress on the Atlassian Ecosystem bug tracker: https://ecosystem.atlassian.net/browse/FRGE-1145 . We appreciate your understanding.

Q: How does 'PlantUML for Confluence - Instant Diagrams from Text' enhance my Confluence experience?
A: Our app seamlessly integrates PlantUML with Confluence, allowing you to generate and insert UML diagrams directly into your Confluence pages. This makes it easier to visualize complex concepts and workflows, enhancing communication and collaboration within your team.

Q: Can I share the diagrams I create with my team?
A: Yes! Any diagrams you create with 'PlantUML for Confluence - Instant Diagrams from Text' can be embedded directly into your Confluence pages and shared with your team.

Q: Will the diagrams be included when I export a Confluence page?
A: Yes, the diagrams generated with 'PlantUML for Confluence - Instant Diagrams from Text' will be included when you export your Confluence pages. This makes it easy to share your complete work externally.

Q: What should I do if my diagrams are complex?
A: Complex diagrams might take a longer time to load, and in some cases, might not load at all. We recommend simplifying or breaking down complex diagrams into smaller parts for the best user experience.

Custom URL

Q: What is a Custom URL in PlantUML for Confluence?
A: A custom URL allows you to direct the PlantUML for Confluence app to use a specific, externally accessible server for generating your diagrams. This can be a private server, offering more control over the diagram generation process.

Q: How do I set up a Custom URL?
A: To set a custom URL:

  1. Navigate to Confluence Administration.

  2. Select PlantUML for Confluence.

  3. Enter your server's URL in the Custom URL field.

  4. Save your settings.

Q: What should the Custom URL format be?
A: The URL should start with https://, contain /plantuml/ in the path, and end with a /. For example, https://yourserver.com/plantuml/png/ for PNG diagrams.

Q: Can I use any server as my Custom URL?
A: Yes, as long as the server is externally accessible and secured with HTTPS. However, ensure that the server supports the necessary features for diagram generation. For mnore information, checkout https://appsfoundry.atlassian.net/wiki/spaces/PLANTUML/pages/478085126

Q: What happens if I enter an invalid URL?
A: The app will display an error message guiding you to correct the URL. Ensure it starts with https://, includes /plantuml/, and ends with a /.

Q: Will the app work without a Custom URL?
A: Yes, if no custom URL is provided, the app defaults to using https://www.plantuml.com/plantuml/svg/.

Q: Are there any diagrams that cannot be generated with a custom URL?
A: The ability to generate specific types of diagrams depends on the server capabilities. Note that SVG format is not compatible with all diagram types, e.g., ditaa diagrams can only be generated in PNG.

Q: Is it possible to revert to the default URL after setting a custom one?
A: Absolutely. Simply clear the Custom URL field in the settings, and the app will revert to the default URL.

Q: What are the security implications of using a custom URL?
A: While a custom URL offers greater flexibility, it's important to ensure that your server is secure. We are not responsible for any security issues or vulnerabilities that may arise from using a custom server.

Q: Can I use the custom URL feature to share diagrams?
A: The custom URL is primarily for generating diagrams. To share diagrams, you'll need to use the standard sharing features of Confluence or your server's capabilities.

Data Security & Privacy

Q: How does 'PlantUML for Confluence - Instant Diagrams from Text' handle data security?
A: The app processes your PlantUML code and sends it as a hashed string to PlantUML.com for diagram generation. However, we strongly advise against using the app for diagramming sensitive data as this involves data transmission to a third party.

Q: Who is responsible for the data sent to PlantUML.com?
A: The individual user is responsible for the data sent to PlantUML.com. AppsFoundry does not accept any liability for the security and privacy of the data sent.

Q: What precautions should I take while using 'PlantUML for Confluence - Instant Diagrams from Text'?
A: Be aware of the kind of data you are including in your diagrams. Avoid including sensitive or confidential information in the PlantUML code you write. Always remember, the use of the app is at your own discretion and risk.

If you have any other questions not addressed here, please don't hesitate to contact us. We're here to help!