Application Management

Overview

An application represents the link between what your team is actually developing and all the information that can be provided. You’ll generally want this to be one-to-one. That is for every application your team is developing, you should create an application via the IQ Server. While this application is merely a representation of the real thing, it’s no less important.

At the application level, you can do nearly everything you can for an organization. This includes creating policies and all the associated details. Additionally, whenever you perform an evaluation, and a report is generated, all that information will be associated to a specific application.

Creating an Application

As a general rule with any activity, make sure you have proper access to the IQ Server. In the case of application creation, you will need to be a member of a role that has been granted the Edit IQ Elements permission. In the roles provided by default, this would be the Owner role for an organization.

When you create an application, you can assign the following items for identifying it:

  • Application Name - The name that appears in the sidebar and at the top of the Organization & Policies area when the application is selected.
  • Application ID - A unique identifier that’s used by integration tools (e.g. Nexus IQ for Bamboo, IQ for IDEA, REST APIs and more) when performing component evaluations.
  • Icon - A graphical representation of the application that appears at the top of the Organization & Policies area (when the application is selected in the sidebar) and in Reporting. You can select from the default icon, a robot icon, or a custom icon.

To create an application:

  1. Click the Organization & Policies icon  on the IQ Server toolbar.
  2. In the sidebar, click the organization to which you want to attach an application. A New Application button is displayed.
  3. Click the New Application button.
  4. In the New Application dialog, set the following attributes:
    1. Application Name - Enter a name into the text box.
    2. Application ID - Enter an identifier into the text box.
    3. Icon - Select from three options:
      1. Default - Uses the default image.
      2. Upload a custom icon - Click the Upload icon image button to navigate to an image file in PNG format and click Open. The image should be sized to 160 x 160 pixels. Images with different sizes will be scaled.
      3. Get a robot - Click the Get Another Robot button to cycle randomly through a variety of robot images.
  5. Click the Create button.

Editing an Application

  1. Click the Organization & Policies icon  on the IQ Server toolbar.
  2. In the sidebar, select the application you want to edit.
  3. In the Organization & Policies Management area, go the Actions menu and click Edit App Name / Icon.
  4. In the Edit Application dialog, edit any of the following attributes:
    1. Application Name - Enter a different name into the text box.
    2. Icon - Select from three options:
      1. Use existing icon - To use the current image.
      2. Upload a custom icon - Click the Upload Icon Image button to navigate to an image file in PNG format and click Open. The image should be sized to 160 x 160 pixels. Images with different sizes will be scaled.
      3. Get a robot - Click the Get Another Robot button to cycle randomly through a variety of robot images.
  5. Click the Update button to save changes.

Selecting an Application Contact

Optionally, you can select a contact person for an application. The contact is displayed at the top of the Organization & Policies page, as well as in the reporting area of the Nexus and the PDF version of the report.

To select a contact:

  1. Click the Organization & Policies icon  on the IQ Server toolbar.
  2. Select an application in the sidebar.
  3. Go to the Actions menu and click Select Contact.
  4. In the Select Contact box, search for a user by entering a full name or part of name with an asterisk, then click Search. You can use an asterisk as a wildcard at the beginning or end of a character string. For example, isa*, *mov, and *asi* will all match the name, "Isaac Asimov." Any matching names are displayed below the search box.
  5. Select a user in the results list and click Select. The user’s name is displayed at the top of the page below the application name.

Removing an Application Contact

To remove a contact:

  1. Click the Organization & Policies icon  on the IQ Server toolbar.
  2. Select an application in the sidebar.
  3. Go to the Actions menu and click Select Contact.
  4. In the Select Contact box, click the Clear Contact button. In the alert box, click Continue.
    The user’s name is removed from the top of the page.

Copying the Application ID to Clipboard

External tools integrated with IQ Server need to be configured with a public Application ID that identifies which application to use when evaluating components. You can speed the configuration process by copying the Application ID to the clipboard using the steps below.

To copy the Application ID to the clipboard:

  1. Click the Organization & Policies icon  on the IQ Server toolbar.
  2. Select an application in the sidebar.
  3. Go to the Actions menu and click App ID to Clipboard.

Changing an Application ID

The Application ID is a unique identifier used by external tools to integrate with IQ Server (e.g. Nexus IQ for Bamboo, IQ for IDEA, REST APIs, etc.) for performing component evaluations. If you change the Application ID, you must also reconfigure the external tool(s).

To change the Application ID for an application:

  1. Click the Organization & Policies icon  on the IQ Server toolbar.Select an application in the sidebar.
  2. Go to the Actions menu and click Change App ID.
  3. In the Change Application ID dialog, enter a unique identifier in the New Application ID text box.
  4. Click Change to save the new Application ID.

Remember to reconfigure your external tools to use the updated Application ID.


Moving an Application

At some point, you may want to move an application to a different organization. When moving an application, it’s not just the entity that moves, but also its configuration (i.e. policies, component labels, and waivers). If the application has any local configuration settings, those settings are unaffected and remain unchanged by a move. However, if the application has inherited any organization-level configuration, there is the potential for incompatibility between the application’s source organization and the destination organization.

During a move, IQ Server compares the configuration of the source organization to the destination organization, and looks for matches by name. If the destination has configuration settings that match all of the source’s configuration, then the application’s parent reference is changed to the destination organization. If the source configuration is not matched in entirety, then IQ Server displays an error message with information about the missing configuration in the destination organization. You need to fix any discrepancy to ensure the source configuration is matched in the destination.

To move an application:

Make sure you have permission to modify the application in its original parent organization and permission to create applications in the destination organization.

Policies are mapped by name between the source organization and target organization. If a policy has the same name in both organizations but has been configured differently in each organization, fine grained waivers will no longer behave as expected after the application has been moved. Fine grained waivers capture details regarding a policy violation in order to determine when the waiver is applicable, so if the policy violations do not contain the same information, then the fine grained waivers will not apply.

  1. Click the Organization & Policies icon  on the IQ Server toolbar.Select an application in the sidebar.
  2. Select an application in the sidebar.
  3. Go to the Actions menu and click Move <application name>.
  4. In the Move Application dialog, select an organization from the New Parent Organization list and click Update.


A Success message is displayed. If you get an error instead, the message lists the configuration discrepancies between the source and destination organizations that need to be resolved before the application can be moved.

The user who moves an application is assigned to the Owner role for the moved application. After a move, you may want to review user role assignments and notification settings, and adjust them as desired.

Deleting an Application

To delete an application:

  1. Click the Organization & Policies icon  on the IQ Server toolbar.Select an application in the sidebar.
  2. In the sidebar, select the application you want to delete.
  3. In the Organization & Policies area, click the Actions menu and choose Delete <application name>.
  4. In the Delete <application name> dialog, click Continue to permanently delete the application or click Cancel to keep the application.

Deleting an application cannot be undone.

Viewing an Application

From anywhere on the IQ Server, you can view organizations and applications by clicking the Organization & Policy icon  on the IQ Server toolbar. Once you are in the Organization & Policies area, you’ll see all of your organizations displayed in the sidebar. Click the expander arrow next to an organization to view applications associated with that organization.

If you want to search for a specific organization or application, type a name into the filter box. After entering three characters, the sidebar is filtered automatically to display any matching applications and organizations. To remove the filter, click the "x" button next to the filter box.