Accolade Field Codes Overview

Add text strings (field codes) to file-based, project level documents and to online forms. When a user downloads or opens a document or form that contains field codes, the inserted codes are replaced with the current data from Accolade, such as a metric's current value or the name of the document's project. Field codes only work for documents that are uploaded into Accolade either manually or through the Save to Accolade feature or for online forms such as idea forms. Data does not refresh if the document version is created as a link to an external document.

Most field codes also work in project-level reports. Depending on what data is to be displayed, some Accolade fields can be added to reports. More kinds of codes can be successfully added to project-level reports than can be added to reports displayed on the Charts & Reports page, because most Accolade fields display information related to a specific project, the report needs to be associated with a single project to display the correct information. Project-level reports are associated with a specific project, while reports on the Charts & Reports page are not.

See Accolade Field Codes Reference for additional information about the types of data you can display and for a list of field codes.

File-Based Field Code Format

Field codes in documents have the following basic pattern: {*source:name*}, where source identifies the general type of data displayed and name identifies the specific data. Data sources include metadata about a document, project, or document owner; custom names used at your company, images, reference table cells, and metrics. Field codes are not case sensitive.

The source identifies a group of codes that all display data that is from a similar location or used for a similar purpose. The available sources include:

  • IMAGE - Displays images. Enter codes with the Image source in the Format (object) dialog box of an object or picture inserted in the document. See Adding Images to Documents Using Accolade Field Codes.
  • CONFIG - Displays the custom names of some terms.
  • MD - Displays metadata, additional data about a project, deliverable, gate, or activity. Metadata codes only work in their respective document types. For example, if you place an activity code in a gate document, no data displays as the gate document is not identified with an activity.
  • REFTABLE - Displays the value in an Accolade reference table cell.
  • CHART - Displays a specified chart created in Accolade.
  • QUICK GRID - Displays a specified quick grid created in Accolade.
  • QUICK GRID ELEMENT - Displays a specified cell from a specific quick grid created in Accolade.
  • REPORT - Displays a specified report created using Accolade Online Reporting.
  • METRIC - Displays the metric's value. Metric codes have additional, optional elements that can change what the field displays and how it behaves. A metric code with two of these additional options has this pattern: {*metric:name option option*}.
  • POD - Displays a specified pod within a layout or custom project page.
  • FLAG - Flags a slide as a specific type or assigns an action.
  • PORTFOLIO SUMMARY - Tags a slide for the specific use in a portfolio presentation. Will contain portfolio information specified by the tag. See Creating Portfolio Presentation Templates.
  • MATRIX METRIC - Displays a specified matrix metric created in Accolade. Only available for use in PowerPoint.
  • RICH TEXT MATRIX METRIC - Displays a specified matrix metric containing rich text created in Accolade. Only available for use in PowerPoint.
  • RICH TEXT METRIC - Displays a specified metric containing rich text created in Accolade. Only available for use in PowerPoint.
Example Icon
  • {*MD:ProjectDescription*} - Displays display the description of the document's project.
  • {*CONFIG:Deliverable*} - Displays the custom name used at your company for the term "deliverable."
  • {*METRIC:NPV*} - Displays the value of the metric whose system name is NPV.
  • {*METRIC:StyleOptions #ListItems_Pipe*} - Display the items in a List metric whose system name was StyleOptions.
  • {*FLAG:RepeatForSelectedProjects*} - Repeats the slide that this field code is one, once for each project selected.

The name is the name of the data that the individual code displays. For example, an "MD" code displays metadata. The MD code using the name "ProjectID" displays the project's ID. The complete code is {*MD:ProjectID*}.

Online Form Field Code Format

Substitution tokens in online formats have the following basic pattern: *{name}*, where name identifies the specific data. Field codes are not case sensitive. For example, *{ProjectDescription}* displays the description of the document's project. Online form field codes are limited to project data, and do not include information such as custom names and metrics.

Behavior

The downloaded data from Accolade replaces the code itself within the document, but its effect on other information varies depending on the application:

Microsoft Application Field Code Replacements

Word

Downloaded data replaces the code, leaving text surrounding the code unchanged.

Excel

Downloaded data replaces all content in the cell that contains the code. Add only one code per cell.

PowerPoint

Downloaded data replaces all text in the shape that contains the code. Add only one code per shape.

Notes: