Follow
Understanding Text Mode
Linked to other articles. Do not move, rename or change url.
You can build a report in Workfront using the report builder, by using either the standard or the text mode interface. 

NOTE Use standard mode to ensure the reports you create remain intact when the Workfront software is updated. While text mode enables you to create more complex views, filters, and groupings, it is also more complicated to maintain and is not guaranteed when the Workfront software is updated. 

Before you start using text mode in your reports, we strongly recommend that you take our classes on advanced reporting, to gain a deeper understanding of our text mode language. 

Standard Mode Interface  

The standard mode interface is the interface that displays fields to map the application elements that you want to display on a report. The standard more interface is a set of drop-down menus from which you can select the fields you would like to display in your reports. 

For more information about the standard mode interface and to learn how to create a report, see "Creating a Report."

Text Mode  

Text mode enables you to create more complex views, filters, groupings, and prompts by allowing you to use fields that are not available in the standard mode interface. 

For a complete list of all our reportable fields, see the "API Explorer." 

NOTE Not all the fields available through the API are available through the text mode interface. If you happen to use the correct field in your text mode and you are not pulling the results you are expecting, then the field might only be reportable through the API. 

Accessing and Editing Text Mode  

This links to other articles, do not rename section.

Accessing the text mode interface is identical for views, groupings and filters.

Editing the text mode code inside views, filters and groupings has some differences outlined below.

Editing Text Mode in a View

We recommend that you build as much of the report as possible in standard mode, then convert the view to text mode to edit it. 

To access the text mode interface for a view:

  1. Find the report you want to modify in text mode.
    You must have manage permissions to a report in order to be able to edit it.
  2. Click Report Actions.
  3. Click Edit.
  4. On the Columns (View) tab of the report builder, select a column in the report.
  5. Click Switch to Text Mode in the upper-right corner of the report builder. 
    view_switch_to_text_mode.png
    The key lines in a text mode view are outlined in the following table:
    Sample Line Description

    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."

    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 will be:

    valuefield=More information

    NOTE: If you choose a field in text mode that is not valid in the standard interface, you are not able to switch back to the standard interface within the column.

    valueformat=  This line represents the format used to display the valuefield. The valueformat identifies whether an object or field displays as text, number, percentage, or date.

    valueexpression=

    You can add this line to replace valuefield, if you want to display a calculated field in the column. For example, if you want to display the field in a column in upper case, you would use: 

    valueexpression=UPPER({valuefield})

    You must enclose the valuefield of the objects in curly brackets every time you use it in a valueexpression. To add multiple valuefields by stringing them together, you must separate them by a period. For example, if you want to display the name of the Primary Assignee of a task using valueexpression, you would use:

    valueexpreesion={assignedTo}.{name}

    descriptionkey= / description=

    This line defines the text of a tool tip as you mouse over the name of the column. In this case it is using a key to translate the name value in the description text. If you want to modify the description, change this line to read: description=Your Value.
    namekey= / name=

    This line defines the column label. In this case it is using the abbreviated value based on the key.

    If you want to modify the column name you can change this value to: name=Your Value

    Name allows you to enter any text for the column name, whilenamekey requires you enter a key that is used to translate the name of a column.

    To change the column 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 suspends the namekey/ name value:

    displayname=Your Value 

    querysort= This line defines how the results are sorted when the column header is clicked. If it is not present then the column cannot be sorted after the report is run.
    width=

    This line represents the number of pixels that are used for the column. If the line is omitted or set to 0 (zero) then the column does not appear in the view. 

    When you modify this field manually in text mode, you should also add the usewidths=true value to your column. 

    makeFieldEditable=

    This line defines whether the value displayed in a column is inline editable or not. If this line equals true, the value in the column is inline editable. If this line equals false, the value in the column is not inline editable.

  6. Click Apply if you want to save your changes and continue editing the report.
    Click Save + Close to save your report.

 Editing Text Mode in a Filter

We recommend that you build as much of the filter of the report as possible in standard mode, then convert the filter to text mode to edit it. For more information about building filters, see "Creating and Customizing Filters."

To access the text mode interface for a filter:

  1. Find the report you want to modify in text mode.
    You must have manage permissions to a report in order to be able to edit it.
  2. Click Report Actions.
  3. Click Edit.
  4. On the Filters tab of the report, choose either Apply Existing Filter, or Add a Filter Rule.
  5. Define the condition of your filter. 
    Use the filter modifiers to define the condition of your filter. For more information about filter modifiers, see "Filter and Condition Modifiers."
  6. Click Switch to Text Mode in the upper-right corner of the report builder.
    filter_switch_to_text_mode.png
    Some filter modifiers are available only in text mode.
    When using filter modifiers that are available only in text mode, remember that for each filter condition you have two lines of code: one defines the condition and the second one defines the modifier of the filter.
    For example, if you want to filter for tasks where the name contains 'test' and you want this value to be case sensitive, your filter should look like the following, in text mode:
    name=test
    name_Mod=contains
    For a complete list of filter modifiers in text mode, see "Filter and Condition Modifiers."
  7. Click Apply if you want to save your changes and continue editing the report.
    Click Save + Close to save your report.

Editing Text Mode in a Grouping

We recommend that you build as much of the report as possible in standard mode, then convert the grouping to text mode to edit it. 

To access the text mode interface for a grouping:

  1. Find the report you want to modify in text mode.
    You must have manage permissions to a report in order to be able to edit it.
  2. Click Report Actions.
  3. Click Edit.
  4. On the Groupings tab of the report builder, choose either Apply Existing Grouping, or Add Grouping.
  5. 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.
  6. Click Switch to Text Mode in the upper-right corner of the report builder.
    grouping_switch_to_text_mode.png
    Each field in the grouping has several lines of code that refer to that field. 
    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: Four groupings are not supported in the report builder, outside of text mode.
    The key lines in a text mode grouping are similar to the fields available in views. The only lines that are not found in a grouping but are found in a view are width and isInlineEditable.
    A grouping cannot be edited in-line.
    For more information about the key lines in text mode in a view or grouping, see "Editing Text Mode in a View."
  7. Click Apply if you want to save your changes and continue editing the report.
    Click Save + Close to save your report.

Editing a Custom Prompt

Custom prompts can only be edited in text mode. 

For more information about creating a custom prompt, see "Creating a Custom Prompt."

Common Reasons to Use Text Mode

Outside of creating custom prompts which can only be configured using text mode, we recommend that you use the report builder to build your views, filters and groupings. However, there are some instances where you can use text mode to enhance your reports. 

Consider the following instances where you would use text mode instead of the standard interface:

Using Text Mode in Views

  • Display objects in a view that are not included in the standard mode interface. (Some objects can be included in a view only by referencing them via text mode.)
    You can know which fields can be included in a view in either of the following ways:
    • Use the "API Explorer" to discover other objects that can be referenced via text mode.
      Not all the fields documented in the API Explorer are valid fields for text mode. Some fields are only reportable through the API. 
    • A column or field name is not available in the standard mode interface, but the column or field ID is. Most objects that have a column or field ID also have a corresponding column or field name. However, in some cases, only the ID is displayed in the standard mode Interface. You can use text mode to include the column or field name in a view by replacing the fieldnameID with the fieldname:name.
      For example, in the standard mode interface, the Sponsor ID field is available for a project, but the Sponsor Name field is not. You can use text mode to display the Sponsor Name, if you switch the Sponsor ID column to text mode and replace the text in the column with: 
      valufield=project:sponsor:name
      querysort=project:sponsor:name
      valueformat=HTML
      displayname=Project Sponsor Name
      linkedname=project
      namekey=view.relatedcolumn
      namekeyargkey.0=project
      namekeyargkey.1=sponsorID
  • Make a calculation between two fields in a column. For example, if you want to find out the number of week days that elapsed between the Planned Completion Date and the Actual Completion Date of a task, you can use text mode syntax and data expressions to calculate this difference. To do this, you can add a new column to a task view, and Switch to Text Mode. In the Click to edit text dialog box, paste the following text: 
    displayname=Week Day Difference
    textmode=true
    valueexpression=WEEKDAYDIFF({plannedCompletionDate},{actualCompletionDate})
    valueformat=HTML
    For more information about calculated data expressions, see "Understanding Calculated Data Expressions."
  • Permanently edit the width of a column.
    You can change the width of a column by using these lines in the text mode of the column:
    width=100 
    usewidths=true
    NOTE: For the width line, pick any number (in pixels), depending on how wide you want the column to display in the report. 
  • Merge multiple columns into a single column.
    You can share the data from multiple columns to display it in one column, by adding a third column between them. The added middle column should have the following code in text mode:
    value=
    valueformat=HTML
    width=1
    sharecol=true
    You also have to add the following text to the first column:
    sharecol=true
  • Display a collection in a report view. A collection is a list of objects that are linked to one other object.
    For more information about displaying a collection in a report view, see "Referencing a Collection in a Report."

Using Text Mode in Filters

  • Create multiple filter rules that reference the same field.
    In the standard mode interface, when attempting to create multiple filters that reference the same field (using the AND qualifier), one of the filters is deleted when you save the report and exit the report builder.
    For example, Workfront does not allow you to save the following filter rules using the standard mode interface:
    Task Name > Contains > Green
    Task Name > Does Not Contain > Red
    However, you can create these filters using text mode:
    name=green
    name_Mod=cicontains
    AND:1:name=red
    AND:1:name_Mod=cinotcontains

Using Text Mode in Groupings

  • Group list results by a calculated value common to all the objects listed in the grouping.
    For example, you might want to view your tasks grouped by Percent Complete in ranges of 0-25, 26-50, 51-75, 75-99, and 100. Doing so would require using text mode for your grouping.
    The grouping that you want to use for this example is:
    textmode=true
    group.0.valueexpression=IF({percentComplete}>=0&&{percentComplete}<=25,'0-25%',IF({percentComplete}>25&&{percentComplete}<=50,'26-50%',IF({percentComplete}>50&&{percentComplete}<=75,'51-75%',IF({percentComplete}>75&&{percentComplete}<=100,'76-100%',''))))
    group.0.linkedname=direct
    group.0.valueformat=doubleAsString
    group.0.namekey=percentComplete
  • Add a fourth grouping in a standard report.
    Four_groupings_in_a_standard_report.png
    You can have four groupings in a matrix report. For more information about matrix reports, see "Creating a Matrix Report." 
    You can only have three groupings in a standard report through the standard interface. To add a fourth grouping in a standard report, you must use text mode.
    For example, you have a task report which is grouped by Project Name, Progress Status and Planned Completion Date. You want to add a fourth grouping, for Assigned To Name. You can do that, with the following code inside your grouping builder:
    group.0.linkedname=project
    group.0.namekey=view.relatedcolumn
    group.0.namekeyargkey.0=project
    group.0.namekeyargkey.1=name
    group.0.valuefield=project:name
    group.0.valueformat=string
    group.1.enumclass=com.attask.common.constants.ProgressStatusEnum
    group.1.enumtype=TASK
    group.1.linkedname=direct
    group.1.namekey=progressStatus
    group.1.type=enum
    group.1.valuefield=progressStatus
    group.1.valueformat=val
    group.2.groupdatesby=WY
    group.2.linkedname=direct
    group.2.namekey=plannedCompletionDate
    group.2.notime=false
    group.2.valuefield=plannedCompletionDate
    group.2.valueformat=atDateAsWeekString
    group.3.valuefield=assignedTo:name
    group.3.valueformat=HTML
    textmode=true
  • Rename groupings.
    You can rename groupings to something more familiar to your users. To do that, you can:
    - Remove all the lines in a grouping that have the word "name" in them.
    - Add the line: name=Your Value
    You can also leave the name line blank, in which case the grouping shows the name of the value you are grouping by. 

Examples of Views, Filters and Groupings Built in Text Mode

You can use the text mode of complex views, filters and groupings which have been built by Workfront. 

For more examples of already built text mode views, groupings and filters, see "Using Custom View, Filter and Grouping Samples."

Switching from Text Mode to Standard Mode

After you customize a report in text mode, you might not be able to switch back to standard mode. This is because not all fields that are supported in text mode are supported in standard mode.