Object State Update Profile Properties

Object state update profiles include the properties listed in Object State Update Profile Properties.

Table 1. Object State Update Profile Properties
Property Description
Name A unique object state update profile name.
Description A description of the purpose of the object state update profile.
External ID (Optional) Use this field to identify this item in MATRIXX pricing items. An External ID is saved to the pricing configuration file and loaded into the Pricing Database. Set the External ID value to any alphanumeric character that is meaningful to your implementation. An External ID can be used, for example, to relate offers in the MATRIXX system to products in an external pricing plan. It can be used, for example, by the Subscriber Management API to query and purchase product offers and bundle IDs.
Offer Owner Container The container for the offer owner (Subscriber/Group/Device object) that contains the custom MDC field where the date/time value is stored.
Offer Owner Date/Time Field The custom MDC field where the date/time value is stored.
Start Date/Time The date and time that the object state update profile is available in the system. The default is 2000-01-01 00:00:00.
Extension Type The time from which the date/time field value is extended. One of:
  • from_existing_time — Extends the date/time value from the current value in the custom date/time MDC field.
  • from_now — Extends the date/time value from the current date and time (now).
  • optimal — Extends from the existing object date/time field value if it is not in the past. Otherwise, extend from the current time (now). This option optimizes the date/time field extension.
  • optimal_offer_end_time — Extends the date/time value to the offer end time (plus some configured delay) if it is greater than the current date/time value. For example, if the offer end time plus the delay is greater than the current date/time field value, then the new date/time field value is equal to the offer end time plus the delay. Otherwise, the date/time field value is not modified.
  • optimal_cycle_end_time — Extends the date/time value to the cycle end time (plus some configured delay) if it is greater than the current date/time value. For example, if the cycle end time plus the delay is greater than the current date/time field value, then the new date/time field value is equal to the cycle end time plus the delay. Otherwise, the date/time field value is not modified.
  • optimal_before_offer_end_time — Extends the date/time value to some time units before the offer end time if the new date/time value is greater than the current date/time value. For example, if the offer end time minus the extension count is greater than the current date/time field value, then the new date/time field value is the offer end time minus the extension count. Otherwise, the date/time field value is not modified.
  • optimal_before_cycle_end_time — Extends the date/time value to some time units before the cycle end time if the new date/time value is greater than the current date/time value. For example, if the cycle end time minus the extension count is greater than the current date/time field value, then the new date/time field value is the cycle end time minus the extension count. Otherwise, the date/time field value is not modified.
Extension Amount The number of time units to extend the date/time field's end time. For example, to extend the end time by two weeks, enter 2 and in Extension Units, select Weeks.
Extension Units The time unit to use when extending the date/time field's end time. One of:
  • Minutes (default)
  • Hours
  • Days
  • Weeks
  • Months
  • Years

For example, to extend the end time two days, enter 2 in Extension Amount and select Days in Extension Units.

Limit Amount The number of time units to limit the date/time value. The new date/time value cannot be greater than the current time (now) plus the limit amount. For example, to limit the end time by 24 months, enter 24 and in Limit Units, select Weeks.
Limit Units The time unit to use when limiting the date/time field's end time. One of:
  • Minutes (default)
  • Hours
  • Days
  • Weeks
  • Months
  • Years

For example, to limit the new date/time value to no greater than now plus 24 months, enter 24 in Limit Amount and select Months in Limit Units.

Extension Limit Policy The policy for handling extension limits. Choose from the following:
  • allow_limited_extension — Allow the extension up to the specified limit. This is the default.
  • deny_limited_extension — Deny any extension if the specified limit is exceeded.
Reduction Policy The policy to handle reductions in the date/time field value. For example, whether the new date/time value can be less than the current field value. Choose from the following:
  • allow_reduction_up_to_now — Allow the reduction of the current date/time field value up to the current time. This is the default.
  • deny_reduction — Deny any reduction of the current date/time field value.
Time Adjustment Type Specifies whether to extend the time portion of the date/time value in the custom MDC field. Choose from the following:
  • no_change — Keep the time setting of the date/time field value. This is the default.
  • end_of_day — Extend to end of the day.
  • absolute_time — Extend to the time specified in this profile. Enter the time in the format hh:mm:ss. The default time is 00:00:00.