Formula Contexts for Workforce Management

Formula contexts of different types define the formula's application-specific execution context. Control this context by setting context values for the formula. These contexts affect database item and formula function values. Usually, you set context values immediately before calling a formula.

You can now include context values in formula expressions, so you no longer have to set context values on entering a formula. You can test whether a context value is set, and modify the execution context of a formula in the formula.

Context Description
HWM_FFS_ID

Most workforce management functions use the unique fast formula session ID and rule ID as a key identifier for logs and work area related record processing.

For more details, see the next topic on Workforce Management functions.

HWM_SUMMATION_LEVEL

The summation level comes from the rule template page and indicates how to summarize time cards. This table describes the valid values.

Valid Value Description
DETAIL Process each record individually. Usually no summation is required.
DAY Sum and calculate values on a daily basis.
TIMECARD Sum and calculate values for the entire time card period.
HWM_RECORD_POSITION

The record position value indicates the type of record getting processed. This table describes the valid values.

Valid Value Description
DETAIL Detail record
END_DAY End of day record; enables day summation calculation
END_PERIOD End period record; the last record for the time card

The fast formula gets the time card records in this sequence, repeating the steps for each day of the time card period:

  1. Detail records for the time card day, sorted in a predefined order.
  2. End of day record for the day.

The end period record for the time card is the final record that the formula gets from the time card.

Note: Applies to nonAP formulas only. For AP formulas, use HWM_CTXARY_RECORD_POSITIONS in the 'Inputs Are...' parameter instead of HWM_RECORD_POSITION context.
HWM_RULE_ID The rule ID is the key for the rule currently getting processed. This key is used to get parameter values set in the rule and, in combination with HWM_FFS_ID, to store and retrieve work area values.
HWM_PROJECT_ID The project ID associated with the time card record currently getting processed.
HWM_RESOURCE_ID The resource ID or person ID associated with the time card record currently getting processed.
HWM_CTX_SEARCH_END_DATE The end date used to search for the relevant records to process.
HWM_CTX_SEARCH_START_DATE The start date used to search for the relevant records to process.
HWM_MEASURE_DAY The total measure for the time card day to use when processing records. Measure is a quantity, typically of hours, but it can also be units.
HWM_MEASURE_PERIOD The total measure for the time card period to use when processing records. Measure is a quantity, typically of hours, but it can also be units.
HWM_SUBRESOURCE_ID The subresource ID or assignment ID associated with the time card record currently getting processed.
HWM_CTX_PERIOD_END_DATE Date identifying the end of the time card period used to process records.
HWM_CTX_PERIOD_START_DATE Date identifying the start of the time card period used to process records.
HWM_ALLOCATION_DATA_LEVEL

The summation level comes from the allocation page and indicates how to summarize time entries for the allocation. This table describes the valid values.

Valid Value Description
DAY Sum and calculate values on a daily basis.
TIMECARD Sum and calculate values for the entire time card period.
HWM_ALLOCATION_ID The allocation ID is the key for the allocation currently getting processed.
HWM_ALLOCATION_RULE_ID

The allocation rule ID is the key for the time calculation rule currently getting processed. This key is used to get parameter values set in the rule and allocation. It's also used in combination with HWM_FFS_ID to store and retrieve work area values.

This ID is different from the normal rule ID because it refers to different conditions in the allocation definition. Each source that makes up an allocation has a different rule and rule ID.

HWM_ALLOCATION_START_DATE The date when the allocation becomes effective and the time calculation rule can use it.
GRP_TYPE_ID The ID for the group type associated with the worker time processing profile containing the rule that is currently processing time card records.
HWM_REPEATING_TM_PERIOD_ID The ID for the repeating period associated with the worker time processing profile containing the rule that is currently processing time card records.