Skip to main content

1E 9.x (on-premises)

Policies page

A description of the fields on the Policies page.

Here you can view the reclaim policies that have been published. You get to this page by clicking the AppClarity→Reclaim→Policies node in the navigation panel.

The fields on the Policies page are:

Policies

Field

Description

Compliance Repository selector

This field lets you select the repository where the compliance data displayed on the page comes from. By default this is set to Default Compliance.

If you have created your own compliance repositories, click on the name to select these from the drop-down list.

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 Policies Only toggle

The Active Policies Only toggle adds a filter when it's turned on that filters the table to only display the reclaim policies that have been published and their status is set to enabled.

Column Picker

Where the column picker control is shown Column Picker UI control icon you can choose which columns are displayed. In the following example on the Microsoft Core License Demand page we hide the Unknown Installs column and move the License Demand column to the left of the page.

APC_-_Microsoft_Core_License_Demand.png

To pick the displayed columns:

  • Click on the Choose columns icon Column Picker UI control icon to the right of the header row to view the visible columns.

APC_-_Choose_columns.png
  • To exclude Unknown Installs, select the Unknown Installs row and click Exclude columns button.

APC_-_Exclude_columns.png
  • The Unknown Installs column is now hidden.

APC_-_Excluded_columns.png
  • To move the License Demand column to the top of the list, hover your mouse over License Demand and using the direction control drag it to the top of the list.

APC_-_Change_column_order.png
  • The Microsoft Core License Demand page has now been automatically updated with our changes.

APC_-_Microsoft_Core_License_Demand_updated.png
Action buttons

The following table describes the action buttons displayed on the Policies page:

Button

Description

New Policy

Creates a new policy. Please refer to New Policy page for more details.

Edit

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

Edits the selected policy and opens the Edit Policy page. Please refer to New Policy page for more details.

Publish

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

Publishes the selected policies.

Clone

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

Clones the selected policy and opens the Edit Policy page with a clone of the details from the policy. Please refer to New Policy page for more details.

Move to Draft

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

Moves the selected policies to Draft.

Delete

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

Deletes the selected policies.

Manage Associations

Clicking this link navigates to Inventory→Manage Associations→Product to CM page in the Inventory application.

Export

Exports all the policies currently displayed in the Policies 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.

Policies table

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

Column

Description

Vendor

On the reclaim policy pages, this displays the vendor for the product the reclaim policy will be aimed at.

Title

On the reclaim policy pages, this displays the title for the product the reclaim policy will be aimed at.

Version

The version portion of the vendor, title, version and edition attributes that are used to identify software products. For example, 11.0.3216.5614 or 6.3.100.0.

Colloquial Version

The colloquial version name for the product. For example, 2003, 2016 etc. This is an additional attribute to the vendor, title, version and edition for a software product that may identify a range of versions.

Edition

On the reclaim pages in AppClarity an Editions column is sometimes displayed. This shows a list of editions that determine which products the reclaim policy will be aimed at.

Is Enabled

This column shows whether the Enabled checkbox has been set for the reclaim policy.

Used

Displays the action that will be taken by a reclaim policy for software with a usage category of used. Please refer to Usage categories for more details.

Rarely Used

Displays the action that will be taken by a reclaim policy for software with a usage category of rarely used. Please refer to Usage categories for more details.

Unused

Displays the action that will be taken by a reclaim policy for software with a usage category of unused. Please refer to Usage categories for more details.

Unreported

Displays the action that will be taken by a reclaim policy for software with a usage category of unreported. Please refer to Usage categories for more details.

Admin Actions

This link takes you to the Administration page for the reclaim policy. From there you can monitor the progress of the reclaim and respond to any end-user requests to opt-out of optional reclaim policies.

Mgmt Grp

Displays the Management Group the policy is associated with.

SCCM Collection Type

Displays the Configuration Manager collection type that will be used to manage the reclaims.

Savings Accrued

Displays the savings accrued to date as a result of running the reclaim policy.

Status

Indicates whether the policy is in published or draft state.

The following column actions are available on some table columns:

Column actions

Description

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:

  • Click on the sort icon S06_-_The_sort_icon.png just beneath the header row in the Cost column.

S01_-_Some_data_to_sort.png
  • The sort popup is displayed.

S02_-_The_sort_popup.png
  • Now select the sort direction. In our example this will be Sort descending.

S03_-_Selecting_Sort_descending.png
  • 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 S05_-_The_sort_descending_icon.png

S04_-_The_sorted_table.png

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.

F01_-_Some_data_to_filter.png

To filter the table on the Edition column:

  • Click on the filter icon F07_-_The_filter_icon.png just beneath the header row in the Edition column.

F02_-_The_Column_Filter_button.png
  • The filter popup is displayed.

F03_-_The_filter_popup.png
  • Now select the operator. In our example this will be contains.

F04_-_Selecting_an_operator.png
  • Then type the text Prof into the text field.

F05_-_Setting_the_filter_text.png
  • Click Apply and a new filter will be added to the table.

F06a_-_The_new_filter.png
  • The table will be filtered to just those items whose Edition contains the text Prof.

F06_-_The_filtered_table.png

Adding another filter

You can add another filter by clicking on the filter icon F07_-_The_filter_icon.png 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.

F02_-_The_Column_Filter_button.png

Removing filters

You can remove filters by clicking on the filter close icon F09_-_The_filter_close_icon.png at the end of the filter.

New Policy page

A description of the fields on the Reclaim Policies page.

Here you can create a Reclaim Policy for a specific product. You get to this page by any of the following ways:

  1. Clicking the Reclaim→Policies node in the navigation panel, then clicking the New Policy button

  2. Clicking on the Add Policy button on the side of a product entry in the Usage Summary page. If this method is selected the page will be pre-filled with the details of the product.

  3. Clicking on the Edit button on the Policies page. When this is done the Reclaim Policy page will be pre-filled with the contents of the selected reclaim policy.

  4. Clicking on the Clone link on the Policies page. When this is done the Reclaim Policy page will be pre-filled with the contents of the selected reclaim policy and when you subsequently click Draft or Publish a copy of the original reclaim policy will be saved including any changes you have made.

The fields on the Reclaim Policy page are:

230727099.png
Policy Summary

This table to the right shows you the information about the policy as you are building the policy or if you are editing a policy. This is useful because the policy pane is larger than can be seen on one screen. Each of these sections are hyperlinks to that specific area of the policy page.

Field

Description

Basic Information

Details about the Management Group, if the policy is enabled and if Over-ride is allowed

Product

Give Vendor, Title, Edition, Colloquial Version and Version for the software in the policy

Version Expansion

No details here, just a hyperlink to the Version Expansion area

Uninstall Criteria

Details each usage category and the action that Reclaimer will take

230727096.png
Basic Information
230727094.png

Field

Description

Management Group

This field displays a list of the current management groups, you can select all the management groups that you want this reclaim policy to apply to.

You must select at least one management group or set the reclaim policy to global.

Global

This checkbox determines whether the reclaim policy will be applied to all products matching the vendor, title, version and edition information regardless of which management groups they belong to.

Override Allowed

This checkbox is only displayed when the Global checkbox has been checked.

When Override Allowed is checked:

  • Subsequent reclaim policies for the same product can be defined in global and other management groups. Those policies will be warned on publishing that a similar policy is already present.

WhenOverride Allowedis unchecked:

  • Subsequent reclaim policies for the same product can still be published in global. Those policies will be warned on publishing that a similar policy is already present.

  • However, subsequent reclaim policies for the same product cannot be published in other management groups. Those policies will notified that asimilar policy for Global is already present which cannot be overridden and the publish will not be allowed to continue.

Enabled

This checkbox determines whether the policy is enabled or not, even if it is published. You can use this to disable policies that are no longer in use, or re-enable policies that have been disabled previously.

Product
230727092.png

Field

Description

Vendor

The vendor part of the vendor, title, version and edition for a product. This must be filled out before any other fields. Suggested suitable vendors that match your text are displayed as you type into the field, which you can select to auto-complete the entry.

Title

The title part of the vendor, title, version and edition for a product. Suggested suitable titles from the selected vendor that match your text are displayed as you type into the field, which you can select to auto-complete the entry.

Edition

Sets the edition for the product to be reclaimed.

This field displays a list of editions that match the selected Vendor and Title fields.

Note

You must ensure that you select at least one edition from theEditionlist. If the list showsNo edition available, then you must ensure that you select that option.

Colloquial Version

This field is optional and sets the colloquial version for the product to be reclaimed.

Note

When manually entering the information on the Reclaim Policy page you must enter the values in the order they are presented, as each subsequent field is dependent on the fields above it.

Version Expansion
230727093.png

Field

Description

Versions

Here you select the versions of the software you want the reclaim policy to apply to. Enter a value and then select one from the list of versions displayed. This is taken into account in addition to the vendor, title and edition.

This field accepts the asterisk character * as a wildcard. For example. This field could be set to:

  • * to specify all versions for the selected vendor, title and edition.

  • 11.* to specify all sub-versions of version 11.

  • 11.0.* to specify all sub-sub-versions of 11.0 and so on.

Version Expansion

This field will expand all the individual matching versions for the vendor, title, edition and version. The expansion is done according to the wildcards in the Versions string:

  • If that string contains no wildcards the Version Expansion field will contain a single entry for that specific version.

  • If the Versions string contains just an asterisk * then the Version Expansion field will contain all the versions for the selected vendor, title and edition.

  • If the Versions string contains a number followed by *, for example 11.*, then the Version Expansion field will contain all the versions starting with that number and so on.

There are four fields for each matching version row displayed in the Version Expansion field, as described in the following table:

Field

Description

Version

The expanded version number for this row

Edition

The matching edition for the vendor, title and version

Uninstall String

This string can be used if the version requires a custom uninstall string.

Note

The quick fill can be used to populate all uninstall strings and cost with the same information.

If the no custom uninstall string is required leave this field blank.

Currency

The currency for the cost. Default is US Dollar.

Cost

The estimated cost savings that would be made by retrieving the license covered by this reclaim.

Field

Description

Evaluate

Click this button to run the evaluation report for the reclaim policy to see which devices and software installations would be affected by the policy. Clicking this button creates a report that is downloaded by the browser as a TSV file.

Note

You may need to enable popups on the Tachyon site to enable the download to proceed.

Save draft

Click this button if want to save a copy of the policy you are currently working on. Clicking this button does not close the Reclaim Policy page.

Publish

Click this button to publish the policy.

Note

When you publish the policy a check will be made to see if it overlaps with any other existing policy. If it does, you will see a popup similar to the following:

230727090.png

If you decide to proceed with the publishing you will subsequently need to set the precedence for the policies to decide which one should be preferred. This is done on the Precedence page but can only be done for live policies. This means that you will have to refresh the reclaim consolidation report first, which can be done from the Policies page.

Cancel

Click this button to leave without making any changes to the policy.

230727095.png
SCCM Uninstall Collection Type

When you have the SCCM Uninstall Provider configured you are presented with an additional section in your Policy Summary. This will allow the Reclaimer to use the SCCM Uninstall for the Reclaimer. The Reclaimer will create a device collection, a user collection or one of each. Based on the setting in the picture below (from the policy). When the Reclaimer runs either the device or the user or both is added to the collection. The Reclaimer also creates deployments for the Program or the Application model for the uninstallation.

230727098.png
230727097.png
Administration page

A description of the fields on the reclaim policy Adminstration page.

Here you can view the current progress and status for the selected reclaim policy. You get to this page by clicking the AppClarity→Reclaim→Policies node in the navigation panel and then clicking on the Number link in the Admin Actions column.

The fields on the Administration page are:

Administration page

Field

Description

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
Vendor

Displays the vendor for the target product related to the selected reclaim policy

Title

Displays the software title for the target product related to the selected reclaim policy

Reclaims completed under this policy

This table shows the reclaims that have been completed by this reclaim policy. The columns of the table are as follows:

Column

Description

User rejected

Shows the number of reclaims where the user has requested to keep the product.

Failed

Shows the number of reclaims where the attempt to uninstall the software failed.

Succeeded

Shows the number of reclaims where the software was successfully uninstalled.

Reclaims in progress for this policy

This table shows the number of reclaims currently in progress for this reclaim policy. The columns of the table are as follows:

Column

Description

Optional

Shows the number of reclaim policies currently under way that allow the end-user to opt out of the reclaim.

Mandatory

Shows the number of reclaim policies currently under way where the software will be uninstalled without end-user interaction.

Reclaim Override Management

This table shows the reclaims that must be processed by the administrator. This is where the user has opted to keep the software and provided a suitable reason for it and that reason must be approved or rejected by the administrator.

The columns of the table are as follows:

Column

Description

Domain Name

The domain name for the target device.

Host Name

The host name for the target device.

Edition

The edition of the software being reclaimed.

Version

The version of the software being reclaimed.

Colloquial Version

The colloquial version of the software being reclaimed (if any).

Click User

The end-user who requested to keep the software.

Opt Out Reason

The reason given by the end-user why they should be allowed to keep the software.

Completed On

The time and date the administrator responded.

There are also two buttons below the table that determine the action to take on the selected rows in the table:

Button

Description

Accept

Clicking this means that the administrator has approved the end-user's reasons for keeping the software. The reclaim will not go ahead and the end-user will retain the software.

Reject

Clicking this means that the administrator has rejected the end-user's reasons for keeping the software. The reclaim will be changed to mandatory and the software will be removed without any further end-user interaction.

The three buttons above Accept and Reject

Icon

Name

Description

230727106.png

Toggle compact rows

Allows the rows to have slightly more space for easier viewing.

230727107.png

Toggle action buttons

Allows the action buttons (Accept and Reject) to be displayed as a hamburger menu only. This expansion of the table allows for easier viewing.

230727108.png

View fullscreen

Allows the table only to be viewed in the full browser window. Clicking the button while in fullscreen mode will collapse it back to default.

Column Picker UI control icon
Column Picker

Where the column picker control is shown Column Picker UI control icon you can choose which columns are displayed. In the following example on the Microsoft Core License Demand page we hide the Unknown Installs column and move the License Demand column to the left of the page.

APC_-_Microsoft_Core_License_Demand.png

To pick the displayed columns:

  1. Click on the Choose columns icon Column Picker UI control icon to the right of the header row to view the visible columns.

    APC_-_Choose_columns.png
  2. To exclude Unknown Installs, select the Unknown Installs row and click Exclude columns button.

    APC_-_Exclude_columns.png
  3. The Unknown Installs column is now hidden.

    APC_-_Excluded_columns.png
  4. To move the License Demand column to the top of the list, hover your mouse over License Demand and using the direction control drag it to the top of the list.

    APC_-_Change_column_order.png
  5. The Microsoft Core License Demand page has now been automatically updated with our changes.

    APC_-_Microsoft_Core_License_Demand_updated.png