This article discusses the recommended way of using URLs, especially in correlation with profiles, in the URL to Visio file parameter of the Visio Viewer macro. URLs are used to access Visio files in remote locations and applications, including those applications linked with Confluence, such as GitLab, GitHub, Microsoft OneDrive and so on.
...
You can connect to an external application or location through a URL and display relevant Visio content on your pages. For this purpose, the Visio Viewer macro allows you to use profiles and URLs to specify the complete path to access the required application data. The best practice though, It is recommended to specify both, a profile with a base URL and a relative path in the URL to Visio file field, in the macro configuration. This way, you can access multiple locations through the same profile, and render Visio content on your pages.
| Info |
|---|
Contact your Confluence administrator to understand which profiles are available in your instance |
Click any of the links to know more:
- Types of URLs used in macrosthe Visio Viewer macro
- Precendence in URL processing
- Importance Usage of URLs with respect to profilesand profiles in the macro
- How it all works
- Points to remember
- Additional links
Anchor vis_53_tutl_URLs_macros vis_53_tutl_URLs_macros
| vis_53_tutl_URLs_macros | |
| vis_53_tutl_URLs_macros |
...
Types of URLs used in the Visio Viewer macro
First, it is important to understand how the macro processes URLs. A URL provided in a macro can be:
...
| Priority given | URL type | Description |
|---|---|---|
| 1 | Application links | If the given URL is linked to a specific application like Bitbucket, the macro does not require any user credentials and renders the specified file. Refer to this article for information about application links. |
| 2 | Profiles | If Profile is specified, the macro appends the URL given in URL to Visio file to the URL specified in the profile configuration, and accesses the location to render the required file. |
| 3 | Simple URLs | Lastly, if no application links or profiles are given and just an absolute URL is given, the URL is processed as-is and the required file is rendered. Note that the specified URL must point to a public resource; else, it is recommended to create and use a profile to access any private location. |
Anchor vis_53_tutl_URLs_profiles vis_53_tutl_URLs_profiles
| vis_53_tutl_URLs_profiles | |
| vis_53_tutl_URLs_profiles |
...
Usage of URLs
...
and profiles in the macro
The correlation between URLs and profiles with respect to the macro can be explained as:
...
| Note | ||
|---|---|---|
| ||
|
Macro editor settings
After the profile is created, it must be specified in the macro along with the path to the Visio file to be rendered.
Create or edit a page, add the Visio Viewer macro, and edit to open the macro editor.
- Select the relevant profile from the Profile drop-down.
Enter a relative path (partial URL) to access the required Visio file in URL to Visio file.
Tip Click Preview to verify that the path given with the profile renders the Visio file correctly.
Note As mentioned, the macro appends the relative path in the URL to Visio file with the base URL given in the profile. If this (absolute) path is valid, the specified file is read and the Visio content is displayed, else, a network error is displayed.
Save the macro and publish the page to see the content.
...