Skip to main content

Project configuration and metadata fields

Updated over 3 weeks ago

CM-005-V4-EN

Project Configurations contains different fields including Holidays, Pay grade, Operation type, Employee type, Tendered, Depot code, Operator, and Registration.

To configure any field, you must first:

  1. Go to the Projects view, right-click on the project you want to configure (or hover over the project and click the three dots button to the right) and select Configuration.

  2. You will see a window with a Metadata tab on the left, listing all all configurable fields.

Below you will find the available fields:

Serviced Organizations

Serviced Organization (also known as ORG code) are specific date ranges where service IDs are activated.

To add a new ORG code, click Add New.

You can then define the dates when the service organization operates or does not operate. These will be added to the relevant Service IDs in the Route tab.

Holidays

Special holidays can be configured in the Holidays element in the Project Configuration. It's used to define days with changes in your regular service. Those can be regular bank holidays such as Christmas, or one-off occasions (special holidays).

Marking a day as a special holiday changes its coding in the TXC protocol. In turn, it affects how other systems such as Ticketer or BODS interpret the data.

Special holidays must be set if you want to configure special service IDs in your timeplan.

Setup

  1. In the Metadata tab on the left, select Holidays.

  2. Click +Add New.

  3. Configure the fields:

    • Name - The name of the holiday being created

    • Special Holiday - If it’s a one-off day when services may or may not run (unlike regular holidays like Christmas Day).

    • Date - The date the holiday is applicable to.

  4. Click Save on the holiday and Project Configurations.

From here you can proceed to creating a special service ID.

Pay Grade

The pay grade that drivers receive can also be configured. If there are multiple different pay grades between different rota groups for example these can be added here and then later will be applied to each rota group in the rostering module.

Operation Type

This field defines whether a service ID applies to school days, non-school days, or all days. It is also applied at a service ID level in the Route tab of the Timeplan and is used for the Timetable Report.

Employee Type

An employee type code is used in Grampian exports. It must be defined here to be assigned to roster groups in the roster preferences.

Tendered

These codes are applied at the trip and stop level in the Timeplan to ensure the client receives payments from local authorities and the government for subsidized routes or portions of trips.

You can enter the start and end dates, contract code, and the relevant authority:

Depot Code

All depot codes must be added to this field to be included and usable in exports. These are added from the TXC but need to be verified.

Note: The depot code name should match the Stop ID code, for example a short code like CACA or a NaPTAN code such as 050012345.

Operator

This section defines the contact details, National Operator Code, and license-related fields. These values must entered accurately, as they will appear in TXC exports and are validated by third parties. Please note the following rules:

  • The Name of the operator should, and typically does, match the National Operator Code.

  • The License Classification field is case-sensitive. The most common value for UK registrations is: standardNational

  • Depot Codes must match the values entered in the Depot Code section. Any discrepancies will cause TXC export failures.

  • The Correspondence Address should follow standard address formatting (e.g. street, town, postcode), with each element entered on a separate line, as if addressing an envelope.

Registration

This section is where you enter all the key information required for a bus service registration. It captures the full set of data needed to submit a compliant registration to the relevant authorities, including but not limited to:

  • Registration Number

  • Traffic Area

  • Local Authorities involved

  • Service Classification (e.g. Normal Stopping, Hail & Ride, Limited stops)

  • Supporting Documentation (such as service maps, timetables, justification letters, etc.)

  • Effective and End Dates

  • Reason for Registration (new, variation, withdrawal, etc.)

Accurate completion of this section is essential, as the data entered forms the basis of the final submission to the Office of the Traffic Commissioner and relevant local transport bodies. This information is also used to generate the TXC (TransXChange) export file where applicable.

The Name of the registration should be the registration code, not the service name or route number. For example, the Name could be 72 (code), while the Service Reference is 550 (route).

Note: When submitting a new registration (including variations or withdrawals), certain fields must be updated each time to reflect the latest submission details.

  • Variation Number – Increment for each change to an existing registration.

  • Submission Author – Update to the person responsible for the current submission.

  • Submission Date – Ensure it reflects the date the registration is submitted.

Failing to update these fields may result in complications or rejection by the Traffic Commissioner or other reviewing bodies. Always double-check these values before submitting a new registration.

Did this answer your question?