Versions Compared

Old Version 1

changes.mady.by.user Smita Nair

Saved on

compared with

New Version 2

changes.mady.by.user Smita Nair

Saved on

Key

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

Description

This article illustrates how to create a profile in the CSV Table and JSON Table macros using a URL.

Info

Before you begin:

  • Before you enter the URL for a repository, ensure that it complies with the REST standards published by GitHub or GitLab.
    • Click here for more information on REST Pattern for GitLab.
    • Click here for more information on REST Pattern for GitHub.
  • Know what is a complete URL. A typical path for the raw file on GitLab looks like:
    /projects/:id/repository/files/:file_path/raw
  • Since the host address begins with:
     https://gitlab.com/api/v4
  • The complete URL, in this example, looks like: 
 https://gitlab.com/api/v4/projects/:id/repository/files/:file_path/raw?ref=master
  • For illustrative purposes, we have used a public Bitbucket public repository. The process for adding a profile and using it in macros remains the same for other repositories and external sources.
  • Verify that the URL conforms to the Confluence Whitelist; provided, whitelisting is enabled in Configuration settings.


There are three ways to work with URLs where you can use:

...

Info

The examples on this page use the CSV Table macro. Refer to the JSON Table macro documentation to know more about the macro's parameters relevant to profiles.


Anchor
at810_HowTo_CompleteURL

...

at810_HowTo_CompleteURL
Using an absolute URL in a profile

You can create a profile by providing the complete URL for the Graphviz to access the CSV or JSON content.

  1. Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Graphviz Configuration > Manage apps > Advanced Tables > Profiles.

  2. Click Add Profile.

  3. Enter a unique name for the profile in the Profile name text box. For this example, enter BitbucketFullURL in the text box.
  4. Select URL from the options in Profile type. 

  5. Enter https://bitbucket.org/bobswift-test/testfiles/raw/66f9cf5ba2bfe3890caf9dc2d89e81b59210a5e6/digraphRows-5k.csv in the URL text box. 

  6. Click Save profile to create the profile.

To use this profile in a Confluence page:

  1. Search for the Graphviz CSV macro and edit it.
  2. Enter BitbucketFullURL in Profile and Select Profile in Data source > Method of locating script.
  3. Select BitbucketFullURL from the Profiles drop-down list, and then, click Save.
    Image Removed        

Anchor

...

at810_HowTo_FixedURL

...

at810_HowTo_FixedURL
Using a base URL in a profile

You can create a profile by providing a base URL and then, enter the relative path to the relevant files in the Graphviz CSV macro.

  1. Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Graphviz Configuration > Manage apps > Advanced Tables > Profiles.

  2. Click Add Profile.

  3. Enter a unique name for the profile in the Profile name text box. For this example, enter BitbucketProfile in the text box.
  4. Select URL from the options in Profile type. 

  5. Enter https://bitbucket.org/bobswift-test/ in the URL to CSV Data text box.

  6. Click Save profile to create the profile.

To use this profile in a Confluence page:

  1. Search for the Graphviz CSV macro and edit it.
  2. Select Profile in Data source > Method of locating script.
  3. Enter BitbucketProfile in ProfileSelect BitbucketProfile from the Profiles drop-down list in the editor.
  4. Enter the relative path to the  CSV file in the URL to Graphviz fileCSV data parameter.
  5. Click Save.
    Image Removed
Info

This method allows multiple users to access a profile across pages and instances of the Graphviz macro CSV Table and JSON Table macros.

Anchor

...

at810_HowTo_AbsoluteURL

...

at810_HowTo_AbsoluteURL
Using an absolute URL directly

You can skip creating a profile entirely and enter an absolute URL in the URL to Graphviz CSV file parameter.

  1. In a Confluence page, search for the Graphviz CSV macro and edit it.
  2. Enter https://bitbucket.org/bobswift-test/testfiles/raw/4e437c71635ac79f796456495807fb6c65218c84/grphvizRows-5k.csv in the the URL to GraphvizCSV file parameter.
  3. Click Save.

...