Conventions are available for some default Onshape properties and for all custom properties when creating export rules. Begin typing any letter into the Convention field to see a list of valid properties.

Note that:

  • Conventions use expressions in the form of ${<property-name>} to include an active metadata property in the naming convention.
  • Conventions use camel case, so if the rule name is Not revision managed, the convention rule is ${notRevisionManaged}.

  • Valid properties are shown in blue, while invalid and inactive properties are shown in red. Special characters may be added to the convention, for example, the colon and dash in: ${document.name}: ${partNumber} ‑${revision}

Part:

    appearance
    category
    description
    document.name
    excludeFromBom
    export.format
    export.resolution
    export.stlFormat
    export.timestamp
    export.units

    material
    name
    notRevisionManaged
    partNumber
    productLine

    project

    partStudio.category
    partStudio.description

    partStudio.name

    partStudio.notRevisionManaged

    partStudio.title1

    partStudio.title2
    partStudio.title3
    revision
    state

    tessellationQuality
    title1
    title2
    title3
    unitOfMeasure
    vendor
    workspaceOrVersion.name
    workspaceOrVersion.description
    workspaceOrVersion.category

Assembly:

    category
    description
    document.name
    excludeFromBom
    export.format
    export.resolution
    export.stlFormat
    export.timestamp
    export.units

    name
    notRevisionManaged
    partNumber
    productLine

    project
    revision
    state
    subassemblyBomBehavior
    title1
    title2
    title3
    unitOfMeasure
    vendor
    workspaceOrVersion.category
    workspaceOrVersion.description
    workspaceOrVersion.name

Drawing:

    approver
    category
    dateApproved
    dateDrawn
    description
    document.name
    drawnBy
    export.format
    export.timestamp
    inspectionCount
    lastChangedBy
    lastChangedDate
    name
    notRevisionManaged
    partNumber
    reference.appearance
    reference.category
    reference.description
    reference.excludeFromBom
    reference.material
    reference.name
    reference.notRevisionManaged
    reference.partNumber
    reference.productLine
    reference.project
    reference.revision
    reference.state
    reference.subassemblyBomBehavior
    reference.tesselationQuality
    reference.title1
    reference.title2
    reference.title3
    reference.unitOfMeasure
    reference.vendor
    revision
    revisionDescription
    state
    title1
    title2
    title3
    workspaceOrVersion.category

    workspaceOrVersion.description

    workspaceOrVersion.name

Part Studio:

    category
    description
    document.name
    export.format
    export.resolution
    export.stlFormat
    export.timestamp

    export.units
    name
    notRevisionManaged
    title1
    title2
    title3
    workspaceOrVersion.category
    workspaceOrVersion.description
    workspaceOrVersion.name

File:

    category
    description
    document.name
    export.format
    export.timestamp

    name
    notRevisionManaged
    partNumber
    productLine
    project
    revision
    state
    title1
    title2
    title3
    vendor
    workspaceOrVersion.category
    workspaceOrVersion.description
    workspaceOrVersion.name