Skip to main content

 

Planview Customer Success Center

IsResourceAvailableForFixedPeriod Function

IsResourceAvailableForFixedPeriod (user as ObjectIdentifier, period as String, overload as Numeric, loadType as String, state1 as ObjectIdentifier, state2 as ObjectIdentifier, ... as ObjectIdentifier) as Boolean

Category: Date
Description: Returns "FALSE" in the case that the specified User has a load greater than the Overload percentage during the specified Period for work items in the given states. Period is an optional variable that can be set to either 'y', 'm', 'q', or 'w', where 'w' is the default value. Up to five work item states can be specified, if not entered the query will run for all Active and Draft work items.
Supported Context: BusinessRules
Parameters:  
user as ObjectIdentifier(User) Represents a reference to a user object or a field that returns a user object
period as String An optional variable that represents the frame of time for which you would like to know the resource availability. Value can be either "d", "w", "m" corresponding to day, week, month. If null then the parameter value defaults to "w"
overload as Numeric Represents a numeric value that denotes the percent that is determined to be overloaded.
loadType as String Indicates whether to analyze load by either "PlannedWork" or "Remaining Effort"
state1 as ObjectIdentifier(State)

An optional parameter that represents the state of work items for which you would like to get reported hours, this parameter can be repeated for each work item state, or left as null for work items in state "draft" and "active"

  • Active
  • Cancelled
  • Completed
  • Draft
  • On Hold
state2 as ObjectIdentifier(State)

An optional parameter that represents the state of work items for which you would like to get reported hours, this parameter can be repeated for each work item state

  • Active
  • Cancelled
  • Completed
  • Draft
  • On Hold
... as ObjectIdentifier(State)

An optional parameter that represents the state of work items for which you would like to get reported hours, this parameter can be repeated for each work item state

  • Active
  • Cancelled
  • Completed
  • Draft
  • On Hold
Returned value as Boolean Returns a boolean value, where "TRUE" indicates that the user specified in the "user" parameter is available during the time frame specified in the "period" parameter
Example #1

Create a Scheduled Workflow Rule on the User that will run repeatedly every Monday morning, and send an email to a user's direct manager if the user is overloaded in the current week.

This will only check for resource availability on tasks that are "Active", "Draft", or "On Hold"

In the Evaluation Criteria enter the following:

IsResourceAvailableForFixedPeriod(currentuser(),"w",100, "Active", "Draft", "On Hold")

Tips This function has a parameter from type pick list that may have being customized by your organization. Please refer to the pick list values in the formula helper editor or view the values within the relevant field.