TariffShark Tiger User Guide
Not your version?Symbols
There are several TariffShark features in which symbols get replaced with data values. Consider a Header Template as an example. [TRVDescription] is a commonly used symbol in a Header Template. When viewing such a Header Template's Word document, you will plainly see [TRVDescription] right there in the header. However, when editing or viewing the content of a TRV that uses such a Header Template, what appears instead of "[TRVDescription]" is the value of the TRV's Description (e.g. "Part II" or "Section 4").
Symbols are short words or phrases wrapped in square brackets. For example, [CompanyName] is a symbol that represents the name of a FERC-regulated entity whose tariffs you manage in TariffShark. This article defines all symbols available in TariffShark.
Not all symbols are available universally throughout TariffShark. Some symbols are available within certain features, but not in others. For a complete accounting of which symbols are available where, refer to Symbol Usage.
Symbols
| Symbol | Comments |
|---|---|
| [AssociatedFilingCompanyFERCFilingId] | The Id of a Filing's associated filing as filed with FERC. Used to populate XML element <filing_id> when the associated filing was filed. |
| [AssociatedFilingDocketNumber] | Docket Number of the Filing's associated filing. |
| [AssociatedFilingFERCFilingDate:FormatString†] | FERC Filing Date of the Filing's associated filing. |
| [AssociatedFilingFERCOrderDate:FormatString†] | FERC Order Date of the Filing's associated filing. |
| [AssociatedFilingStatusDescription] | Status of the Filing's associated filing. |
| [AssociatedFilingTitle] | Title of the Filing's associated filing. |
| [AssociatedFilingTypeCitation] | The citation of the Filing's associated filing's Filing Type (e.g. 154.204). Refer to FERC's Type of Filing Rules Table. |
| [AssociatedFilingTypeCode] | The Filing Type Code of the Filing's associated filing. Refer to FERC's Type of Filing Rules Table. |
| [AssociatedFilingTypeDescription] | The Filing Type Description of the Filing's associated filing. Refer to FERC's Type of Filing Rules Table. |
| [AssociatedFilingTypeDisplayName] | The multi-part display name of the Filing's associated filing's Filing Type (e.g. 570 Change In Rate Schedule, Forms Of Service Agreement, Or GT&C {Normal}). |
| [BasisTRV_Description] | Description of Basis TRV. |
| [BasisTRV_EffectiveDate:FormatString†] | Effective Date of Basis TRV. |
| [BasisTRV_FERCEffectiveDate:FormatString†] | FERC Effective Date of Basis TRV. |
| [BasisTRV_FERCFilingDate:FormatString†] | FERC Filing Date of Basis TRV. |
| [BasisTRV_FERCOrderDate:FormatString†] | FERC Order Date of Basis TRV. |
| [BasisTRV_FormattedSectionNumber] | Formatted Record Number of Basis TRV. |
| [BasisTRV_NarrativeName] | Narrative Name of Basis TRV. |
| [BasisTRV_OptionCode] | Option Code of Basis TRV. |
| [BasisTRV_ProposedEffectiveDate:FormatString†] | Proposed Effective Date of Basis TRV. |
| [BasisTRV_Title] | Title of Basis TRV. |
| [BasisTRV_Version] | Version of Basis TRV. |
| [CompanyFERCId] | FERC Company Id of the Company. |
| [CompanyName] | Name of the Company. |
| [CompanyProgramCitationDescription] | The description of the Company's Program. |
| [CompanyProgramCode] | The code associated with a Company's FERC Program. |
| [CompanyProgramDescription] | The description of a Company's FERC Program. |
| [CompanyProgramIndustry] | The industry associated with a Company's FERC Program. |
| [CompanyShortName] | Short Name of the Company. |
| [Context_ContentType] | Will have the value "clean" for clean TRV content and the value "marked" for marked TRV content. |
| [Context_TRVDisplayName] | Display Name of the TRV. |
| [Context_TariffRecordVersionId] | Id of the TRV. |
| [CustomField_"CustomFieldUniqueKey"††] | The value of the Custom Field identified by the Unique Key provided in place of "CustomFieldUniqueKey". For example, given a custom field whose Unique Key is "ABCD", the symbol used in a Publishing Template in order to output the Custom Field value would be [CustomField_ABCD]. Additionally, custom fields that represent date values require a format string†. |
| [DocketNumber] | Docket Number of the Filing. |
| [EffectiveDate:FormatString†] | Effective Date |
| [FERCAttachmentCode] | The FERC-assigned Code associated with a FERC Attachment. Refer to FERC's Type of Filing Rules Table where you'll find these identified with the column heading "ID". |
| [FERCAttachmentCodeCitations] | The citations associated with a FERC Attachment. Refer to FERC's Type of Filing Rules Table. |
| [FERCAttachmentCodeDescription] | The FERC-designated description of a FERC Attachment. Refer to FERC's Type of Filing Rules Table. |
| [FERCAttachmentDescription] | The Description of a FERC Attachment. |
| [FERCAttachmentFileName] | The file name of a FERC Attachment. |
| [FERCAttachmentSecurityLevelCode] | The FERC-designated code associated with a FERC Attachment's security level. Refer to FERC's table of Attachment Security Levels. |
| [FERCAttachmentSecurityLevelDescription] | The FERC-designated description of a FERC Attachment's security level. Refer to FERC's table of Attachment Security Levels. |
| [FERCEffectiveDate:FormatString†] | FERC Effective Date |
| [FERCFilingDate:FormatString†] | FERC Filing Date of the Filing. |
| [FERCOrderDate:FormatString†] | FERC Order Date of the Filing. |
| [FilingCompanyFERCFilingId] | The Id of a Filing as filed with FERC. Used to populate XML element <filing_id>. |
| [FilingDocketNumber] | Docket Number of the Filing. |
| [FilingFERCFilingDate:FormatString†] | FERC Filing Date of the Filing. |
| [FilingFERCOrderDate:FormatString†] | FERC Order Date of the Filing. |
| [FilingStatusDescription] | Status of the Filing. |
| [FilingTitle] | Title of the Filing. |
| [FilingTypeCitation] | The citation of the Filing's Filing Type (e.g. 154.204). Refer to FERC's Type of Filing Rules Table. |
| [FilingTypeCode] | The Filing Type Code of the Filing. Refer to FERC's Type of Filing Rules Table. |
| [FilingTypeDescription] | The Filing Type Description of the Filing. Refer to FERC's Type of Filing Rules Table. |
| [FilingTypeDisplayName] | The multi-part display name of the Filing's Filing Type (e.g. 570 Change In Rate Schedule, Forms Of Service Agreement, Or GT&C {Normal}). |
| [ProposedEffectiveDate:FormatString†] | Proposed Effective Date of the TRV. |
| [SupersededTRV_Description] | Description of Superseded TRV. |
| [SupersededTRV_EffectiveDate:FormatString†] | Effective Date of Superseded TRV. |
| [SupersededTRV_FERCEffectiveDate:FormatString†] | FERC Effective Date of Superseded TRV. |
| [SupersededTRV_FERCFilingDate:FormatString†] | FERC Filing Date of Superseded TRV. |
| [SupersededTRV_FERCOrderDate:FormatString†] | FERC Order Date of Superseded TRV. |
| [SupersededTRV_FormattedSectionNumber] | Formatted Record Number of Superseded TRV. |
| [SupersededTRV_NarrativeName] | Narrative Name of Superseded TRV. |
| [SupersededTRV_OptionCode] | Option Code Superseded TRV. |
| [SupersededTRV_ProposedEffectiveDate:FormatString†] | Proposed Effective Date of Superseded TRV. |
| [SupersededTRV_Title] | Title of Superseded TRV. |
| [SupersededTRV_Version] | Version of Superseded TRV. |
| [TariffDatabaseTitle] | Title of the Tariff Database within which publishing is being performed. |
| [TariffDescription] | Description of Tariff. |
| [TariffRecordTitle] | Title of Tariff. |
| [TariffTitle] | Title of the Tariff within which publishing is being performed. |
| [TRVDescription] | Description of TRV. |
| [TRVFormattedSectionNumber] | Formatted Record Number of TRV. |
| [TRVNarrativeName] | Narrative Name of TRV. |
| [TRVOptionCode] | Option Code of TRV. |
| [TRVSetName] | Name of a TRV Set. |
| [TRVTitle] | Title of TRV. |
| [TRVVersion] | Version of TRV. |
| [UITariffEnteredEffectiveDate:FormatString†] | The Effective Date entered into the Publish Tariff wizard's "Effective Date" step. |
| [UserEmailAddress] | Email Address of a TariffShark User. |
| [UserFullName] | The full name of a TariffShark User. |
| [UserName] | The Username of a TariffShark User. |
†A date field must be followed by a format string that tells TariffShark the format to use when inserting the date into the content block. Commonly used format strings are:
MMMM d, yyyy
Example formatted date: April 1, 2010
M/d/yyyy
Example formatted date: 4/1/2010
††Format strings must only be used on Custom Fields of type "Date" and "Required Date".
Format Strings
TariffShark's format string capabilities are fully documented in this Microsoft article.
Format String Examples
Using the FERCFilingDate field as an example, if a filing's FERC Filing Date was 7/29/2015, in a footer formatted with the symbol [FERCFilingDate:MMMM d, yyyy] it would appear in a Tariff Record Version footer as July 29, 2015.
For the Custom Field representing the creation date of a Tariff Record, with the Unique Key "TRCreatedDate" as an example. If a Tariff Record was created on January 1, 2019, in a footer formatted with the symbol [CustomField_TRCreatedDate:M/d/yyyy], the creation date would appear in the TRV's footer as "1/1/2019".