Edit text mode in a grouping
You can edit a grouping in a list or report using text mode to access fields that are not available in the standard interface and create more complex groupings.
Access requirements
You must have the following access to perform the steps in this article:
*To find out what plan, license type, or access you have, contact your Workfront administrator.
Prerequisites
Before starting to use text mode in a report or list, always ensure that you are familiar with the Workfront text-mode syntax.
For more information, see:
Edit text mode in a grouping
Editing a grouping using text mode is identical for reports and lists. Accessing the grouping from a report or from a list differs.
For more information about building groupings, see Create groupings in ÃÛ¶¹ÊÓƵ Workfront.
For information about creating a report, see Create a custom report.
-
Do one of the following:
-
To access the grouping from a report, go to the report, then click Report Actions > Edit > Groupings tab.
-
To access the grouping from a list, go to the list and from the Grouping drop-down menu, mouse over the grouping that you want to modify and click the Edit icon .
The grouping builder opens.
-
-
°ä±ô¾±³¦°ìÌý Add Grouping to add the groupings, then click Switch to Text Mode in the upper-right corner of the builder.
note tip TIP You can add up to 3 groupings in the standard interface. You can add a 4th grouping only using text mode, and you cannot have more than 4 grouping levels in Workfront. -
Start typing the name of a field that you want to group by.
Select the name of the field when you see it in the list.
-
Click Switch to Text Mode in the upper-right corner of the builder.
The grouping is then displayed in text mode.
When you edit a grouping in text mode, Workfront adds the
code language-none textmode=true
line of code to the grouping. This indicates that the grouping is modified in text mode.
Example: To group a list of tasks by the Project Name and then by the name of the Primary Assignee, your grouping should look like the following, in text mode.
code language-none textmode=true<br>group.0.linkedname=project<br>group.0.namekey=view.relatedcolumn<br><strong>group.0.valuefield=project:name</strong><br>group.0.namekeyargkey.0=project<br>group.0.namekeyargkey.1=name<br><strong>group.0.valueformat=string</strong><br>group.1.linkedname=assignedTo<br>group.1.namekey=view.relatedcolumn<br><strong>group.1.valuefield=assignedTo:name</strong><br>group.1.namekeyargkey.0=assignedTo<br>group.1.namekeyargkey.1=name<br><strong>group.1.valueformat=string</strong>
note important IMPORTANT The lines in bold are mandatory. Each field in the grouping has several lines of code that refer to that field.
The table below outlines the key lines in a text mode grouping.
note tip TIP The key lines in a text mode grouping are similar to the lines required to build text-mode views. table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 layout-auto Sample Line Description group.<number>. Each line of code is preceded by this text. The lines of code that refer to the same field selected in the grouping are numbered with the same number, as follows:
- The first grouping of the report has a group number of 0. All lines referring to the first grouping start with
group.0
. - The second grouping of the report has a group number of 1. All lines referring to the second grouping start with
group.1
. - The third grouping of the report has a group number of 2. All lines referring to the third grouping start with
group.2
. - Only in text mode, you can add a group number of 3, for a fourth grouping. All lines referring to the fourth grouping start with
group.3
.
Note: 4 groupings are not supported in the builder. They are only supported when using text mode. Workfront does not support more than 4 levels of groupings.
valuefield= This is the name of the object or of the field as it appears in the database. For more information about how objects and fields appear in the database, see API Explorer.
The following scenarios exist:
-
If the name of the field you display is a phrase instead of a single noun, you must use camel case syntax for the
valuefield
. For example, for the Planned Start Date of a task the code is:Example:
group.0.valuefield=plannedStartDate
-
If you want to display a custom field, the
valuefield
value is the actual name of the field, as you see it in the interface. For example, for a custom field named "More information", the code is:Example:
group.0.valuefield=More information
-
If you want to group by objects that are related to other objects using the
valuefield
line of code the object names and attributes are separated by colons.For example, a grouping by Portfolio Name for a task list has the following value for the valuefield line:
Example:
group.0.valuefield=project:portfolio:name
This indicates that from the object of the report (task), you can access the next related object (project); from there, you can access the following related object from project (portfolio); then the portfolio name (name).
For information about how objects connect to one another, see the section Interdependency and hierarchy of objects in Understand objects in ÃÛ¶¹ÊÓƵ Workfront.
Note: If you choose a field in text mode that is not valid in the standard interface and you switch to the standard interface, the grouping is deleted.
valueformat= This line represents the format used to display the
valuefield
. Thevalueformat
identifies whether an object or field displays as text, number, percentage, or date.We recommend using
HTML
for yourvalueformat
, especially when usingvalueexpression
, to ensure the most accurate display of your information.For information about additional values for this line, see Use conditional formatting in Text Mode.
valueexpression= You can add this line to replace
valuefield
, if you want to group your list by a calculation between several fields.You must enclose the
valuefield
of the objects in curly brackets every time you use it in avalueexpression
.The following scenarios exist:
-
If you want to display the name of a grouping in upper case, you would use:
Example:
group.0.valueexpression=UPPER({valuefield})
The
valuefield
of the object is spelled as it appears in the API Explorer. -
If you want to add multiple
valuefields
by stringing them together in avalueexpression
line, you must separate them by a period.For example, if you want to display the name of the portfolio in upper case in a task list, you would use the following code in the
valueexpression
line:Example:
group.0.valueexpression=UPPER({project}.{portfolio}.{name})
If you want to use a custom field in a
valueexpression
line you must precede the name of the field byDE:
to indicate that it is a custom field. The name of the field is spelled as it appears in the interface.Important: When you use a custom field that is placed in a custom form section that has restricted permissions for some users, the calculation of the
valueexpression
is blank when those users view this calculation in a report. For information about adjusting permissions on custom form sections, see Create a custom form.For example, if you have a custom field labeled "Developer Name" and you want to group by this field and display it in upper case, you can use the following
valueexpression
to indicate this:Example:
group.0.valueexpression=UPPER({DE:Developer Name}
)When referencing a Typeahead type custom field, use the following expression to reference the name of the object selected in a field labeled "Developer Name":
valueexpression=UPPER({DE:Developer Name:name})
namekey= / name= This line defines the grouping label. In this case it is using the abbreviated value based on the key.
If you want to modify the grouping name you can change this value to the following:
Example:
group.0.name=Your Value
Name
allows you to enter any text for the grouping name, whilenamekey
requires you enter a key that is used to translate the name of a grouping.To change the grouping name you can also add the
displayname
line, if one is not present.displayname = You can add the following line to change the name of a column, which overwrites the
namekey/name
value:Example:
group.0.displayname=Your Value
We recommend removing all the lines that contain
name
when you rename a grouping. - The first grouping of the report has a group number of 0. All lines referring to the first grouping start with
-
(Optional) Add one of the following lines of code to any grouping to indicate whether the results in the grouping should display in an expanded or collapsed list. By default, groupings display expanded:
code language-none group.0.iscollapsed=true
if you want the grouping to display with the results collapsed
code language-none group.0.iscollapsed=false
if you want the grouping to display with the results expanded
note tip TIP - When you manually adjust groupings when viewing a list, Workfront remembers your manual preference until you log out. When you log back in, the list displays according to this setting.
- The results of a grouping always display expanded after accessing them from a chart element.
-
Click Done if you want to save your changes and continue editing the grouping or report.
-
Click Save Grouping in a list or Save + Close to save your report.