About the job output settings
The job output indicates the actions that occur when a free or paid upgrade job is executed.
For free upgrades, you can either:
- Generate Poetic upgrade orders
- Generate an file containing order and shipping information
- Replace or mark entitlements
- Mark entitlements and machines or registration certificates as upgradeable
- Automatically upgrade machines or registration certificates
The Implement using dropdown determines whether the job generates Poetic upgrade orders, generates a shipping information file, or affects entitlements and machines or registration certificates. The default value is Entitlement replacement or marking.
For paid upgrades, the Implement using dropdown does not display. You can only mark entitlements and machines or registration certificates as upgradeable. Users must go through the activation process in order to present the proof of eligibility for the upgrade.
Configuring settings for Poetic upgrade orders
Indicating to generate Poetic upgrade orders
For a free upgrade, to indicate to generate upgrade orders, from the Implement using dropdown, select Poetic upgrade orders.
When you select the Poetic upgrade orders option, the Entitlement and Activation Options section is hidden and the Order Options section is displayed.
Setting shipping information for the Poetic upgrade orders
From the Ship to dropdown, select the method used to determine the ship-to for the upgrade orders.
| End customer recipient |
Ships the order to the appropriate end customer recipient based on the order aggregation method:
|
| Primary ship-to address | Ships the order to the primary ship-to address for the sold-to on the entitlement.
If the sold-to does not have a ship-to address, then the order is shipped to the first available ship-to address. If the sold-to does not have any ship-to addresses, then order is shipped to the primary contact for the sold-to. |
| Freight forwarding address |
Ships the order to the freight forwarding address for the sold-to on the entitlement If aggregating by entitlement, then uses the first available freight forwarding address for the end customer is used. If aggregating by group and sold-to or upgrade coordinator and sold-to, then uses the first available freight forwarding address for the sold-to. If the end customer or sold-to does not have a freight forwarding address, then uses the primary ship-to address. If there is no primary ship-to address, uses the first available ship-to address. If there is no ship-to address, uses the address of the primary contact. |
Determining the number of Poetic upgrade orders to generate
From the Aggregate by dropdown, select the option to determine the number of orders to generate. The available options are affected by the ship-to selection.
| Entitlement |
Creates one order for each eligible entitlement. So for example if 300 entitlements are eligible for the upgrade, then Poetic generates 300 orders. |
| Upgrade coordinator per group |
Creates one order for each combination of upgrade coordinator and group. This option is not available if you are shipping to the sold-to. If upgrade coordinators are configured for groups only, and not for product families, then this will result in one order per group. If upgrade coordinators are also configured for product families, then there may be multiple orders for a group, with each order containing only the entitlements for the assigned families. So for example:
If upgrade coordinators are at the family level, and there are different upgrade coordinators for family 1 and family 2, then Poetic generates 6 orders (3 groups, 2 different upgrade coordinators in each group). If upgrade coordinators are not at the family level, then there is only one upgrade coordinator per group, and Poetic generates 3 orders (1 for each group). |
| Upgrade coordinator per group and sold-to |
Creates one order for each combination of sold-to, upgrade coordinator, and group. This option is not available if you are shipping to the end customer recipient. So for example:
If upgrade coordinators are at the family level, and there are different upgrade coordinators for family 1 and family 2, then Poetic generates 12 orders (3 groups, 2 upgrade coordinators in each group, 2 sold-tos associated with the entitlements for each upgrade coordinator). If upgrade coordinators are not at the family level, then there is only one upgrade coordinator per group, and Poetic generates 6 orders (3 groups with 2 sold-tos per group). |
| Group |
Creates one order per group. This option is not available if you are shipping to the sold-to. So for example if 300 entitlements are eligible, but the entitlements are associated with only 5 different groups, then Poetic generates 5 orders. |
| Group and sold-to |
Creates one order for each combination of sold-to and group. This option is not available if you are shipping to the end customer recipient. For example, 300 entitlements are eligible. The entitlements have 5 different sold-tos. Each sold-to has entitlements assigned to 4 different groups. Poetic generates 20 orders. |
Handling order errors
The Error handling options indicate how Poetic should handle any errors in the generated orders.
To have Poetic continue if it comes across an error, check the Continue with errors check box.
If the box is unchecked, then Poetic stops generating orders when it finds the first error.
To save failed orders, check the Save failed orders check box. The orders can then be updated manually before being submitted. If the box is unchecked, then if the order fails, Poetic does not create it.
Setting billing information for the upgrade orders
To set the billing information for the upgrade orders: 1. In the PO number field, type the purchase order number to use for the orders. – From the Bill-to party dropdown, select the bill-to party for the order. The bill-to party is also used to determine the currency for the upgrade order:
| Bill the sold-to party |
The sold-to on the entitlement pays for the order. Poetic uses the first available bill-to for the s |
| Bill the publisher |
The publisher pays for the order. When you select this option, the list of publisher bill-tos displays. Click the radio button next to the specific publisher bill-to to use for the upgrade orders. |
Configuring order-related notifications for the Poetic upgrade orders
For the Order Tracking and Order Complete notifications, check the check box next to each party that should receive the notification.
Configuring settings for generating a shipping information file
Indicating to generate a shipping information file
For a free upgrade, to indicate to generate a file containing shipping and order information, from the Implement using dropdown, select Shipping information file.
When you select the Shipping information file option, the Entitlement and Activation Options section is hidden and the Shipping File Options section is displayed.
Setting shipping information for the file entries
From the Ship to dropdown, select the shipping address to record in the file:
| End customer recipient |
Uses the appropriate end customer recipient based on the order aggregation method:
|
| Primary ship-to address |
Uses the primary ship-to address for the sold-to on the entitlement. If the sold-to does not have a ship-to address, then it uses the primary contact for the sold-to. For the end customer recipient fields:
|
| Freight forwarding address | Uses both the primary ship-to address for the sold-to on the entitlement and a freight forwarding address.
For the freight forwarding address:
For the end customer recipient fields:
|
Determining the number of entries in the file
From the Aggregate by dropdown, select the option to determine the number of entries to add to the file. The available options are affected by the ship-to selection.
| Entitlement |
Creates one entry for each eligible entitlement. So for example, if 300 entitlements are eligible for the upgrade, then Poetic adds 300 entries to the file. |
| Upgrade coordinator per group |
Creates one entry for each combination of upgrade coordinator and group. This option is not available if you are shipping to the sold-to. If upgrade coordinators are configured for groups only, and not for product families, then this will result in one entry per group. If upgrade coordinators are also configured for product families, then there may be multiple entries for a group, with each entry containing only the entitlements for the assigned families. So for example:
If upgrade coordinators are at the family level, and there are different upgrade coordinators for family 1 and family 2, then Poetic adds 6 entries to the file (3 groups, 2 different upgrade coordinators in each group). If upgrade coordinators are not at the family level, then there is only one upgrade coordinator per group, and Poetic adds 3 entries to the file (1 for each group). |
| Upgrade coordinator per group and sold-to |
Creates one entry for each combination of sold-to, upgrade coordinator, and group. This option is not available if you are shipping to the end customer recipient. So for example:
If upgrade coordinators are at the family level, and there are different upgrade coordinators for family 1 and family 2, then Poetic adds 12 entries (3 groups, 2 upgrade coordinators in each group, 2 sold-tos associated with the entitlements for each upgrade coordinator). If upgrade coordinators are not at the family level, then there is only one upgrade coordinator per group, and Poetic adds 6 entries (3 groups with 2 sold-tos per group). |
| Group |
Creates one entry for each group. This option is not available if you are shipping to the sold-to. So for example if 300 entitlements are eligible, but the entitlements belong to only 6 groups, then Poetic adds 6 entries to the file. |
| Group and sold-to |
Creates one entry for each combination of sold-to and group. This option is not available if you are shipping to the end customer recipient. For example, 300 entitlements are eligible. The entitlements have 5 different sold-tos. Each sold-to has entitlements assigned to 4 different groups. Poetic adds 20 entries to the file. |
Setting the purchase order number for the file entries
In the PO number field, type the purchase order number to use in the shipping file.
Providing a prefix for the shipping file name
In the File prefix field, type a prefix to add in front of the file name for shipping files generated from this upgrade job. This allows you to easily find the files on the File Share.
Configuring settings to replace entitlements without making the machines or registration certificates upgradeable
For a free upgrade that does not generate orders, to automatically replace entitlements for the upgrade-from products with entitlements for the upgrade-to products, but not allow any upgrade activation, from the Entitlement actions dropdown, select Replace existing entitlements with upgraded entitlements.
Configuring settings to replace entitlements and generate a shipping file
For a free upgrade, to: – Automatically replace entitlements for the upgrade-from products with entitlements for the upgrade-to products, but not allow any upgrade activation – Generate a shipping file with upgrade order information from the Implement using dropdown, select Entitlement replacement and shipping file.
When you select this option, the Count-Based Subscription Options (if count-based subscription is supported) and Shipping File Options sections are displayed.
For information on configuring shipping files, see above.
For information on updating count-based subscription information, see.
Configuring updates to count-based-subscription information
If the instance supports count-based subscription (the Registry IS_COUNT_BASED_SUBSCRIPTION_SUPPORTED is true), the Count-Based Subscription Options section displays:
- For notification-only upgrade jobs
- For free upgrade jobs with an implementation method of Entitlement replacement and shipping file.
You use these options to determine whether to change the next delivery date and remaining deliveries for the eligible entitlements.
From the Next delivery date dropdown, select how to update the next delivery date and remaining deliveries for eligible entitlements. The available options are:
| Do not move the delivery date | When the job is run in execution mode, Poetic does not make any changes to the count-based subscription information for the eligible entitlements. |
| Move the next delivery date and decrement remaining deliveries |
When you select this option, the Move date by field is displayed. In the field, enter the number of days by which to move the next delivery date. When the job is run in execution mode, then on the eligible entitlements, Poetic:
For example, a customer is currently scheduled to receive their next update on January 1, 2010, and has 3 updates remaining. An upgrade job is created to provide the next available update. It is configured to move the next delivery date by 365 days and decrement the number of deliveries. After the job is run, the next delivery date is January 1, 2011, and the customer has 2 deliveries remaining. If the number of deliveries remaining becomes 0, meaning that the customer is no longer entitled to anymore updates, then:
|
| Move the next delivery date: do not decrement remaining deliveries | When you select this option, the Move date by field is displayed. In the field, enter the number of days by which to move the next delivery date.
When the job is run in execution mode, then on the eligible entitlements, Poetic:
For example, a customer is currently scheduled to receive their next update on January 1, 2010, and has 3 updates remaining. The publisher needs to notify customers that the next update has been delayed by a year. An upgrade job is created to send the notification and move the next delivery date by 365 days, but not change the number of deliveries remaining. After the job is run, the customer is scheduled to receive their next update on January 1, 2011, but still has 3 updates remaining. |
Configuring settings to make entitlements or machines or registration certificates upgradeable
Selecting the effect on entitlements and machines or registration certificates
For a free or paid upgrade that does not generate orders, from the Entitlement actions dropdown, select how entitlements and machines or registration certificates are affected by the upgrade job:
| Replace and mark entitlements – can upgrade activated items |
When the job is executed, the eligible entitlements for the upgrade-from products are replaced by entitlements for the upgrade-to products. To allow the activated items to be upgraded, any machines or registration certificates the entitlements were activated on are upgradeable. |
| Mark entitlements – can upgrade activated items and during new activation |
When the job is executed, the eligible entitlements for the upgrade-from products are marked as upgradeable. When users activate the entitlement, they have the option to activate either the current product or the upgrade-to product. Any machines or registration certificates the entitlements were activated on are also upgradeable. |
| Mark entitlements – can upgrade activated items only | When the job is executed, only the machines or registration certificates that the eligible entitlements were activated on are upgradeable. |
Selecting the activation mode
From the Activation mode dropdown, select the method used for upgrade activation.
| No activation |
If there is no upgrade activation required, select No activation. You would use this option if you are replacing existing entitlements without making the associated machines or registration certificates upgradeable. |
| Standard activation to the same machine |
To receive the upgrade, the customer must complete the entire upgrade activation process. For machine certificates, the user cannot change the locking IDs. |
| Standard activation to the same machine – locking IDs can change |
To receive the upgrade, the customer must complete the entire upgrade activation process, but can change the locking IDs. This option only applies to machine certificates. For registration certificates, this option works the same as the regular standard activation option. |
| Transaction complete only activation to the same machine |
To receive the upgrade, the customer must complete the upgrade activation, but does not need to specify any activation details. Only the Complete page is displayed. |
| Automatic activation to the same machine |
The activated items are upgraded automatically when the job is run. Poetic performs a batch activation to automatically upgrade the eligible machines or registratinon certificates. Poetic raises a separate batch activation event for each registered company reflected by the eligible machines or registration certificates. For example, if the job affects machines for 3 different registered companies, then Poetic raises 3 separate batch activation events. |
Allowing partial upgrades of activated items
To allow users to only upgrade a subset of upgradeable activated items on a machine or registration certificate, check the Allow partial upgrade of upgradeable activated items check box. You can only check this check box if the activation mode includes the standard activation process. For example, if a user has 10 seats of Version 1 installed on a machine or registration certificate, then if this check box is not checked, when they upgrade the machine or registration certificate, they must upgrade all 10 seats to Version 2. If the box is checked, they can for example upgrade only two seats to Version 2, and leave the remaining 8 seats on Version 1.
Allow trade compliance check
To conduct a trade check on entitlements marked for upgrade, check the Allow trade compliance check check box. You can only check this check box if:
- The Upgrade type is Free upgrade or Paid upgrade.
- The Implement using setting is Entitlement replacement or marking.
- The Entitlement action setting is Mark entitlements – can upgrade activated items and during new activation or Mark entitlements – can upgrade activated items only.