Configuring eligibility criteria for the upgrade job


About selecting the eligibility criteria

Selecting the type of selection criteria

Selecting the eligible countries, programs, machines or registration certificates, and companies for the job

Selecting the eligible products for notification only jobs

Providing eligibility criteria for count-based subscriptions

Configuring license entitlement criteria

Configuring maintenance entitlement criteria

Providing the list of eligible entitlements


About selecting the eligibility criteria

The Selection tab of the Automated Upgrade Job Maintenance page allows you to set criteria, in addition to the upgrade-from products on the Mapping tab, for eligibility to receive the upgrade.

Selecting the type of selection criteria

From the Selection based on dropdown, select the criteria to use to determine the eligible entitlements. The options are:

License with linked maintenance Used to upgrade license entitlements for license upgrade-from products.

When you select this option, the License Entitlement Criteria and Maintenance Entitlement Criteria sections display.

Eligible license entitlements must:

  • Match the country, program, and company criteria
  • Match the license entitlement criteria
  • Be linked to maintenance entitlements that match the country, program, company, and maintenance entitlement criteria
License with related product line level maintenance at company level Used to upgrade license entitlements for license upgrade-from products.

When you select this option, the License Entitlement Criteria section displays.

Eligible entitlements must:

  • Match the country, program, and company criteria
  • Match the license entitlement criteria

The company also must have active maintenance entitlements for the same product line.

License without related product line level maintenance at company level Used to upgrade license entitlements for license upgrade-from products.

When you select this option, the License Entitlement Criteria section displays.

Eligible entitlements must:

  • Match the country, program, and company criteria
  • Match the license entitlement criteria

The company cannot have any active maintenance entitlements for the same product line.

License with related product line level maintenance at group level Used to upgrade license entitlements for license upgrade-from products.

When you select this option, the License Entitlement Criteria section displays.

Eligible entitlements must:

  • Match the country, program, and company criteria
  • Match the license entitlement criteria

The group must have active maintenance entitlements for the same product line.

License without related product line level maintenance at group level Used to upgrade license entitlements for license upgrade-from products.

When you select this option, the License Entitlement Criteria section displays.

Eligible entitlements must:

  • Match the country, program, and company criteria
  • Match the license entitlement criteria

The group cannot have active maintenance entitlements for the same product line.

Maintenance entitlements Used to upgrade license entitlements that are linked to maintenance entitlements for maintenance upgrade-from products.

When you select this option, the Maintenance Entitlement Criteria section displays.

Eligible maintenance entitlements must:

  • Match the country, program, and company criteria
  • Match the maintenance entitlement criteria
License entitlements Used to upgrade license entitlements for license upgrade-from products.

When you select this option, the License Entitlement Criteria section displays.

Eligible entitlements must:

  • Match the country, program, and company criteria
  • Match the license entitlement criteria
Products only Used to upgrade license or maintenance entitlements for license or maintenance upgrade-from products.

When you select this option, no additional sections are displayed.

Eligible entitlements must match the country, program, and company criteria.

Loaded list of entitlements Used to upgrade license entitlements from a list provided in a flat file. To use this option, the Registry CAN_UPGRADE_FROM_LOADED_ENTITLEMENT_FILE must be True.

When you select this option:

  • The country, program, and company criteria fields are removed.
  • The Entitlement list file field is displayed.

If you do not provide upgrade-from products, then Poetic automatically upgrades all of the entitlements in the file.

Otherwise, Poetic upgrades the entitlements that match the upgrade-from products.

Selecting the eligible countries, programs, machines or registration certificates, and companies for the job

Selecting the eligible countries

You can restrict the eligible entitlements based on the country where the end customer is located:

Selecting the eligible programs

You can also restrict the eligible entitlements based on the program. Only entitlements created under the selected programs are eligible.

To add a program to the list, select the program from the Program dropdown, then click Add to List. The program name appears in the text box below the Program dropdown.

To clear the list of programs, click Clear List.

Providing the list of eligible machines or registration certificates

If you are marking machines or registration certificates as upgradeable or sending notifications, then you can provide a list of the eligible machines or registration certificates. The list can either be:

When you upload a file, Poetic:

To upload the file:

  1. Click Select Machine File.

    The Select Machines to Upgrade form displays.

  2. To load a comma-separated list of locking IDs, from the Input by dropdown, select File simple load.

    To load a list of machine or certificate names, from the Input by dropdown, select File complex load.

  3. Click Browse to search for and select the file.
  4. After selecting the file, click Load.

    The file content is displayed in a text area below the file name.

  5. If the list is correct, click Continue.

    On the Selection tab, Poetic replaces the field with the name of the loaded file.

To clear the uploaded file, click Clear.

Selecting the eligible companies

The eligible entitlements can also be restricted based on the end customer. You can either:

On the Select Companies form:

  1. Click Add Companies.
  2. On the Search Companies form, provide search criteria, then click Search Companies.
  3. In the search results, check the check box next to each company to add to the list.
  4. Click Select checked companies.

    The selected companies are added to the list on the Select Companies form.

  5. To clear the list of companies, click Clear List.
  6. When you have finished selecting the list, click Continue.

On the Selection tab, to clear the list of selected companies, click Clear Field.

NOTE: When an upgrade job is exported, Poetic uses the company pub IDs to list the selected companies. If a company does not have a pub ID, it is not included in the export.

Selecting the eligible products for notification only jobs

For notification only jobs, there are no upgrade-from products. Instead, a Product # field is added to the Selection Criteria section.

You can either:

On the Select Products form:

  1. Click Add Products.
  2. On the Search Products form, provide search criteria, then click Search Products.
  3. In the search results, check the check box next to each product to add to the list.
  4. Click Select checked products.

    The selected products are added to the list on the Select Products form.

  5. To clear the list of products, click Clear List.
  6. When you have finished selecting the list, click Continue.

Note that if product security categories are used (Registry IS_PRODUCT_SECURITY_CATEGORY_SUPPORTED is true), you can only select products that belong to a security category that you can view.

On the Selection tab, to clear the list of selected products, click Clear Field.

Providing eligibility for count-based subscriptions

The Count-Based Subscription Criteria section displays if:

The section allows you to provide eligibility criteria based on the next delivery date and remaining deliveries on the entitlements.

From the Next delivery date dropdown, select the option for determining whether an entitlement is eligible based on its next delivery date. The options are:

When the job is run, Poetic does not use the next delivery date to determine eligibility for the upgrade job.

Not applicable
Before or on the run date When the job is run, Poetic looks for entitlements with a next delivery date that occurs on or before the current date.

For example, if the job is run on June 1, then only entitlements with a delivery date on or before June 1 are affected.

On or prior to X days before the run date When you select this option, the # of days field displays to allow you to provide the number of days before the run date.

When the job is run, Poetic looks for entitlements with a next delivery date that occurs before or on the specified number of days before the current date.

For example, a job is configured to process entitlements with a next delivery date up to 30 days before the run date.

When the job runs on June 30, only entitlements with a next delivery date on or before June 1 are included.

Before or up to X days after the run date When you select this option, the # of days field displays to allow you to provide the number of days before the run date.

When the job is run, Poetic looks for entitlements with a next delivery date that occurs up to the specified number of days after the current date.

For example, a job is configured to process entitlements with a next delivery date up to 60 days after the run date.

When the job runs on June 1, entitlements with a next delivery date any time before July 30 are included.

Configuring license entitlement criteria

The License Entitlement Criteria section displays if your selection criteria includes licenses. When the job runs, Poetic uses these criteria to select the eligible license entitlements.

Entitlement type From the Entitlement type dropdown, select the type of license entitlement (permanent, termed, etc.) to include in the job.
Status From the Status dropdown, select the status of the eligible license entitlements.
Create date In the Create date fields, type the beginning and end dates of the range of dates in which eligible license entitlements were created.

For example, to only include entitlements created between January 1, 2004 and July 31, 2004, you would type Jan 1, 2004 in the first field and Jul 31, 2004 in the second field.

Not expiring before In the Not expiring before field, type the date after which eligible license entitlements can expire.

For example, to only include entitlements that expire after July 31, 2004, you would type Jul 31, 2004 in the field.

Entitlement support end date In the Entitlement support end date field, type the entitlement support end date range.
Entitlement ISV Property (#1 to #20 Enter or select values for the defined entitlement custom properties.

Configuring maintenance entitlement criteria

The Maintenance Entitlement Criteria section displays if your selection criteria includes maintenance. When the job runs, Poetic uses the maintenance criteria to select the eligible maintenance entitlements.

Status From the Status dropdown, select the status of eligible maintenance entitlements.
Create date In the Create date fields, type the beginning and end dates of the range of dates in which legible maintenance entitlements were created.

For example, to only include maintenance entitlements created between January 1, 2004 and July 31, 2004, you would type Jan 1, 2004 in the first field and Jul 31, 2004 in the second field.

Not expiring before In the Not expiring before field, type the date after which eligible maintenance entitlements can expire.

For example, to only include entitlements that expire after July 31, 2004, you would type Jul 31, 2004 in the field.

Providing the list of eligible entitlements

If the selection criteria option is Loaded list of entitlements, then all of the other fields are replaced by an Entitlement list file field. You use this field to upload a file containing the list of entitlements.

The file can be a comma- or line return-separated list of entitlement IDs.

When you upload a file, Poetic:

To upload the file:

  1. Click Browse to search for and select the file.
  2. After selecting the file, click Load to load the file.

    Poetic replaces the field with the name of the file, and copies the file to the upload directory.

To clear the uploaded file, click Clear.