Managing OSLC Links

Once OSLC Connect for Confluence is installed and configured, users have access to a new macro when they edit a page: the OSLC Connect - Link macro. To open the OSLC Link macro editor, users can either:

• Open the macro browser with the toolbar (or with Ctrl+Shift+A) and look for the OSLC Connect - Link macro in the External content section.
• Use the macro suggestions, by typing {oslc anywhere in the page and selecting the OSLC Connect - Link macro.

With the OSLC Connect - Link macro, it is possible to create or remove OSLC links, as well as choose between different display modes.

Creating an OSLC Link

1. Open the OSLC Connect - Link macro editor with the method of your choice.
2. Select the Domain of the artifacts you want to link with in the OSLC Remote Application. Supported domains are: Architecture Management, Change Management, Quality Management and Requirements Management ^[1].
3. A new Container combo will be displayed with the associated remote projects/containers to select ^[2].
4. Two new radio buttons will be displayed:
   • Create new - allows to create a new artifact before linking to it.
   • Link to existing - allows linking to an existing artifact.
   Choose the radio button that better fits your needs. Note that depending on the OSLC Remote Application and the privileges of the logged-in user, some options may not be available.
5. Select the remote artifact type you want to link to, next to the selected radio button.
6. Click on the Add Link button.
7. A new dialog will be displayed, with the OSLC Remote Application content, to allow you either select or create an artifact to link to. Complete the remote form and confirm this action by pressing the OK button.

If everything went as planned, the selection/creation dialog will be closed, then the created OSLC Connect - Link macro(s) will be visible inside the page, at the location that was selected when the editor was opened. If, on the other hand, there is a constraint or failure with the linking, the macro editor will remain open and will report all problems found.

Updating an OSLC Link

After an OSLC Link has been created, you can choose how you want it to be displayed inside the page:

1. Click on the OSLC Connect - Link macro placeholder.
2. A small macro toolbar will be displayed where you can choose:
   • Display as Link (default value): displays the title and icon of the remote artifact. The artifact preview is displayed on mouse hover.
   • Display as small Preview: displays the remote artifact small preview directly within the Confluence page.
   • Display as large Preview: displays the remote artifact large preview directly within the Confluence page. If no large preview is available, displays the small preview instead.

There is no way to update the target artifact of an OSLC Link. If you chose the wrong artifact, you will have to remove the OSLC Link and then create it again correctly.

Previewing an OSLC Link

To see how an OSLC Link is going to be displayed in the page:

1. Click on the OSLC Connect - Link macro placeholder.
2. Click on the Preview button.
3. Verify that the link displays the remote artifact as expected, with the chosen presentation (link, small preview or large preview).

Removing an OSLC Link

1. Click on the OSLC Connect - Link macro placeholder you want to remove.
2. Click on the Remove button.

If everything went ok, you should no longer see the macro placeholder inside the page.

Global Configurations Compatibility

OSLC Links cannot be created if the OSLC Remote Application is Configuration Management enabled, unless a Global Configuration has been set up on the current Confluence page. To learn more, see how to Manage Global Configurations.

^[1] Available domains depend on the configuration done at administration level. If the required domain is missing, please ask help from a space or server administrator. ^[2] When you fill the Container field, if you hadn't previously started an OSLC Remote Application session, a pop-up window will appear with an authentication page. Please make sure your browser did not prevent the opening of the pop-up window (if it does it will display a warning notification) and provide valid user credentials.