Versions Compared

Old Version 1

changes.mady.by.user Sireesha Dugginapeddi [Appfire] (Inactive)

Saved on

compared with

New Version Current

changes.mady.by.user Sunita Patro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

After migrating or installing Graphviz Diagrams for Confluence, navigate to the

...

Configuration screen:

  1. Log in with the 

...

  1. system administrator global permission.
  2. Navigate to Image Added > Settings on the sidebar.

...

  1. Select Graphviz Configuration under ATLASSIAN MARKETPLACE to manage the app's configuration.

The Configuration

...

page

...

contains the following tabs

...

:

Anchor
gviz_config_global
gviz_config_global
Global configuration

Use the toggle to enable or disable the

...

app's configuration settings.

Image Added

TabDefaultDescription
Anchor
gviz_config_global_restrictURL
gviz_config_global_restrictURL
Restrict URL access		On
When this option is
If enabled, the URL parameter in the app is restricted to only the URLs available
in CONFLUENCE ADMINISTRATION > General Configuration > USERS & SECURITY > Whitelist.
Help Us Improve the Product OnWhen this option is
in the Allowlist tab.
Allow JavaScriptOff

Enable this option to use Javascript in the Graphviz for Confluence macros. This option allows administrators to control the usage of JavaScript in the macros.

If enabled, the usage of Javascript in the macros is not restricted and thus, users must be advised about the potential security issues if this feature is not used correctly. If disabled, this option prevents users from using JavaScript in the macros.

Help us improve the product OnIf enabled, it allows us to collect some usage data that
will
help's us improve our product. To learn more about what is being sent, refer
to Analytics Data.

...

to Analytics data.

Click Save to save the modified settings.

Anchor
Whitelist
Whitelist
Allowlist

Manage the list of all the URLs that can be accessed by the app, in this page. If the Restrict URL access option is enabled, the app is restricted to allow the specified URLs only. 

Image Added

ParameterDescription
ExpressionEnter a URL or an expression here.
Type

Select a type from the following list:

  • Domain name - allows URLs of a specific domain. Example: https://www.example.com/
  • Exact match - allows only the specified URL. Example: https://www.example.com/thispage
  • Wildcard expression - allows all matching URLs. Use * as a wildcard character to replace one or more characters. Example: https://*example.com
  • Regular expression - allows all URLs matching the specified regular expression. Refer to this link for more information about regular expressions. Example: http(s)?://www\.example\.com

You can perform the following actions on this page:

  • Add the URL after specifying the Expression and Type.
  • Update after modifying the details. Select the Expression to enable editing of the URL.
  • Delete to remove the URL.
  • Save after adding or modifying any URL in the list.

Anchor
gviz_config_profiles
gviz_config_profiles
Profiles

Profiles consist of a set of common parameters that allow users to access data from external applications such as GitHub or GitLab through the macros. Some advantages of using profiles are:

  • Profiles allow user authentication required by some URLs to be hidden from page viewers and editors. Only Confluence administrators have access to this information.
  • Enables macro editors to quickly configure the macro by reusing a shared definition for URL access. 
  • Relative addressing can be used to make the page content less likely to require changes when the base URLs are relocated. 
    • Macro configured URL (that is not a full URL) is appended to the profile provided URL.

Image Added

The page displays a list of profiles available for the macros. Click Add Profile to open a pop-up window as:

Image Added

ParameterDescription
Profile name

Enter a name for the profile.

Note

This name must be unique; else, the details specified overwrites the details of the existing profile. This may cause errors in pages where the profile is used.


Profile typeSpecify whether this is a URL, GitLab, or GitHub profile type.
URLEnter the URL of the application to be accessed. If the Profile type is either GitLab or GitHub, a default base URL is displayed here, that is editable.
User; PasswordEnter the username and password to access the specified URL.
Access tokenApplicable for GitLab and GitHub URLs. Administrators must generate the access tokens from either the GitLab or GitHub applications and enter that here.
URL parametersMention any extra parameters that must be appended to the URL here. 
Request headersDisplays the request headers created as per the given information.

You can perform the following actions on this page:

  • Click Image Added to edit the profile details.
  • Click Image Added to remove the profile.
  • Click Save profile to create the profile.