Introduction

BIMXtra Role

Requires Superuser or Schedule Edit Config role to access.

Schedule Configuration is a key area in your BIMXtra project setup that determines many behaviours and aspects and should be given appropriate consideration.

Please ensure you take note of Schedule column configuration rules.

Schedules are configured in two main places:

  1. The schedules that are to be used on the project, and some formatting settings are configured in the project configuration > components / schedules section:

       

  2. The schedule configurations themselves are then set in project configuration > Schedules menu.



Components / schedules section

Schedule Selection

Turn the Schedules On/Off for the current project.

Default schedules are provided for many categorisations and you can configure which of those schedules you want to use and have visible.

The grouping and Names of the schedules can be configured in the Customtisation Menu.

Design schedule

Use this tool to bulk copy all schedule configurations from another project into your current project.

Select a project and click Apply to copy all schedule configurations.

Use Reset to revert schedule configurations back to default.



Schedule column configuration rules

The following rules and conditions must be adhered to for correct BIMXtra behaviour across the system:

Mandatory columns

** IMPORTANT Mandatory column visibility requirement is removed in v3.10 and columns can now be turned off if preferred **

There are 6 columns that are mandatory for various automatic functions of the system to be fully operational.  These columns may be turned off in the schedules, if functionality is not required.

These columns affect, and are referenced by automated parts of the system e.g.: 

  • COBie export references all these values in its export file creation.

  • Forms can be defined that pick up these data elements from objects and the construction page has these fields as filters.

  • Insight can refer to these objects for loading and highlighting.

  • O&M pages refer to these fields to structure and filter uploaded docs via the upload wizard.

  • Location Data lists used in Forms

The column's FriendlyName and Headers can be edited as required in your projects.

The Mandatory Fields are:

  • System - defines the system which can be seen and highlighted in Insight

  • Name

  • Number

  • Building

  • Level

  • Department

Reserved UserFriendlyName values

** IMPORTANT **
Each schedule column can be given a user defined UserFriendlyName.  Each UserFriendlyName must be unique in the schedule.

Please do not use the following for your UserFriendlyName values:

  • Any BIMXtra System Name of a schedule column, as listed in the  first column of the .xls schedule config file.

  • Any System Information name as seen in the Insight Object Data Tab (category 6).  These include:

    • Category

    • Easting

    • Handle

    • Materials

    • Model

    • Name

    • Northing

The schedule configuration .xls is checked on upload and will fail if any of these values, or any duplicate values, are used.

Admin controlled columns

** IMPORTANT **

Schedules also contain system reference fields that are presently not able to be edited by super users.  If you require an edit to these fields please submit an action request to the Clearbox Support team, detailing the server, project, schedule and column you would like edited.

Examples include:

  • PurposeCode



Schedules Menu

Layout / configuration menu

The layout/configuration page allows general schedule changes and provides a preview of the configured schedule.

In general, the method to configure schedules is:

  1. Select the Schedule to edit

  2. Edit the Properties of the schedule via the properties panel

  3. Select the Column to edit

  4. Edit the properties of the column either:

    1. via the properties panel or

    2. via the .xls download

  5. Preview results

Schedule selection

Select the type of schedules to show in the selection list below.  Either:

  • Design schedules

  • Design manual component schedules

 

Select the schedule to edit.  The page will refresh and you can now either:

Schedule properties

Shows the configured properties for the currently selected schedule, one on each line.

Click  to edit the existing property value. 

Click to delete the schedule property.

Click  to add a new property.  Select the property to add from the  selector.

Once you are in edit mode for a property, enter the text value you require in 

Click  or  (for edits or new entries) to save changes.

Click to discard edits. 

Refer to schedule property definitions for full details of available properties.


Column Selection

Select the column to edit. You can now edit the column properties

Visible columns are shown listed in yellow, invisible columns are shown listed in white. 

Columns are shown listed in their ordinal value.  Click the  buttons to re-order a column then click to save the changes.

Column properties

Shows the configured properties for the currently selected column, one on each line.

Click  to edit the existing property value. 

Click to delete the column property (If no delete is shown that is a default column and can't be removed).

Click  to add a new property.  Select the property to add from the  selector.

Once you are in edit mode for a property, enter the text value you require in 

Click  or  (for edits or new entries) to save changes.

Click to discard edits. 

Refer to column property definitions for full details of available properties.

.xls Schedule Configuration

 a .xls of the currently selected schedule to bulk edit column configurations via Excel.  The .xls currently includes a subset of all columns, the most often configured ones, meaning that other columns can only be edited via the column properties panel.

Each schedule column is listed as a row in the .xls, while the editable values are shown in the columns. 

The first column of the Excel is the BIMXtra Column System name and can't be edited.  It is also a reserved word for UserFiendlyName configuration which means that none of these values can be used as user customised names for any other column.

  

The rest of the Excel columns then show the property values for each of those column properties and these are the values that can be configured as required.  Save and close the Excel when complete.

Click  to select and upload your .xls file.  The file will be checked and processed when uploaded into BIMXtra. 

When the file has been processed a message will be added to the notifications tab:

It may return:

a success if everything processed successfully

a warning if the changes passed validation but issues that may affect schedule performance are detected (for example if the project is set to RIBA stage 3 and a column is set to stage 4, you will not be able to see the column until the project has been set to stage 4.

an error if there are issues in the sheet that need to be addressed before the changes can be accepted. If this occurs you will need to correct the highlighted columns and reupload the sheet.

To view the details of the error click on the word here and a text file will be downloaded with the content of the issues to be reviewed.

The message text provides validation details:

  • Validate if column is set to Visibile True and a Ribastage greater than the projects current ribastage if a column fails this check then the import will continue but a warning message will be  provided.

Note that changes are not applied if errors are encountered.


Each .xls download includes information that defines the project and schedule that it was produced from.  Therefore, it is simplest to download a .xls for each schedule you require from each project you are working with.

Refer to Project Configuration > Design Schedule for details of copying all schedule configurations between projects.  This method should be used in first preference but is limited by copying all schedule configurations.

Preview Schedule Layout


Select the Project LOD Stage and click to preview the selected schedule configuration.  All columns are shown in this preview mode including Design, OM, RC etc. and this is therefore a view that is not necessarily available in other areas of the system.  The specifics of this are obviously determined by your configuration.





Schedule Disciplines

Click on the Schedule Discipline column to edit the set of Disciplines in the project, where you can edit existing entries and add new ones.  You can only delete Disciplines with no schedules in them.




Schedule property definitions

Schedule properties control the behaviour and appearance of the schedule itself.  They are set individually on each schedule to be configured.

CollectionAlternativeName

The name to be used for the schedule, overriding the default name.  Can also be edited via the Metadata page.

CostPlanQuantityColumn

??

DefaultSort

??

GroupByColumn

Columns to group the schedule on.  Can also be set via the Schedule Grouping panel.

GroupBySelectColumn

The definition of the extra system columns shown when the schedule is grouped.

GroupBySelectColumnFormat

The configuration of GroupBySelectColumn

GroupingEnabled

?? Does not change with UI edit

ScopeSheetQuantityColumn

??

FrozenColumnCount

??

ExportGroupByColumn

?? Does not set with UI edits




Column property definitions

Column Properties control the behaviour and appearance of the schedule columns.  They are set individually on each column of each schedule to be configured.

Align

Controls the position of the value in the cell. Valid property values are:

  • Left

  • Centre

  • Right

  • Default

AuditGrouping

??

AuditPriority

Controls which column has the priority to return results when the audit history is requested by a user. Valid property values are:

  • Low

  • Normal

  • High

CadImport

Sets the column to be mapped from the CAD model imports if TRUE.  Sets the column to be a manual edited field if FALSE.

Calculated

??

ClientScript

??

CostPlanGroup

Sets whether the column can be grouped in the Cost Plan section of BIMXtra as displayed in the name column within Cost Plan for that schedule. Valid Property values equal Yes, No.

DatabaseExpression

??

DataTooltip

?? 

DefaultValue

??

Discipline

Sets the area of BIMXtra the column will first appear, from Design to O&M. Valid Property values are:

  • Blank - Leave blank for 'Design'

  • RC

  • OandM

  • PreCon

DisplayOverride

??

ExcelFormat

??

Expression

??

HdrLevel0

A text value that's displayed in the column header 0 in the schedule view.

HdrLevel1

A text value that's displayed in the column header 1 in the schedule view.

HdrLevel2

A text value that's displayed in the column header 2 in the schedule view.

HdrLevel3

A text value that's displayed in the column header 3 in the schedule view.

IFCPropertySet

Sets the IFC Property Set that the column is grouped into by the Insight IFC Exporter.

ImportTags

used for Fuzzy Match Mapping - not currently enabled for columns

MaxLength

A whole number that sets the maximum string length that can be entered and saved in this column's cells. Input values larger that the set value will be truncated.

There is a system wide limit on all columns of 1000 characters, and a MaxLength value over this will be ignored with the system limit used instead.

Ordinal

A whole number that sets the position of a column in the schedule.  Ordinal 0 is the left edge and the number increases to the right.  It is normal to increases the ordinal value in steps (e.g. steps of 10) and therefore leave room for inserting columns and editing later on.

ReadOnly

Sets a column to be read only (non-editable) with the value TRUE or editable with the value FALSE, via the .xls download.  If the cell is ready only it will appear with a blue background in the detailed schedule view.

RibaStageId

This controls whether the column is visible based on the project PoW LOD setting. For the column to appear RibaStageId <= Project Pow LOD. Valid Property values are 0, 1, 2, 3, 4, 5.

Round

A whole number rounding value of a number column.  e.g. Round of 2, has 2 decimal places.

SupportedDocumentsColumn

??

UseInConstruction

??

UserFriendlyName

Sets the name of the column when it appears in the Mapping screen, Insight and Onsite object data panels.   If the Use Friendly Location Names option is on then this value is also shown in Forms and in the Construction Detail Page. This is a free text value, however refer to Reserved UserFriendlyName for details of reserved words that can't be used.

Validation

??

ValidationRule

The definition of the validation rule to check the value of the cell on Model Mapping Import and .xls upload. Values which don't meet the criteria of the rule will be highlighted in red text. This definition is a text field of valid java script.  Please see validation rules for further details.

Visible

Sets whether the column is visible and therefore active or not. Valid property values are TRUE or FALSE.

Width

A whole number that sets the width of the column in the schedule view.


Validation Rules

Super users can apply validation rules to schedule columns in the schedule configuration area.   The column values are checked against the validation rules on every Model Mapping Import and .xls upload. Any values that do not comply with the column rules are highlighted red with a total of non-compliant values shown on the design landing page. The validation rule is written in Java Script and entered in the ValidationRule property to enter rules for schedule columns.

Below are a few example validation rules that can be easily modified to suit your required values:

  • Value must be between two bounding values:

    x >= 1800 && x <= 2100
  • Value must match one from a list:

    x == '30' || x == 'FD30' || x == '60'
  • Value must match a specific value:

    x == 'Ground'
  • Value must match one from a list or be between two values

    x == 'n/a' || x >= 22 && x <= 55
  • Check a value contains particular text
    EG: Look for an @ symbol in the value:

    x.indexOf('@') !== -1




Material curve configuration

BIMXtra material curves are calculated using:

  • The Material column in every schedule, to specify the material to calculate, and
  • Either: 
    • The schedule column used for the unit of measure quantity calculations, or
    • A count of the schedule rows used for number quantity calculations

Refer to the following table for the schedule unit of measure configuration:

Schedule nameUnit of measure
Actuated DamperNumbers Of  (Count of Schedule Rows)
Actuated Valve BodyNumbers Of  (Count of Schedule Rows)
Air Handling UnitNumbers Of  (Count of Schedule Rows)
Air Volume Control DeviceNumbers Of  (Count of Schedule Rows)
AnchorsNumbers Of  (Count of Schedule Rows)
AncillariesNumbers Of  (Count of Schedule Rows)
AttenuatorNumbers Of  (Count of Schedule Rows)
BlowersNumbers Of  (Count of Schedule Rows)
BoilerNumbers Of  (Count of Schedule Rows)
Bridge PaintNumbers Of  (Count of Schedule Rows)
Bridge Structural ElementMass (Schedule Column)
Bridge Survey DefectNumbers Of  (Count of Schedule Rows)
BuildersworkNumbers Of  (Count of Schedule Rows)
CatchpitsNumbers Of  (Count of Schedule Rows)
CeilingArea (Schedule Column)
Ceiling FinishesArea (Schedule Column)
Chilled BeamLength (Schedule Column)
CHPNumbers Of  (Count of Schedule Rows)
Commercial Manual ComponentsNumbers Of  (Count of Schedule Rows)
CommissioningNumbers Of  (Count of Schedule Rows)
CommunicationNumbers Of  (Count of Schedule Rows)
Concrete RoadsLength (Schedule Column)
Condensate PotNumbers Of  (Count of Schedule Rows)
Construction Navigation PointsNumbers Of  (Count of Schedule Rows)
Containment FittingNumbers Of  (Count of Schedule Rows)
Containment LengthLength (Schedule Column)
Control PanelNumbers Of  (Count of Schedule Rows)
Cooling CoilNumbers Of  (Count of Schedule Rows)
Cost Estimate Manual AdjustmentNumbers Of  (Count of Schedule Rows)
Coving FinishesNumbers Of  (Count of Schedule Rows)
CulvertNumbers Of  (Count of Schedule Rows)
Curtain WallArea (Schedule Column)
Damper ActuatorNumbers Of  (Count of Schedule Rows)
DDA EquipmentNumbers Of  (Count of Schedule Rows)
Demolitions & AbnormalsNumbers Of  (Count of Schedule Rows)
Design Manual ComponentsNumbers Of  (Count of Schedule Rows)
Design Navigation PointsNumbers Of  (Count of Schedule Rows)
Detector LoopNumbers Of  (Count of Schedule Rows)
Distribution EquipmentNumbers Of  (Count of Schedule Rows)
DoorNumbers Of  (Count of Schedule Rows)
Drainage RunLength (Schedule Column)
Drainage RunsNumbers Of  (Count of Schedule Rows)
Ductwork FittingNumbers Of  (Count of Schedule Rows)
Ductwork InsulationLength (Schedule Column)
Ductwork LengthLength (Schedule Column)
Ductwork TerminationNumbers Of  (Count of Schedule Rows)
EarthworksVolume (Schedule Column)
Electrical Capital PlantNumbers Of  (Count of Schedule Rows)
Elevated SlabsVolume (Schedule Column)
Embedded Retaining WallArea (Schedule Column)
Emergency Telecom EquipmentNumbers Of  (Count of Schedule Rows)
Environmental Hazard MarkersNumbers Of  (Count of Schedule Rows)
Environmental MarkersNumbers Of  (Count of Schedule Rows)
EquipmentNumbers Of  (Count of Schedule Rows)
Exclusion ZonesNumbers Of  (Count of Schedule Rows)
Exhaust StackNumbers Of  (Count of Schedule Rows)
Expansion EquipmentNumbers Of  (Count of Schedule Rows)
External DoorNumbers Of  (Count of Schedule Rows)
External ItemsNumbers Of  (Count of Schedule Rows)
External LuminaireNumbers Of  (Count of Schedule Rows)
External WallArea (Schedule Column)
External WindowNumbers Of  (Count of Schedule Rows)
External WorksNumbers Of  (Count of Schedule Rows)
FamiliesNumbers Of  (Count of Schedule Rows)
FanNumbers Of  (Count of Schedule Rows)
Fan Coil and Induction UnitNumbers Of  (Count of Schedule Rows)
Fencing and BarriersNumbers Of  (Count of Schedule Rows)
Filter (HVAC)Numbers Of  (Count of Schedule Rows)
Filter (Pipe)Numbers Of  (Count of Schedule Rows)
Final OutletNumbers Of  (Count of Schedule Rows)
Fire and Safety AlarmNumbers Of  (Count of Schedule Rows)
Fire and Smoke DamperNumbers Of  (Count of Schedule Rows)
Floor FinishesArea (Schedule Column)
Flow DeviceNumbers Of  (Count of Schedule Rows)
Flow GridNumbers Of  (Count of Schedule Rows)
FootpathLength (Schedule Column)
FoundationsVolume (Schedule Column)
FST PST TankNumbers Of  (Count of Schedule Rows)
Furniture, Fixtures and FittingsNumbers Of  (Count of Schedule Rows)
Glazed ScreenNumbers Of  (Count of Schedule Rows)
Gravity Retaining WallArea (Schedule Column)
Ground Bearing SlabsVolume (Schedule Column)
GullyNumbers Of  (Count of Schedule Rows)
H&S Hazard MarkersNumbers Of  (Count of Schedule Rows)
Heat EmitterNumbers Of  (Count of Schedule Rows)
Heat ExchangerNumbers Of  (Count of Schedule Rows)
Heat Transfer EquipmentNumbers Of  (Count of Schedule Rows)
Heating CoilNumbers Of  (Count of Schedule Rows)
HumidifierNumbers Of  (Count of Schedule Rows)
HVAC Capital PlantNumbers Of  (Count of Schedule Rows)
HVAC Parameter GaugeNumbers Of  (Count of Schedule Rows)
Inlet ScreenNumbers Of  (Count of Schedule Rows)
Insitu BeamsVolume (Schedule Column)
Insitu ColumnsVolume (Schedule Column)
Insitu WallsVolume (Schedule Column)
InterfacesLength (Schedule Column)
KerbsNumbers Of  (Count of Schedule Rows)
Key Hazard MarkersNumbers Of  (Count of Schedule Rows)
Level DeviceNumbers Of  (Count of Schedule Rows)
LevelsNumbers Of  (Count of Schedule Rows)
Lifting EquipmentNumbers Of  (Count of Schedule Rows)
Lighting ControlNumbers Of  (Count of Schedule Rows)
Linear Distribution EquipmentNumbers Of  (Count of Schedule Rows)
LuminaireNumbers Of  (Count of Schedule Rows)
ManholesNumbers Of  (Count of Schedule Rows)
Manual DamperNumbers Of  (Count of Schedule Rows)
Manual ValveNumbers Of  (Count of Schedule Rows)
Material WastageNumbers Of  (Count of Schedule Rows)
Mechanical Plant DriveNumbers Of  (Count of Schedule Rows)
MixersNumbers Of  (Count of Schedule Rows)
Moisture DeviceNumbers Of  (Count of Schedule Rows)
O&MNumbers Of  (Count of Schedule Rows)
Odour Control UnitNumbers Of  (Count of Schedule Rows)
Operator WorkstationNumbers Of  (Count of Schedule Rows)
Penstocks & Stop LogsNumbers Of  (Count of Schedule Rows)
Pile FoundationsLength (Schedule Column)
Pipework Capital PlantNumbers Of  (Count of Schedule Rows)
Pipework FittingNumbers Of  (Count of Schedule Rows)
Pipework InsulationLength (Schedule Column)
Pipework LengthLength (Schedule Column)
Pipework Parameter GaugeNumbers Of  (Count of Schedule Rows)
Plant or EquipmentNumbers Of  (Count of Schedule Rows)
Plenum BoxNumbers Of  (Count of Schedule Rows)
Precast Concrete Elements (manual)Numbers Of  (Count of Schedule Rows)
Pressure DeviceNumbers Of  (Count of Schedule Rows)
Pressurisation EquipmentNumbers Of  (Count of Schedule Rows)
Process ValveNumbers Of  (Count of Schedule Rows)
ProcurementNumbers Of  (Count of Schedule Rows)
Procurement EstimateNumbers Of  (Count of Schedule Rows)
ProtectionNumbers Of  (Count of Schedule Rows)
Public Address SystemNumbers Of  (Count of Schedule Rows)
PumpNumbers Of  (Count of Schedule Rows)
RailingNumbers Of  (Count of Schedule Rows)
RebarRebarTonnage (Schedule Column)
RoadLength (Schedule Column)
Road EarthworksNumbers Of  (Count of Schedule Rows)
Road LayersNumbers Of  (Count of Schedule Rows)
Road LightingNumbers Of  (Count of Schedule Rows)
Road MarkingsNumbers Of  (Count of Schedule Rows)
Road RestraintNumbers Of  (Count of Schedule Rows)
Road SignsNumbers Of  (Count of Schedule Rows)
RoofingArea (Schedule Column)
RooflightNumbers Of  (Count of Schedule Rows)
RoomArea (Schedule Column)
Room Data Sheet (Reqd)Area (Schedule Column)
Room Data Sheet As RequiredArea (Schedule Column)
Room HVAC Air BalanceNumbers Of  (Count of Schedule Rows)
Sanitary Fittings and AppliancesNumbers Of  (Count of Schedule Rows)
ScaffoldingLength (Schedule Column)
Screenings HandlingNumbers Of  (Count of Schedule Rows)
Secondary SteelworkLength (Schedule Column)
SecurityNumbers Of  (Count of Schedule Rows)
Self Acting ValveNumbers Of  (Count of Schedule Rows)
Service Chambers / Duct BoxesNumbers Of  (Count of Schedule Rows)
Service RunLength (Schedule Column)
SignageNumbers Of  (Count of Schedule Rows)
Signal InterfaceNumbers Of  (Count of Schedule Rows)
Site EstablishmentNumbers Of  (Count of Schedule Rows)
Skirting FinishesNumbers Of  (Count of Schedule Rows)
Slab and ToppingVolume (Schedule Column)
Slope Stability WorksNumbers Of  (Count of Schedule Rows)
Small Power SystemNumbers Of  (Count of Schedule Rows)
Sprayed ConcreteNumbers Of  (Count of Schedule Rows)
StairNumbers Of  (Count of Schedule Rows)
Structural ColumnsVolume (Schedule Column)
Structural FrameVolume (Schedule Column)
Structural GantryNumbers Of  (Count of Schedule Rows)
Structural MastsNumbers Of  (Count of Schedule Rows)
Structural PanelVolume (Schedule Column)
Structural ParapetsNumbers Of  (Count of Schedule Rows)
Structural Precast ElementsVolume (Schedule Column)
Structural WallArea (Schedule Column)
Supply and Extract Air TerminalNumbers Of  (Count of Schedule Rows)
Tank and Pressure VesselNumbers Of  (Count of Schedule Rows)
Technology Sign and SignalNumbers Of  (Count of Schedule Rows)
Temperature DeviceNumbers Of  (Count of Schedule Rows)
Temporary WorksNumbers Of  (Count of Schedule Rows)
TerminationNumbers Of  (Count of Schedule Rows)
Traffic ManagementNumbers Of  (Count of Schedule Rows)
Unmapped ComponentsNumbers Of  (Count of Schedule Rows)
User InterfaceNumbers Of  (Count of Schedule Rows)
ValveNumbers Of  (Count of Schedule Rows)
Valve ActuatorNumbers Of  (Count of Schedule Rows)
WallArea (Schedule Column)
Wall FinishesNumbers Of  (Count of Schedule Rows)
WindowNumbers Of  (Count of Schedule Rows)
Work Zone EquipmentNumbers Of  (Count of Schedule Rows)

Revisions menu

The Revisions menu shows the schedule revisions that have been created on the project.

The Approved column shows the approval status of thes chedule, according to any schedule approvers set up on the project.  Any schedule revisions pending approval are shown as not approved and will appear in the approvals queue.

Use the Delete button to delete that particular revision of a schedule.  An 'Info' toaster message will pop-up to confirm the Schedule Revision deleted.




Customisation menu

The metadata menu shows the schedule type configurations, where the Schedule Names and Disciplines can be configured by clicking

Schedule Customisations can also be copied from other projects using the Copy Schedules tool of the Project Configuration.

Click  to edit the schedule Name and Discipline