Summary

A description of the fields on the Agreements page.

Here you can view, edit, copy, create, publish and delete agreements. You can also export all the agreements in the selected repository to a TSV file. You get to this page by clicking the AppClarity→Entitlements→Agreements node in the navigation panel.

The fields on the Agreements page are:

Agreements page

FieldDescription

Report Refresh

You can refresh reports from individual AppClarity screens as well as using the Settings App. Where this is available you can do this by using the refresh icon next to the Last Refreshed box:

Report refresh control

Active Agreements only toggle

The Active Agreements only toggle adds a filter when it's turned on that filters the table to only display the agreements that have been published and not the ones that are in draft.

Status filters

The Status filters are displayed in the top-right of the page and let you filter the table according to the status of the items in the table.

Clicking on an icon filters the table to display only items with that status, as described in the following table.

IconDescription
Filters to show only items in Draft.
Filters to show only items in Draft with errors.
Filters to show only items in Draft with warnings.
Filters to show only items that are Published.

Column Picker

    MultiExcerpt named 'ColumnPicker' was not found
The page: Glossary was found, but the multiexcerpt named 'ColumnPicker' was not found. Please check/update the page name used in the 'multiexcerpt-include macro.

Agreements table

The following table describes the columns displayed in the Agreements table:

ColumnDescription
Vendor

The vendor portion of the vendor, title, version and edition attributes that are used to identify which software products the entitlement or agreement is for. For example, Microsoft Corporation or 1E.

You can sort and filter on this column.

Name

The name used for the agreement. For example, you might want to define an agreement that covers all your Microsoft Office and related products, so you could name the agreement Microsoft Office Agreement - 2018.

You can sort and filter on this column.

Number

Corresponds to the contract number, usually supplied on the customer contract.

You can sort and filter on this column.

Start Date

When the agreement starts to be applicable.

You can sort and filter on this column.

End Date

This is the last date the agreement is applicable until.

You can sort and filter on this column.

Cost

The cost of the agreement as arranged with the Vendor.

You can sort and filter on this column.

Management Group

Displays all of the management groups the software reclaim policy is associated with.

You can sort and filter on this column.

Identifier

Displays the Identifier information configured for the entitlement or agreement.


You can sort and filter on this column.

Displays the Parent, Associations and Children Links to other entitlements, agreements or contracts configured for the entitlement or agreement.

Status

The icon indicates the status of the entitlement or agreement:

IconDescription
Draft.
Draft with errors.
Draft with warnings.
Published.
...

Column actions

The following column actions are available on some columns in the table.

Column actionDescription
Column sort

Using column sorts


The picture opposite shows an example taken from AppClarity. In our example we want to sort the table on the Cost column from the highest cost at the top to the lowest at the bottom. To sort the table on the Cost column:

  1. Click on the filter icon just beneath the header row in the Cost column.

  1. The sort popup is displayed.

  1. Now select the sort direction. In our example this will be Sort descending.



  1. After selecting this the data in the table is now sorted on the Cost column from highest to lowest and the sort icon has changed to a sort descending icon .


Clearing the sort

You can clear the sort by clicking on the sort icon again and selecting the Clear sorting menu item from the sorting popup.

Column filter

Using column filters

The picture opposite shows an example taken from AppClarity. In our example we want to filter the table to show only those items where the Edition contains the text Prof.

To filter the table on the Edition column:

  1. Click on the filter icon just beneath the header row in the Edition column.

  1. The filter popup is displayed.

  1. Now select the operator. In our example this will be contains.



  1. Then type the text Prof into the text field.


  1. Click Apply and a new filter will be added to the table.


  1. The table will be filtered to just those items whose Edition contains the text Prof.


Adding another filter

You can add another filter by clicking on the filter icon for any of the columns. The picture opposite shows another filter added selecting table rows where the Type also contains the text License. The table will also be filtered accordingly.

Removing filters

You can remove filters by clicking on the filter close icon at the end of the filter.

Action Buttons

The following table describes the action buttons displayed on the Agreements page.

ButtonDescription
New Agreement
Creates a new agreement. See New Agreement page for more details.
Edit

This button is only enabled when there is a single selection in the Agreements table.

Edits the selected agreement and opens the Edit Agreement page. See New Agreement page for more details.

Publish

This button is enabled when there is at least one selection in the Agreements table.

Publishes the selected agreements.

Clone

This button is only enabled when there is a single selection in the Agreements table.

Clones the selected agreement and opens the Edit License or Edit Maintenance page, depending on the type of the selected agreement, with a clone of the details from the agreement. See New Agreement page for more details.

Move to Draft

This button is enabled when there is at least one selection in the Agreements table.

Moves the selected agreements to Draft.

Delete

This button is enabled when there is at least one selection in the Agreements table.

Deletes the selected agreements.

Export
Exports all the agreements currently displayed in the Agreements table as a TSV file. This button takes the filters currently applied to the table into account, but not the sorting or the current selection.