Text Mode in Filters

filters-collage

Topics

Collection Fundamentals (Filter)

A collection is a list of objects that are linked to another object. View Workfront’s help article about collections in a report for more about collections. The following procedure explains how collections are added to a filter or a report.

  1. View the API Explorer at https://developers.workfront.com/api-docs/api-explorer/
  2. Find the object you want to get the list of items relating to (project, task, issue, user etc).
  3. Click on the Collections tab.
  4. Click on the data type you want.
  5. Copy the API Key into the OBJECT text below:
  6. Click on the URL to the collection object and click on the field you want and copy the API Key in the FIELD text below.
  7. Select a modifier and copy into the MODIFIER text below. See modifiers here.
  8. Add the appropriate VALUE to the text below.
OBJECT:FIELD=VALUE
OBJECT:FIELD_Mod=MODIFIER

Filter Using Collections (Any Object w/ Custom Forms)

In a project, task, issue, etc. report, return records based on collection filters.

Specific Custom Forms (Tab Separate for Additional Forms)

objectCategories:categoryID=57d824c3008d6bacae266b9ced8043d9 588b5be100329eb0826ca868a2b40e1f
objectCategories:categoryID_Mod=in
filter-collection-custom-form

Templates With User in People Tab

templateUsers:userID=55e43af9004259899f1d7b274716e103
templateUsers:userID_Mod=in

Indent Number (Task)

Filter tasks by the indent number in the hierarchy. (Standard Mode-Compatible)

Top Level Tasks Only

indent=0
indent_Mod=eq

2nd Level Tasks Only

indent=1
indent_Mod=eq
task-indent

Comparing Fields

Examples of comparing two fields in a filter to determine results.

Native Fields: Planned Completion Date < Projected Completion Date

plannedCompletionDate=FIELD:projectedCompletionDate
plannedCompletionDate_Mod=lt

Custom Fields: Purchased > Used

DE:Purchased=FIELD:DE:Used
DE:Purchased_Mod=gt

Pending Approval

Show the records in a status that are pending approval by appending :A to the status code.

Single Status of Complete

status=CPL:A
status_Mod=in

Multiple Tab-Separated Statuses (Complete, In Progress)

status=CPL:A INP:A
status_Mod=in

Pending My Approval

In a task or issue report, show all results pending my approval due to:

My User ID

awaitingApprovalStepApproversMM:userID=$$USER.ID
awaitingApprovalStepApproversMM:userID_Mod=in

My Primary Job Role

awaitingApprovalStepApproversMM:roleID=$$USER.roleID
awaitingApprovalStepApproversMM:roleID_Mod=in

One of My Team(s)

awaitingApprovalStepApproversMM:teamID=$$USER.teamIDs
awaitingApprovalStepApproversMM:teamID_Mod=in

Approver being Project Owner (Wildcard) and I’m the Owner

awaitingApprovalStepApproversMM:wildCard=$$PROJECT_OWNER
awaitingApprovalStepApproversMM:wildCard_Mod=in
projectOwnerID=$$USER.ID
projectOwnerID_Mod=in

Approver being Project Sponsor (Wildcard) and I’m the Sponsor

awaitingApprovalStepApproversMM:wildCard=$$PROJECT_SPONSOR
awaitingApprovalStepApproversMM:wildCard_Mod=in
projectSponsorID=$$USER.ID
projectSponsorID_Mod=in

Approver is Assigned to Manager (Wildcard) and I’m the Manager

awaitingApprovalStepApproversMM:wildCard=$$MANAGER
awaitingApprovalStepApproversMM:wildCard_Mod=in
assignedTo:managerID=$$USER.ID
assignedTo:managerID_Mod=in

Multiple Filter Rules

<field>_Mod=notblank
AND:1:<field>=<value>
AND:1:<field>_Mod=notin

Leave a Reply