Create a profile with a URL

Description

This article illustrates how administrators can create a profile using URLs to be used with the Visio Viewer macro.

Before you begin:

  • Before you enter the URL for a repository, ensure that it is a raw URL. 

    A raw URL is defined as the part of the URL following the domain information and includes the query string, if present. For example, in the URL string http://www.contoso.com/articles/recent.aspx, the raw URL is /articles/recent.aspx.

  • Know what is a complete URL.

    • A typical path for the raw file on Bitbucket looks like:
      /projects/:id/repository/files/:file_path/raw

    • If the host address begins with:
      https://bitbucket.workspace.com

    • The complete URL, in this example, looks like: 
      https://bitbucket.workspace.com/projects/:id/repository/files/:file_path/raw?ref=master

  • For illustrative purposes, we have used a public Bitbucket repository. Use URLs to add to profiles and in macros as per your requirement and your instance. The process of adding a profile and using it in macros remains the same for other repositories and external sources.


There are two ways to configure profiles with URLs:

Using an absolute URL in a profile

You can create a profile by providing the complete URL in the macro editor.

  1. Select  > Manage apps, either search for Visio for Confluence or scroll to Bob Swift Configuration, and click Visio to view app configuration.

    Try this for older Confluence versions!

    Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Visio > Profiles.

  2. Click Add Profile.

  3. Enter a unique name for the profile in the Profile name text box.
  4. Select URL from the options in Profile type
  5. Enter an absolute URL of the location to be accessed in the URL text box. 

  6. Click Save profile to create the profile.

To use this profile in a Confluence page:

  1. Add the Visio Viewer macro or edit an existing macro on the page.
  2. Select the newly created profile from the Profile list.
  3. See a Preview of the Visio diagram, or click Save.

Using a partial URL in a profile

You can create a profile by providing a base URL to access the remote location, and then users can provide the relative path to the relevant file in the Visio Viewer macro editor.

  1. Select  > Manage apps, either search for Visio for Confluence or scroll to Bob Swift Configuration, and click Visio to view app configuration.

    Try this for older Confluence versions!

    Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Visio > Profiles.

  2. Click Add Profile.

  3. Enter a unique name for the profile in the Profile name text box.
  4. Select URL from the options in Profile type
  5. Enter the base URL in the URL text box. A base URL is a part of the path that specifies the location that the macro must access.

  6. Click Save profile to create the profile.

To use this profile in a Confluence page:

  1. Add the Visio Viewer macro or edit an existing macro on the page.
  2. Select the newly created profile from the Profile list in the editor.
  3. Enter the relative path to the Visio file in the URL to Visio file parameter. The relative URL is appended to the base URL specified in the profile to create an absolute path to the file to be rendered.
  4. Click Save.

Points to remember!

  • Only raw URLs must be given in either the URL field in profiles in app configuration or the URL to Visio file field in the macro editor.
  • It is recommended to specify absolute URLs to access files from public locations and to use profiles to access files from private sources. For example, a raw URL that can access a Visio file in a public Bitbucket repository is valid. But to render a Visio file located in a private repository, we recommend using a profile.
  • Profiles are a means to access and retrieve contents from external applications such as Bitbucket. A profile already contains the base URL and the required credentials (user credentials or an access token) to access the relevant application.
  • This method allows multiple users to access a profile across pages and instances of the macros.