Field References

Within expressions, the software’s reporting tools, and Update data output sources (Data Feed Out) profiles, you can reference fields to return their values.

About these fields

These fields are individual data elements—like columns in a table—that describe:

These fields are generated by the system and can be used to build custom reports, charts, and data exports.

Where to reference

Add to reports

You can include reports fields in pivot tables and charts (refer to Create pivot tables and charts (Reporting tab)), and custom Gantt reports (refer to Gantt Reporting tab (Gantt Report tab)).

For example, a closing balance stockpile report could evaluate the Mass of each Material sent to a Location (specific stockpile or dump) at the end of each Period.

Add to report expressions

Report expressions are logic-based formulas used within the reporting tools to enhance, filter, or customise report outputs. They allow users to:

They can:

Depending on the context and the expression, some of these fields might appear with different names. In this case, their original name appears in parentheses.

Data feed out publications

Update data output sources (Data Feed Out) allows you to publish schedule data to EPF servers using profiles. Each profile includes a list of records and a set of definition fields, which are calculated using expressions. These expression can reference report fields to derive the values dynamically.

Data Feed Out allows you to publish schedule data to EPF servers using profiles.

For example, the Volume data feed could simply pull the value from the Volume report field. The VolumeAdjusted data field could use the Volume * 1.1 field to apply a swell factor.

The report fields you can reference in a data feed out field depend on the data type and field type.

List of fields

The full list of report fields is provided below. For each field, the table specifies the types of reports in which the field is available. Additionally, for use in Data Feed Out profiles, it indicates the required data type and field type needed to reference the field correctly.

Date/Reporting Period

Field Name

Available In

Data Type

Field Type

Description

Period Id

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

String

Key

A unique identifier for the period, created by concatenating the start date in YYYYMMDD format with the period name.

Example format:

YYYYMMDD_PeriodName

Period Name

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

String

Key

The name of the period (e.g., P1).

Period Number

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Numeric

Key

Indicates the sequence number of the period within the schedule. For example, 1 for the first period, 2 for the second, and so on.

Date\Reporting Period\Start and Finish

Field Name

Available In

Data Type

Field Type

Description

Period Start/Finish

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Date

Key

The exact date and time when the task’s associated period starts or finishes.

Period Start/Finish Day of the Month

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Integer

Key

Calendar day (1–31) on which the period starts or finishes, based on the finish timestamp.

Period Start/Finish Day of the Year

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Integer

Key

Returns the ordinal day number (1-365 or 1-366 in leap years) of the year on which the associated period starts or finishes, based on the finish timestamp.

Period Start/Finish Hour

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Integer

Key

Returns the hour of the day (0–23) at which the associated period starts or finishes.

Period Start/Finish Minute

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Integer

Key

Returns the minute within the hour (0–59) at which the associated period starts or finishes.

Period Start/Finish Month

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Integer

Key

Returns the month of the year (1–12) in which the associated period starts or finishes.

Period Start/Finish Name of the Day

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

String

Key

Returns the full name of the weekday (e.g., Monday, Tuesday) on which the associated period starts or finishes.

Period Start/Finish Second

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Decimal

Key

Returns the second within the minute at which the period starts or finishes, expressed as a decimal value (e.g., ss.xx), where:

  • ss = whole seconds (0–59)

  • xx = fractional part of a second (hundredths or milliseconds, depending on system precision)

Period Start/Finish Year

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Integer

Key

Returns the calendar year in which the associated period starts or finishes.

Start (Period Start)

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Date

Key

Date and Time fields for the scheduling period start.

Date\Task

Field Name

Available In

Data Type

Field Type

Description

Task Id

Schedule Results/ Schedule Report

String

Key/Field

Returns internal unique identifier for the given task.

Date\Task\Start and Finish

Field Name

Available In

Data Type

Field Type

Description

Start/Finish

Schedule Results/ Schedule Report

Date

Key/Field

The exact date and time when the task is scheduled to start or finish.

Haulage

Field Name

Available In

Data Type

Field Type

Description

Cycle Distance

Schedule Results/ Schedule Report

Decimal

Field

The total distance covered during a complete cycle of equipment for a scheduled task.

This distance includes both the forward and reverse haulage distances. In other words, it’s the sum of the forward route distance and the return route distance

Cycle Equivalent Flat Haul

Schedule Results/ Schedule Report

Decimal

Field

Represents the equivalent distance a haul would cover if it were on a flat surface, effectively normalising the haulage distance by accounting for elevation changes and other factors that might affect the actual distance travelled.

This metric provides a standardised measure of haulage distance, which can be useful for comparing different haul routes or for reporting purposes.

Cycle Time

Schedule Results/ Schedule Report

Time

Field

The time, in decimal minutes, that equipment uses to travel a complete cycle (including forward and backward distances) for a scheduled task.

The cycle time accounts for:

  • Spot time at loader

  • Load time

  • Travel time (full load)

  • Spot time at dump

  • Travel time (empty load)

You specify these haulage times for a resource in Site Management > Update haulage.

Dump Time

Schedule Results/ Schedule Report

Time

Field

The time, in decimal minutes, that equipment uses to unload material at a dump.

You set a resource’s dump time in Site Management > Update haulage.

A dump location can have a dump penalty time. If so, this penalty time is added to the resource’s initial dump time.

You set a location’s dump time penalty on the Material flow diagram.

A resource’s final dump time is the sum of its user specified dump time and the location’s dump time penalty.

Dump Time Penalty

Schedule Results/ Schedule Report

Integer

Field

A dump location can have a dump time penalty, which is additional time—to the resource’s initial dumping time—for unloading material at that dump.

This field reports the dump time penalty, if the task involves a dump location with a penalty.

You set a location’s dump time penalty on the Material flow diagram.

Electricity Consumed

Schedule Results/ Schedule Report

Decimal

Field

The nett electrical energy consumed (kWh) by the equipment during a scheduled task.

Equivalent Flat Haul (Alt)

Schedule Results/ Schedule Report

Decimal

Field

An alternative method for determining the Cycle Equivalent Flat Haul (described above).

For a given task, the software calculates the alternative CEFH based on the horizontal distance associated with the optimal one-way haulage route from the source to the destination (with a full load). The software applies adjustments to the calculation to account for uphill and downhill components of the one-way haul route.

Forward Distance

Schedule Results /Schedule Report

Decimal

Field

The one-way haul distance of the forward haulage route, from the source (i.e., pit) to the destination (i.e., dump), reported in the site- configured units.

Forward Haulage Maximum Elevation

Schedule Results /Schedule Report

Decimal

Field

The maximum z-coordinate value of the forward haul profile.

Forward Haulage Minimum Elevation

Schedule Results /Schedule Report

Decimal

Field

The lowest z-coordinate value of the forward haul profile.

Forward Haulage Negative Elevation Change

Schedule Results /Schedule Report

Decimal

Field

The sum of the negative elevation changes of the forward haul profile.

Forward Haulage Positive Elevation Change

Schedule Results /Schedule Report

Decimal

Field

The sum of the positive elevation changes of the forward haul profile.

Forward Travel Time

Schedule Results /Schedule Report

Time

Field

Within a cycle, the forward travel time is the one-way haul time taken for the loaded equipment – from the source to the destination.

This value, alongside the Reverse Travel Time value, makes up the Travel Time value.

Fuel Consumed

Schedule Results /Schedule Report

Decimal

Field

The fuel consumed by the equipment during the task.

Fuel consumption accounts for fuel used during load time, the travel time, and the dump time.

Haulage Calculation Method Used

Schedule Results /Schedule Report

String

Field

Indicates the method used to calculate the task’s haulage information:

  • Modelled Haulage: The software uses the site’s underlying haulage network (refer to Update haulage) to calculate the task’s haulage. The calculation is based on a simulation using roads and a valid path between the locations mapped to the task’s source and destination.

  • Fallback Travel Time: This method is used when the task tried to simulate haulage calculations with Modelled Haulage, but there was no valid route found between the mapped source and destination. In this case, the software uses the Travel Time If No Route Found value for the task, which is defined for movements in Material flow diagram.

  • Fixed Haulage: The task’s travel time is determined by an expression of the associated Material flow diagram movement.

  • No Haulage: No haulage data is calculated for this task.

You select a task’s haulage method in the associated movement of the Material flow diagram – with the Calculation Method property.

Haulage Model

Schedule Results/ Schedule Report

String

Field

Specifies the name of the haulage model whose roads were used to simulate haulage for the given task.

Load Time

Schedule Results/ Schedule Report

Time

Field

The time, in decimal minutes, that equipment uses to load material at a source.

You set a resource’s load time in Site Management > Update haulage.

Maximum Tyre Workload

Schedule Results /Schedule Report

Decimal

Field

A measure of tyre workload generated over the forward (loaded) and reverse (unloaded) distance for the scheduling step. TKPH includes the dump and load times which will have the effect of reducing tyre workloads (that is, tyre cools while stationary).

Number of Trucks

Schedule Results/ Schedule Report

Integer

Field

Calculates the number of truck required to achieve the task.

This is achieved with this formula:

Number of Trucks = Total Truck Hours * Period Duration (Hrs)

  • Total Truck Hours = Number of Cycles * Cycle Time (Hrs)

    • Number of Cycles = Mass / Payload

You can validate this calculation by setting up a Schedule Reportpivot table, using the fields referenced above as Data fields.

Payload

Schedule Results/ Schedule Report

Decimal

Field

The weight of the material that a truck can carry.

  • For tasks with modelled haulage, the payload used is based on the payload weight settings applied in the imported HAULSIM model.

  • For tasks with fixed haulage, the payload used is the Default Truck Payload defined in Site Management > Update haulage.

Reverse Distance

Schedule Results/ Schedule Report

Decimal

Field

Within a cycle, the reverse distance is the one-way haul odometer distance for the emptied truck – from the destination to the source.

Reverse Haulage Maximum Elevation

Schedule Results /Schedule Report

Decimal

Field

The highest z-coordinate value of the reverse haul profile.

Reverse Haulage Minimum Elevation

Schedule Results /Schedule Report

Decimal

Field

The lowest z-coordinate value of the reverse haul profile.

Reverse Haulage Negative Elevation Change

Schedule Results /Schedule Report

Decimal

Field

The sum of the negative elevation changes of the reverse haul profile.

Reverse Haulage Positive Elevation Change

Schedule Results /Schedule Report

Decimal

Field

The sum of the positive elevation changes of the reverse haul profile.

Reverse Travel Time

Schedule Results /Schedule Report

Time

Field

The haulage travel time in the reverse direction (with an empty load from the destination (i.e., dump) to the source (i.e., pit)).

This value, alongside the Forward Haulage Travel Time value, adds up to the Travel Time value.

Spot Time at Dump

Schedule Results/ Schedule Report

Time

Field

The time it takes for the equipment to spot (position accurately for unloading) at the dump, in minutes.

You set a resource’s dump spot time in Site Management > Update haulage.

Spot Time at Loader

Schedule Results/ Schedule Report

Time

Field

The time it takes for the equipment to spot (position accurately for loading) at a loader, in minutes.

You set a resource’s dump loader time in Site Management > Update haulage.

Travel Time

Schedule Results/ Schedule Report

Time

Field

The travel time, in minutes, taken during the task – along the quickest path method between the locations.

The time is calculated with a simulation of the underlying HAULSIM model – and may be adjusted the expression set in Site Management > Update haulage.

Truck Hours

Schedule Results/ Schedule Report

Decimal

Field

The amount of time required for trucks to service the scheduled task.

Truck hours are calculated using information from the imported HAULSIM models, including the associated trucks.

Material Flow

Field Name

Available In

Data Type

Field Type

Expression

Activity

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Key

The name of the activity performed in the task.

Activity Area

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Key

The name of the activity area performed in the task.

Activity Area Note

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

The note on the activity area performed in the task (entered on the Activity Areas tab).

Activity Area Spatial Domain

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

The name of the spatial domain associated with the activity area performed in the task.

Destination Name

Schedule Results/ Schedule Report

String

Key

The name of the material flow diagram destination—which receives moved material—associated with the task.

Destination Type

Schedule Results/ Schedule Report

String

Key

The type of material flow diagram destination (dump, stockpile…) associated with the task.

Dump Block

Schedule Results/ Schedule Report

String

Key

The name of the dump block that receives the mined waste associated with the task.

Dump Lift

Schedule Results/ Schedule Report

String

Key

The name of the dump lift that receives the mined waste associated with the task.

Is Resource Assigned

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

Boolean

Key

A flag (Yes/No) that indicates whether a resource is assigned to the task.

Material

Schedule Results Publish Activity Areas

String

Key

The name of the material moved in the task.

Material Movement

Schedule Results/ Schedule Report Publish Activity Area

Boolean

Key

A flag (Yes/No) that indicates whether material was moved in the task.

Mining Level

Schedule Results Publish Activity Areas

Design Request/

String

Key

The name of the mining level, where the material was extracted, if material was mined from an activity area in the task.

Pit

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Key

The name of the material flow diagram pit, where the material was extracted, if the material was mined from an activity area in the task.

Rehandle Group

Schedule Results/ Schedule Report

String

Key

The name of the rehandle group that associates with the rehandle operation performed.

Resource Type

Schedule Results/ Schedule Report

String

Key

The name of the resource definition, associated with the resource that performed the task.

Slice

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Integer

Key

The index number of the activity area slice mined in the task.

Source Name

Schedule Results/ Schedule Report

String

Key

The name of the material flow diagram source node, where material was moved from, associated with the task.

Source Type

Schedule Results/ Schedule Report

String

Key

The type of source node (pit…) associated with the task.

Material Flow\Staged Stockpile

Field Name

Available In

Data Type

Field Type

Description

Destination Build

Schedule Results/ Schedule Report

String

Key

The name of the build being constructed on the staged stockpile. It is populated when the destination is a staged stockpile.

Destination Parcel

Schedule Results/ Schedule Report

String

Key

Indicates the parcels at the destination of a material flow. When the destination is a staged stockpile, this field will include the name of the pile on the staged stockpile where the material is being directed.

Destination Pile

Schedule Results/ Schedule Report

String

Key

The name of the pile on the staged stockpile where the material is being moved to.

Source Build

Schedule Results/ Schedule Report

String

Key

This field contains the name of the build being depleted from the staged stockpile. It is filled when the source is a staged stockpile.

Source Parcel

Schedule Results/ Schedule Report

String

Key

Indicates the parcel at the source of a material flow. When the source is a staged stockpile, this field will include the name of the pile on the staged stockpile from which the material is being sourced .

Source Pile

Schedule Results/ Schedule Report

String

Key

The name of the pile on the staged stockpile from which the material is being sourced.

Location

Field Name

Available In

Data Type

Field Type

Description

Dump Block

Storage Locations/ Closing Balance Report

String

Key

The name of the dump block where material is moved to or from.

Dump Lift

Storage Locations/ Closing Balance Report

String

Key

The name of the dump lift where material is moved to or from.

Location

Storage Locations/ Closing Balance Report

String

Key

The name of the location where material is moved to or from.

Location Type

Storage Locations/ Closing Balance Report

String

Key

The type of location (dump, stockpile…) where material is moved to or from.

Material

Storage Locations/ Closing Balance Report

String

Key

The name of the material moving to or from the location.

Location\Staged Stockpile

Field Name

Available In

Data Type

Field Type

Description

Build

Storage Locations/ Closing Balance Report

String

Key

The build name of the current location (staged stockpile node).

Pile

Storage Locations/ Closing Balance Report

String

Key

The pile name of the current location (staged stockpile node).

Pile State

Storage Locations/ Closing Balance Report

String

Key

The building and depleting phase of the pile for a period.

Dump Block

Storage Locations/ Closing Balance Report

String

Key

The dump block name of the current location.

Spatial Data (Data Feed Out only)

Field Name

Available In

Data Type

Field Type

Description

Activity Area Floor Polygon

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Activity Area floor polygon in WKT format

POLYGON Z ((x1 y1 z1,x2 y2 z2,...xn yn zn)).

Activity Area Floor Polygon - as designed

Schedule Results/ Schedule Report

Publish Activity Areas

Design Request/

String

Field

Activity Area floor (silhouette) polygon in WKT format.

Activity Area Floor Surface

Schedule Results/ Schedule Report Publish Activity Areas

Design Request/

String

Field

Activity Area floor surface in WKT format (TIN)

TIN (((x1 y1 z1,x2 y2 z2,x3 y3 z3,x1 y1 z1)),...).

Activity Area Floor Surface - with radius

Schedule Results/ Schedule Report

Publish Activity Areas

Design Request/

String

Field

Activity Area floor surface with a specified buffer (radius) applied, in WKT format (TIN).

Activity Area Roof Polygon

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Activity Area roof polygon in WKT format.

Activity Area Roof Surface

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Activity Area roof surface in WKT format (TIN).

Activity Area Solid

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Activity Area solid in WKT format (TIN).

Period Floor Polygon

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Period portion of area floor polygon in WKT format.

Period Floor Surface

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Period portion of area floor surface in WKT format (TIN).

Period Roof Polygon

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Period portion of area roof polygon in WKT format.

Period Roof Surface

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Design Request/

String

Field

Period portion of area roof surface in WKT format (TIN).

Principal Fields

Field Name

Available In

Data Type

Field Type

Description

Avg Flr Elevation

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The average elevation (of each point) of the floor of the activity area.

Avg Tk

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The average thickness of the activity area (Volume / Plan Area).

Density

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The density of the activity area.

Grade Control Intersection Percent

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The percentage of the activity area solid that intersects with grade control blocks (if imported).

Mass

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The mass of the activity area (Volume * Density).

Plan Area

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The surface area of the activity area.

Volume

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The volume of the activity area.

Volume_Swollen

Schedule Results/ Schedule Report

Activity Areas/ Activity Area Report

Storage Locations/ Closing Balance Report

Design Request/

Decimal

Field

The volume of the activity area with the swell factor applied.

Productivity

Field Name

Available In

Data Type

Field Type

Description

Activity Area Rate Factor

Schedule Results/ Schedule Report

Decimal

Field

The production rate factor applied to a given activity area. This factor modifies the production rate of any resource operating within that area by the specified amount. Defined on the Activity Areas tab.

Activity Quantity

Schedule Results/ Schedule Report

Decimal

Field

The aggregated quantity of the activity quantity field.

Activity Quantity Unit

Schedule Results/ Schedule Report

String

Key

The units of the activity quantity field.

Available Time

Schedule Results/ Schedule Report

Time

Field

Available roster time for the reported period.

Delay Details

Schedule Results/ Schedule Report

Integer

Key

The maintenance order number.

Duration

Schedule Results/ Schedule Report

Time

Field

Resource productive time.

Is Available

Schedule Results/ Schedule Report

Boolean

Key

Flag to indicate whether the resource is in maintenance.

Is Operating

Schedule Results/ Schedule Report

Boolean

Key

Flag to indicate whether the resource is operating (productive activity or travelling).

Is Productive

Schedule Results/ Schedule Report

Boolean

Key

Flag to indicate whether the resource is productive (productive activity).

Non Production Time

Schedule Results/ Schedule Report

Time

Field

Sum of work category periods excluding 'Available' roster time for a Resource for a reporting period.

Operating Time

Schedule Results/ Schedule Report

Time

Field

The amount of time a resource can operate. It’s determined by this formula:

Rostered Hours × Resourse Effective Utilisation

Production Rate (Actual)

Schedule Results/ Schedule Report

Decimal

Field

The actual production rate used by a resource on an activity area.

It’s determined by this formula:

Entered Production Rate * Resource Effective Utilisation

Refer to Site Config > Resources.

Production Rate (Entered)

Schedule Results/ Schedule Report

Decimal

Field

The resource's production rate, after considering the site-specific production rate, the periodic rate factor, and the activity area rate factor (if defined).

This rate is used to determine the actual production rate achieved by the resource.

Refer to Site Config > Resources.

Production Rate (Nominal)

Schedule Results/ Schedule Report

Decimal

Field

The base/global rate of the resource, unaffected by any modifiers or site-specific production rates.

Refer to Site Config > Resources.

Production Rate Unit

Schedule Results/ Schedule Report

String

Key

The activity area resource productive rate unit.

Productive Activity Quantity

Schedule Results/ Schedule Report

Decimal

Field

The aggregated quantity for productive tasks.

Productive Activity Quantity Unit

Schedule Results/ Schedule Report

String

Key

The unit of the activity quantity field for productive tasks.

Productive Time

Schedule Results/ Schedule Report

Time

Field

Sum of productive time for a resource.

Resource Availability

Schedule Results/ Schedule Report

Decimal

Field

The percentage of rostered time the resource is available for use (Client > Resources tab).

This percentage is weight averaged by the task duration.

This percentage is weight averaged by the task duration.

Resource Effective Utilisation

Schedule Results/ Schedule Report

Decimal

Field

The total percentage of rostered time that the resource is being utilised for the given task.

This is a multiplication of the resource’s Availability, Utilisation, and Efficiency values (Client > Resources tab).

Resource Efficiency

Schedule Results/ Schedule Report

Decimal

Field

The percentage of time that reflects how effectively the resource performs when in use (Client > Resources tab).

This percentage is weight averaged by the task duration, multiplied by the resource Availability and Utilisation.

Resource Period Value

Schedule Results/ Schedule Report

Decimal

Field

The resource’s value of ResourcePeriodValue for the given period. Defined in Site Config > Resources, this represents a value that helps set the resource’s production rate for the given period.

Resource Rate Factor

Schedule Results/ Schedule Report

Decimal

Field

A factor that represents a percentage of the resource’s nominal production rate – that will actually be used by the resource in the given period.

Refer to Site Config > Resources.

Resource Utilisation

Schedule Results/ Schedule Report

Decimal

Field

The percentage of available time that the resource is being used (Client > Resources tab).

This percentage is weight averaged by the task duration multiplied by the resource Availability.

Wash Fields

Field Name

Available In

Data Type

Field Type

Description

ProductMass

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Numeric

Field

The mass (t) of the washed coal product.

Wash Plant Cut-Point

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Numeric

Field

The specific gravity at which the coal feed sinks within the washing unit.

Wash Plant Yield

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Numeric

Field

The yield of the wash plant at the specified ash content.

Product<quality>

Schedule Results/ Schedule Report

Storage Locations/ Closing Balance Report

Numeric

Field

The wash coal product quality value.

Constants

Constants

Description

Example

TRUE

Represents the Boolean True value.

 

FALSE

Represents the Boolean False value.

 

?

Represents a null reference that does not refer to any object.

Iif( [Source] != ?,…

Operators

Operators

Description

Example

+

Adds the value of one numeric expression to another or concatenates two strings.

[Activity Quantity] + 40

[Activity Area ] + '-' + [Resource Name]

 

 

-

Finds the difference between two numbers.

[Production Rate (Nominal)] - [Production Rate (Actual)]

*

Multiplies the value of two expressions.

[Activity Quantity] * [Production Rate (Actual)]

/

Divides the first operand by the second.

[Activity Quantity] / 2

%

Returns the remainder (modulus) obtained by dividing one numeric expression by another.

[Activity Quantity] % 3

|

Performs a bitwise inclusive OR on two numeric expressions. Compares each bit of its first operand to the corresponding bit of its second operand. If either bit is 1, the corresponding resulting bit is set to 1. Otherwise, the corresponding resulting bit is set to 0.

[Number] | [Number]

&

The bitwise AND operator. Compares each bit of its first operand to the corresponding bit of its second operand. If both bits are 1, the corresponding resulting bit is set to 1. Otherwise, the corresponding resulting bit is set to 0.

[Number] & 10

^

Performs a bitwise exclusive OR on two numeric expressions.

[Number] ^ [Number]

==

Returns true if both operands have the same value; otherwise, it returns false.

[Task Start Hour] == 10

!=

Returns true if the operands do not have the same value; otherwise, it returns false.

[Task Start Hour] != 10

<

Less than operator. Used to compare expressions.

[Activity Quantity] < 200

<=

Less than or equal to operator. Used to compare expressions.

[Activity Quantity] <= 200

>=

Greater than or equal to operator. Used to compare expressions.

[Activity Quantity] >= 300

>

Greater than operator. Used to compare expressions.

[Activity Quantity] > 300

In (,,,)

Tests for the existence of a property in an object.

[Pit Name] In ('West', 'East', 'North')

Between (,)

Specifies a range to test. Returns true if a value is greater than or equal to the first operand and less than or equal to the second operand.

[Production Rate (Actual)] Between (10, 20)

And

Performs a logical conjunction on two Boolean expressions.

[Is Available] == 'Yes' And ([Production Rate (Actual)] > 1000

Or

Performs a logical disjunction on two Boolean expressions.

[Is Available] == 'Yes' And ([Production Rate (Actual)] > 1000)

Not

Performs a logical negation on a Boolean expression.

Not ([Is Available] == 'Yes')

Functions

Aggregate functions

Aggregate Functions

Description

Example

Avg

Evaluates the average of the values in the collection.

Avg([Density])

Count

Returns the number of objects in a collection. (Field type integer)

[][[Density] < 2.1].Count()

Exists

Determines whether the object exists in the collection. (Field type boolean)

[][[Density] < 2.1].Exists()

Max

Returns the maximum expression value in a collection.

Max([Density])

Min

Returns the minimum expression value in a collection.

Min([Density])

Single

Returns a single object from the collection.

TODO

Sum

Returns the sum of all the expression values in the collection.

Sum([Activity Quantity])

Datetime functions

Datetime Functions

Description

Example

AddDays(DateTime, DaysCount)

Returns a date-time value that is the specified number of days from the specified DateTime.

AddDays([Period Finish], 30)

AddHours(DateTime, HoursCount)

Returns a date-time value that is the specified number of hours from the specified DateTime.

AddHours([Period Start], 2)

AddMilliSeconds(DateTime, MilliSecondsCount)

Returns a date-time value that is the specified number of milliseconds from the specified DateTime.

AddMilliSeconds(([Period Start], 5000))

AddMinutes(DateTime, MinutesCount)

Returns a date-time value that is the specified number of minutes from the specified DateTime.

AddMinutes([Period Start], 30)

AddMonths(DateTime, MonthsCount)

Returns a date-time value that is the specified number of months from the specified DateTime.

AddMonths([Period Finish], 1)

AddSeconds(DateTime, SecondsCount)

Returns a date-time value that is the specified number of seconds from the specified DateTime.

AddSeconds([Period Start], 60)

AddTicks(DateTime, TicksCount)

Returns a date-time value that is the specified number of ticks from the specified DateTime.

AddTicks([Period Start], 5000)

AddTimeSpan(DateTime, TimeSpan)

Returns a date-time value that is from the specified DateTime for the given TimeSpan.

AddTimeSpan([Period Start], [Duration])

AddYears(DateTime, YearsCount)

Returns a date-time value that is the specified number of years from the specified DateTime.

AddYears([Period Finish], -1)

DateDiffDay(startDate, endDate)

Returns the number of day boundaries between two non-nullable dates.

DateDiffDay([Period Start], Now())

DateDiffHour(startDate, endDate)

Returns the number of hour boundaries between two non-nullable dates.

DateDiffHour([Period Start], Now())

DateDiffMilliSecond(startDate, endDate)

Returns the number of millisecond boundaries between two non-nullable dates.

DateDiffMilliSecond([Period Start], Now())

DateDiffMinute(startDate, endDate)

Returns the number of minute boundaries between two non-nullable dates.

DateDiffMinute([Period Start], Now())

DateDiffMonth(startDate, endDate)

Returns the number of month boundaries between two non-nullable dates.

DateDiffMonth([Period Start], Now())

DateDiffSecond(startDate, endDate)

Returns the number of second boundaries between two non-nullable dates.

DateDiffSecond([Period Start], Now())

DateDiffTick(startDate, endDate)

Returns the number of tick boundaries between two non-nullable dates.

DateDiffTick([Task Start], Now())

DateDiffYear(startDate, endDate)

Returns the number of year boundaries between two non-nullable dates.

DateDiffYear([Period Start], Now())

GetDate(DateTime)

Extracts a date from the defined DateTime.

GetDate([Period Finish])

GetDay(DateTime)

Extracts a day from the defined DateTime.

GetDay([Period Finish])

GetDayOfWeek(DateTime)

Extracts a day of the week from the defined DateTime.

GetDayOfWeek([Period Finish])

GetDayOfYear(DateTime)

Extracts a day of the year from the defined DateTime.

GetDayOfYear([Period Finish])

GetHour(DateTime)

Extracts an hour from the defined DateTime.

GetHour([Period Start])

GetMilliSecond(DateTime)

Extracts milliseconds from the defined DateTime.

GetMilliSecond([Period Start])

GetMinute(DateTime)

Extracts minutes from the defined DateTime.

GetMinute([Period Start])

GetMonth(DateTime)

Extracts a month from the defined DateTime.

GetMonth([Period Start])

GetSecond(DateTime)

Extracts seconds from the defined DateTime.

GetSecond([Period Start])

GetTimeOfDay(DateTime)

Extracts the time of the day from the defined DateTime in ticks.

GetTimeOfDay([Period Start])

GetYear(DateTime)

Extracts a year from the defined DateTime.

GetYear([Period Start])

IsApril(DateTime)

Returns True if the specified date falls within April.

IsApril([Period Finish])

IsAugust(DateTime)

Returns True if the specified date falls within August.

IsAugust([Period Finish])

IsDecember(DateTime)

Returns True if the specified date falls within December.

IsDecember([Period Finish])

IsFebruary(DateTime)

Returns True if the specified date falls within February.

IsFebruary([Period Finish])

IsJanuary(DateTime)

Returns True if the specified date falls within January.

IsJanuary([Period Finish])

IsJuly(DateTime)

Returns True if the specified date falls within July.

IsJuly([Period Finish])

IsJune(DateTime)

Returns True if the specified date falls within June.

IsJune([Period Finish])

IsLastMonth(DateTime)

Returns True if the specified date falls within the previous month.

IsLastMonth([Period Finish])

IsLastYear(DateTime)

Returns True if the specified date falls within the previous year.

IsLastYear([Period Finish])

IsMarch(DateTime)

Returns True if the specified date falls within March.

IsMarch([Period Finish])

IsMay(DateTime)

Returns True if the specified date falls within May.

IsMay([Period Finish])

IsNextMonth(DateTime)

Returns True if the specified date falls within the next month.

IsNextMonth([Period Finish])

IsNextYear(DateTime)

Returns True if the specified date falls within the next year.

IsNextYear([Period Finish])

IsNovember(DateTime)

Returns True if the specified date falls within November.

IsNovember([Period Finish])

IsOctober(DateTime)

Returns True if the specified date falls within October.

IsOctober([Period Finish])

IsSameDay(DateTime)

Returns True if the specified date/time values fall within the same day.

IsSameDay([Period Finish])

IsSeptember(DateTime)`

Returns True if the specified date falls within September.

IsSeptember([Period Finish])

IsThisMonth(DateTime)

Returns True if the specified date falls within the current month.

IsThisMonth([Period Finish])

IsThisWeek(DateTime)

Returns True if the specified date falls within the current week.

IsThisWeek([Period Finish])

IsYearToDate(DateTime)

Returns True if the specified date falls within the year-to-date period. This period starts from the first day of the current year and continues to the current date (including the current date).

IsYearToDate([Period Finish])

IsThisYear(DateTime)

Returns True if the specified date falls within the current year.

IsThisYear([Period Finish])

LocalDateTimeDayAfterTomorrow()

Returns a date-time value corresponding to the day after Tomorrow.

AddDays(LocalDateTimeDayAfterTomorrow(), 5)

LocalDateTimeLastMonth()

Returns the DateTime value corresponding to the first day of the previous month.

AddMonths(LocalDateTimeLastMonth(), 5)

LocalDateTimeLastWeek()

Returns a date-time value corresponding to the first day of the previous week.

AddDays(LocalDateTimeLastWeek(), 5)

LocalDateTimeLastYear

Returns the DateTime value corresponding to the first day of the previous year.

AddYears(LocalDateTimeLastYear(), 5)

LocalDateTimeNextMonth()

Returns a date-time value corresponding to the first day of the next month.

AddMonths(LocalDateTimeNextMonth(), 5)

LocalDateTimeNextWeek()

Returns a date-time value corresponding to the first day of the following week.

AddDays(LocalDateTimeNextWeek(), 5)

LocalDateTimeNextYear()

Returns a date-time value corresponding to the first day of the following year.

AddYears(LocalDateTimeNextYear(), 5)

LocalDateTimeNow()

Returns a date-time value corresponding to the current moment in time.

AddDays(LocalDateTimeNow(), 5)

LocalDateTimeThisMonth()

Returns a date-time value corresponding to the first day of the current month.

AddMonths(LocalDateTimeThisMonth(), 5)

LocalDateTimeThisWeek()

Returns a date-time value corresponding to the first day of the current week.

AddDays(LocalDateTimeThisWeek(), 5)

LocalDateTimeThisYear()

Returns a date-time value corresponding to the first day of the current year.

AddYears(LocalDateTimeThisYear(), 5)

LocalDateTimeToday()

Returns a date-time value corresponding to Today.

AddDays(LocalDateTimeToday(), 5)

LocalDateTimeTomorrow()

Returns a date-time value corresponding to Tomorrow.

AddDays(LocalDateTimeTomorrow(), 5)

LocalDateTimeTwoMonthsAway()

Returns the DateTime value corresponding to the first day of the following month.

AddMonths(LocalDateTimeTwoMonthAway(), 5)

LocalDateTimeTwoWeeksAway

Returns the DateTime value corresponding to the first day of the following week.

AddDays(LocalDateTimeTwoWeeksAway(), 5)

LocalDateTimeTwoYearsAway()

Returns the DateTime value corresponding to the first day of the following year.

AddYears(LocalDateTimeTwoYearsAway(), 5)

LocalDateTimeYearBeforeToday()

Returns the DateTime value corresponding to the day one year ago.

AddYears(LocalDateTimeYearBeforeToday(), 5)

LocalDateTimeYesterday()

Returns a date-time value corresponding to Yesterday.

AddDays(LocalDateTimeYesterday(), 5)

Now()

Returns the current system date and time.

AddDays(Now(), 5)

Today()

Returns the current date. Regardless of the actual time, this function returns midnight of the current date.

AddMonths(Today(), 1)

UtcNow()

Returns the current system date and time, expressed as Coordinated Universal Time (UTC).

AddDays(UtcNow(), 7)

Logical functions

Logical Functions

Description

Example

IsNull(Value)

Returns True if the specified Value is NULL.

IsNull([Density])

IsNull(Value1, Value2)

Returns the second operand if the first operand is null, otherwise, the first operand is returned.

IsNull([Density],2.2)

IsNullOrEsmpty(String)

Returns True if the specified String object is NULL or an empty string; otherwise, False is returned.

IsNullOrEmpty

Iif(, , )

Iif(Expression, TruePart, FalsePart) Returns either TruePart or FalsePart, depending on the evaluation of the Boolean Expression.

Iif([Cycle Time] < 20,"short","long" )

Math functions

Math Functions

Description

Example

Abs(Value)

Returns the given numeric expression's absolute, positive value.

Abs(1 - [Value])

Acos(Value)

Returns a number's arccosine (the angle in radians, whose cosine is the given float expression).

Acos([Value])

Asin(Value)

Returns a number's arcsine (the angle in radians, whose sine is the given float expression).

Asin([Value])

Atn(Value)

Returns a number's arctangent (the angle in radians, whose tangent is the given float expression).

Atn([Value])

Atn2(Value1, Value2)

Returns the angle whose tangent is the quotient of two specified numbers in radians.

Atn2([Value1], [Value2])

BigMul(Value1, Value2)

Returns an Int64 containing the full product of two specified 32-bit numbers.

BigMul([Valuse1], [Value2])

Ceiling(Value)

Returns the smallest integer that is greater than or equal to the numeric expression.

Ceiling([Value])

Cos(Value)

Returns the angle's cosine, in radians.

Cos([Value])

Cosh(Value)

Returns the angle's hyperbolic cosine, in radians.

Cosh([Value])

Exp(Value)

Returns the float expression's exponential value.

Exp([Value])

Floor(Value)

Returns the largest integer less than or equal to the numeric expression.

Floor([Value])

Log(Value)

Returns a specified number's natural logarithm.

Log([Value])

Log(Value, Base)

Returns the logarithm of a specified number in a specified Base.

Log([Value], 2)

Log10(Value)

Returns a specified number's base 10 logarithm.

Log10([Value])

Max(Value1, Value2)

Returns the maximum value from the specified values.

Max([Value1], [Value2])

Min(Value1, Value2)

Returns the minimum value from the specified values.

Min([Value1], [Value2])

Power(Value, Power)

Returns a specified number raised to a specified power.

Power([Value], 3)

Rnd()

Returns a random number that is less than 1, but greater than or equal to zero.

Rnd()*100

Round(Value)

Returns a random number that is less than 1, but greater than or equal to zero.

Round([Value])

Round(Value, Precision)

Rounds the given value to the nearest integer, or to a specified number of decimal places.

Round([Value], 2)

Sign(Value)

Returns the positive (+1), zero (0), or negative (-1) sign of the given expression.

Sign([Value])

Sin(Value)

Returns the sine of the angle defined in radians.

Sin([Value])

Sinh(Value)

Returns the hyperbolic sine of the angle defined in radians.

Sinh([Value])

Sqr(Value)

Returns the square root of a given number.

Sqr([Value])

Tan(Value)

Returns the tangent of the angle defined in radians.

Tan([Value])

Tanh(Value)

Returns the hyperbolic tangent of the angle defined in radians.

Tanh([Value])

ToDecimal(Value)

Converts Value to an equivalent decimal number.

ToDecimal([Value])

ToDouble(Value)

Converts Value to an equivalent 64-bit double-precision floating-point number.

ToDouble([Value])

ToFloat(Value)

Converts Value to an equivalent 32-bit single-precision floating-point number.

ToFloat([Value])

ToInt(Value)

Converts Value to an equivalent 32-bit signed integer.

ToInt([Value])

ToLong(Value)

Converts Value to an equivalent 64-bit signed integer.

ToLong([Value])

String functions

String Functions

Description

Example

Ascii(String)

Returns the ASCII code value of the leftmost character in a character expression.

Ascii('a')

Char(Number)

Converts an integerASCIICode to a character.

Char(65) + Char(51)

CharIndex(String1, String2)

Returns the starting position of String1 within String2, beginning from the zero character position to the end of a string.

CharIndex('West', 'PitWest')

Concat(String1, ... , StringN)

Returns a string value containing the concatenation of the current string with any additional strings.

Concat('Pit_', ')', [Pit Name])

Contains(String1, SubString1)

Returns True if SubString1 occurs within String1; otherwise, False is returned.

Contains([Pit Name], 'West')

EndsWith(String1, SubString1)

Returns True if the end of String1 matches SubString1; otherwise, False is returned.

EndsWith([Pit Name], 'West')

Insert(String1, StartPosition, String2)

Inserts String2 into String1 at the position specified by StartPositon

Insert([Pit Name], 0, 'Pit_')

Len(Value)

Returns an integer containing either the number of characters in a string or the nominal number of bytes required to store a variable.

Len([Activity Area ])

Lower(String)

Returns String in lowercase.

Lower([Pit Name])

PadLeft(String, Length)

Left-aligns the defined string's characters, padding its left side with white space characters up to a specified total length.

PadLeft([Pit Name], 30)

PadLeft(String, Length, Char)

Left-aligns the defined string's characters, padding its left side with the specified Char up to a specified total length.

PadLeft([Pit Name], 30, '<')

PadRight(String, Length)

Right-aligns the defined string’s characters, padding its left side with empty space characters up to a specified total length.

PadRight([Pit Name], 30)

PadRight(String, Length, Char)

Right-aligns the defined string’s characters, padding its left side with the specified Char up to a specified total length.

PadRight([Pit Name], 30, '>')

Remove(String, StartPosition)

Deletes all the characters from this instance, beginning at a specified position.

Remove([Pit Name], 3)

Remove(String, StartPosition, Length)

Deletes a specified number of characters from this instance, beginning at a specified position.

Remove([Pit Name], 0, 3)

Replace(String1, SubString2, String3)

Returns a copy of String1, in which SubString2 has been replaced with String3.

Replace([Pit Name], 'Pit', '')

Reverse(String)

Reverses the order of elements within String.

Reverse('etucex')

StartsWith(String1, SubString1)

Returns True if the beginning of String1 matches SubString1; otherwise, False.

StartsWith([Pit Name], 'West')

Substring(String, StartPosition, Length)

Retrieves a substring from String. The substring starts at StartPosition and has a specified Length.

Substring([Activity Area ], 3, 6)

Substring(String, StartPosition)

Retrieves a substring from String. The substring starts at StartPosition.

Substring([Activity Area ], 3)

ToStr(Value)

Returns a string representation of an object.

ToStr([Mat Code])

Trim(String)

Removes all leading and trailing SPACE characters from String.

Trim(' a string with space at start')

Upper(String)

Returns String in upper case.

Upper([Pit Name])