SECollab Configurations

This section contains the complementary configuration required to start creating Collaboration Links between Jira and SECollab in case this latter is your Remote OSLC Application. At this point it is supposed that you have already:

  1. Performed administration described in Managing Consumers for SECollab
  2. Performed administration described in Managing Friends for SECollab
  3. Performed administration described in Configuring the Collaboration Links field

If so, you should have a consumer and friend whose authorized Key and name respectively is SECollab, and its password is whatever you have typed on the corresponding Secret fields when you created them. With this information, let's turn around to the SECollab application, procedures in all subsections ahead have the same:

Shared Configuration Prerequisites

Configuring a Consumer for Jira.

Before starting with this procedure, you can review the concept of Managing Consumers, in the Configuration section, if you don't recall it.

  1. Click on the Administration (gear) icon at the top-right corner.
  2. Select the Server administration option.
  3. On the left panel, click the Consumers option under the Communication section.
  4. On the right panel, click the Add Consumer button.
  5. On the opened dialog, fill the form fields with the following values:
    Field Value
    Name Jira
    Key jira
    Secret Whatever you have chosen when registering the SECollab friend on Jira.
    Confirmation The same as Secret field.
    Trusted checked
  6. Click the Register button to save and close the dialog.

If everything went ok, you will see your registry on the consumers table.

Configuring a Friend for Jira.

Before starting with this procedure, you can review the concept of Managing Friends, in the Configuration section, if you don't recall it.

  1. Click on the Administration (gear) icon at the top-right corner.
  2. Select the Server administration option.
  3. On the left panel, click the Friends option under the Communication section.
  4. On the right panel, click the Register a Friend button.
  5. On the opened dialog, fill the form fields with the following values:
    Field Value
    Title Jira
    Root Services URI https://your.jira.real.domain.com/rest/oslc/1.0/rootservices [1]
    OAuth Key SECollab
    OAuth Secret Your chosen password
    Confirm Secret Re-type your chosen password
  6. Click the Register button to save and close the dialog.

If everything went ok, you will see your registry on the friends table.

Configuring Associations for Jira Projects.

Associations are defined at SECollab project level and they define the way how two projects (the one on SECollab and the other on Jira) can collaborate. Currently, SECollab defines the following types of associations:

As you can see, each type definition has two parts: the first part defines which end application is the one that can use or create artifacts, of the type defined by the second part, in the other application. Provides means the Jira project can use or create artifacts in the SECollab project. Uses means the opposite: SECollab project can use or create artifacts in the Jira project. The type of Collaboration links that a regular user will be able to create on SECollab, and the type of artifacts where she/he will be able to create them, depend directly on what association types you define in the procedure below for a particular SECollab project.

Summarizing, each SECollab project needs to be configured with associations types for specific Jira projects it needs to collaborate to. To add associations on a SECollab project:

  1. Select the project you want to configure from the Projects list in the welcome page.
  2. Click on the Administration (gear) icon at the top-right corner.
  3. Select the Project administration option.
  4. On the left panel, click the Associations option under the Project section.
  5. On the right panel, click the Add Association button.
  6. On the opened Add Association dialog, expand the Friend Application combo.
  7. Select the Jira entry that will be there, if you completed the Configuring a Friend for Jira procedure.
  8. A new Association combo must appear, expand it and choose the association type you want to create.
  9. As soon as you select the association type, a pop-up window will appear [1]. If you hadn't previously started a Jira session in the same browser, the new window will show you the Jira login page and you must continue with this step, otherwise please go to the next one [2]. Login page is here to complete the user authentication process, please provide a valid user credentials, it is not necessary that such user has an admin role [2].
  10. What happens after the user authentication process (or if you had already started a session in other browser's tab) depends on whether you configured the SECollab consumer on Jira as trusted or not. If you configured it as trusted, the only thing you need to do is to ignore a blank page that will be displayed for a very tiny moment, and then you can go to the next step; otherwise, you will see the Authorize Application page which is a last confirmation to allow SECollab accessing Jira information on behalf the user you used to login [3]. Click the Allow button and then close the pop-up window when indicated if it is not closed automatically.
  11. Back on the Add Association dialog, a new Project field will display the available projects for the logged-in user. Choose the project to which you want to create the association and click the Add Association button.

If everything went ok, the Add Association dialog will be closed and the new association will be displayed in the Project Associations page. You can repeat the steps 5-11 to add more association types over the same or other Jira projects; remember that this time, steps 9 and 10 won't be necessary as authentication and authorization is required only once per session.

Congratulations, you have completed all configurations required to allow SECollab regular users to create Collaborations Links to Jira issues. Please refer to the user guide for a detailed description of such procedure.