This preview feature exports entitlements from AppClarity 5.2 into a TSV file, which can then be reviewed and imported into AppClarity 6.1. The TSV export file is created in a specified location, and contains all the exported entitlements. After export, you will need to use the Entitlement .tsv connector to import them into AppClarity 6.1. See Entitlement import files reference page regarding structure and content of TSV files.

Before adding a new AppClarity v5.2 connector, you will need the following:

  • AppClarity 5.2 database access for the SLA Platform service account or a SQL Login
  • folder location with at least write access for the SLA Platform service account
On this page:

The AppClarity v5.2 connector is a preview for a forthcoming feature that will enable the migration of entitlements from AppClarity 5.2 so that they can be imported into AppClarity 6.1. We recommend that this feature is not used in a production environment and evaluated only in a lab environment.

Here are some of the limitations currently in place:

  • You must apply a hotfix to your existing AppClarity 5.2 installation in order to update a stored procedure used by the connector.
  • Only license and maintenance entitlement types are exported from AppClarity 5.2
  • Linked entitlements only support a single license with associated maintenance entitlements. For example, License1 is associated with Maintenance1, Maintenance2, Maintenance3 etc..
  • Files attached to contracts in AppClarity 5.2 are not exported or imported.
  • Management groups must exist in AppClarity 6.1 if they are referenced in any entitlements in AppClarity 5.2
  • Bundled entitlements are not supported for extended cases and may result in incorrect linking or export results. For example, when a single license is associated with multiple contracts or when a single maintenance is associated with multiple licenses and many more such cases.
  • AppClarity 5.2 unit cost values set in currencies other than the one set as default in AppClarity 6.1 (USD) will be converted to the default currency during import with a fixed exchange rate applied. If you have any entitlements using non-default currencies, then you will need to manually change the currency and unit cost after import.
  • There are some input value restrictions in AppClarity 6.1 that are not in AppClarity 5.2. For example, contract number is allowed as alphanumeric in AppClarity 5.2, but must be a number only in AppClarity 6.1. Issues should be highlighted as caveats during import, most of which you can resolve by editing any problematic entitlement.
  • Metric Type and Metric Name in AppClarity 5.2 do not map directly to Metric Type and Metric Other in AppClarity 6.1. Therefore you will see Invalid Metric Other caveat for every entitlement you import, unless the original Metric Type is Other. For Metric Type of Device, which is most common, you can publish directly without any concern. For remaining metric types, you can review before import, or correct after import.

After uploading exported entitlements in AppClarity 6.1, any entitlements with caveats will need to be be corrected before they can be published successfully.

The following AppClarity 5.2 entitlement fields are not supported by AppClarity 6.1. These are included in the export TSV file as extra information but are not imported.

  • Quantity & Metrics
    • Metric Name (Metric Name is imported as Metric Other only if Metric Type is Other)

    • Metric Description

  • Rights & Limitations
    • Limitations (OS, hostname, country, language, etc.)
  • Product Details
    • Entitlement Key
    • Channel Type
    • Product Family
    • Registration Key
    • Persistent ID
  • Audit & Exclusions
    • Audit penalty

See Entitlement import files reference page for supported import fields.

AppClarity v5.2 connector configuration

  1. In Name, enter a logical name for this connector.

    You should use a naming convention for connector names:

  2. In SQL Server, enter the name of the SQL Server instance where the AppClarity 5.2 database is hosted. If it is a named instance, append it to the server name, for example Server_Name\Instance.
  3. In Database, enter the name of the AppClarity 5.2 database, this is usually AppClarity.
  4. If you are authenticating with Windows Authentication:
    1. Ensure Trusted Connection is checked.
    2. You do not need to populate the User Id and Password fields.
  5. If you are authenticating with a SQL login:
    1. Ensure Trusted Connection is unchecked.
    2. In User Id, enter the name for the SQL login you want to use to connect to the database.
    3. In Password, enter the password for this login.
  6. In Folder Location, enter the location for where your exported TSV file will be written

    The folder location can be a folder on the SLA Platform server, or a remote share, which the SLA Platform service account has write access to.

  7. Click Save.

Test will confirm whether the SLA Platform service account, or specified SQL Login, can connect to the specified database instance.

It does not test the following.

  • If AppClarity 5.2 database access (including stored procedure) has been configured correctly
  • If the service account has write access to the specified folder location

It is only when you attempt to use the connector (create new action Sync Data) that you will experience an issue if these points are not addressed. Then you will find the export TSV file is not created, and not see any error or warning.

Additionally Test does not test if the stored procedure has been hotfixed.

AppClarity 5.2 database access

The connector requires a SQL login to exist in the AppClarity 5.2 database, with the following rights:

  • Explicit  Execute  permissions to the stored procedure dbo.APSP_ExportEntitlement

The above rights can be granted in any of the following ways:

  • If the connector is using Trusted Connection, then create a SQL login for the SLA Platform service account, and grant it the rights
  • If the connector is not using Trusted Connection, then create a login on the AppClarity database and grant it the above rights, and use this login as User Id and password