Naming Rules

Overview

The Naming Conventions in Xrev Transmit can also define the Output Locations. Basically the tokens and text after the last backslash will define the file name. Please refer to the Output Locations section for examples of Naming Conventions and valid Revit Parameter tokens. Correct use of these will ensure you can set and forget all the settings in Xrev Transmit.

These placeholder tags have advanced functionality such as Alignment of values, Formatting of values, Prefix/Suffix to values, Nominating a value as optional, specifying a default value.

The full syntax is as follows:

<[Prefix]~NameSpace.ParameterName,Alignment:Format^Case[Suffix]?=DefaultValue>

You can just insert the ones you need, but they must be in this order.  For example, you can't put Default Value before the suffix.

Prefix / Suffix

A prefix/suffix value is not inserted if the parameter is blank and not used if a DefaultValue is specified.  Simply surround each Prefix/Suffix with Square brackets.  For example:

<[(]Revision[)]>

If my Revision was A the result would be:

(A)

If my Revision was blank nothing would be inserted.

Compress Whitespace

Insert a tilde character before the parameter name to remove any spaces from the parameter value.  For example:

<~Sheet.Name>

If my Sheet Name was "General arrangement plan" the result would be:

Generalarrangementplan

Formatting

Numeric and date parameters can be formatted in the placeholder using a Colon.

Example: Given the following variable and format specification:

<Date:yy-MM-dd>

if the date was 26 October 2014 then the result would be:

14-10-26

Example: Given the following variable and format specification:

<Number:000>

if the Number was 6 then the result would be:

006

Alignment

Using the alignment option you can pad out a value to a certain number of characters using spaces with a comma.

Example: Given the following naming rule:

<ProjectNumber>-<SheetNumber,10>(<Revision>) 

if Project Number was 1000, Sheet Number was A001 and Revision was A the result would be:

1000-      A001(A) 

However, if the alignment was -10 as follows:

 <ProjectNumber>-<SheetNumber,-10>(<Revision>)

then the result would be:

1000-A001      (A) 

Case

Use the case option to specify the desired case for a value.

Example: Given the following naming rule:

<ProjectName^Title>

If the Project Name is "TEST PROJECT" then the result would be:

Test Project

The following Case values can be used:

Optional Variables

If you want to use a parameter in a naming rule, but don't care if doesn't exist then you can simply add question mark.  This is very useful when using custom shared parameters or when some values are going to be blank.

Example: Given the following variable:

<Discipline?> 

If the Discipline parameter didn't exist in the project or was blank, the value would just be ignored.  If you didn't nominate this as optional, Xrev Transmit would consider the parameter not existing or being blank as an error.  This is to ensure file paths are always valid.

Default Values

Default Values are very useful to apply a value to input when the parameter value is blank.  Default Values ignore Prefix, Suffix and Format.

Example:  Given the following naming rule:

<ProjectNumber>-<SheetNumber>-<[(]Revision[)]=Not For Issue>

if my Revision was blank the result would be:

1000-A001-Not For Issue

Namespace

If you have two parameters with the same name in Revit then you can use the Namespace to differentiate between them.  For example, the parameter for the project's name is Name as is the parameter for the sheet's name.   You can use the namespace to pick between them by using:

<Project.Name> 

or

<Sheet.Name> 

Possible namespaces are Sheet, Project, Issue & System