EventStrings

Name: Event Strings

Type: Application

Modules: Scheduling

Description: Main table for all scheduled events. The data encompasses all runs by date.

Field Documentation
SchId Numeric identifier of the booking schedule date (from the Schedules table.).
EvStrId Internal numeric identifier of the live run that the event is on (from the EventStrings table).
EvStrClass Hard-coded values for the class type for the run (e.g., PARA, FLEX, Taxi).
EvStrName Description or name of the event string.
VehicleType Numeric identifier of the vehicle type (from the VehicleTypes table).
CapType ID number of the capacity type (from the CapacityTypes table).
VehicleId ID number of the vehicle (from the Vehicles table).
ParaRunType Hard coded value for the run type of run (0 = Para, 1 = Taxi, 2 = Flex).
ParaRunId ID number of a Para Run (from the ParaRuns table).
FromGarageId ID number of the garage the vehicle will leave from (from the Garages table).
ToGarageId ID number of the garage the vehicle will finish at (from the Garages table).
FromTime Time the run starts. Value is in seconds from midnight.
ToTime Time the run ends. Value is in seconds from midnight.
MaxLength Maximum time that the run can be active in seconds.
EmployeeId ID number of the employee associated with the run as the driver.
CoDriver ID number of the employee associated with the run as a co-driver.
CoEmployeeId ID number of the employee associated with the run as an employee.
GasCard Number of the gas card.
ProviderId ID number of the Provider for the run (from the Providers table).
Violations Comma separated list of the current violations of the associated event (e.g., SL, RL).
LineGroupId Deprecated.
BlockNum ID number of a Fixed Route Block (from the FxBlocks table).
UserDouble1 Client supplementary data.
UserDouble2 Client supplementary data.
UserLong1 Client supplementary data.
UserLong2 Client supplementary data.
UserLong3 Client supplementary data.
UserLong4 Client supplementary data.
UserLong5 Client supplementary data.
UserString1 Client supplementary data.
UserString2 Client supplementary data.
UserString3 Client supplementary data.
UserString4 Client supplementary data.
UserString5 Client supplementary data.
SignOnTime Time that a sign on message was received from the vehicle. Value is in seconds from midnight.
SignOffTime Time that a sign off message was received from the vehicle. Value is in seconds from midnight.
SpeedFactor Percentage of an average speed (e.g., the driver is new and not familiar with the route so takes 110% of the average travel speed).
Priority Order in which the events are evaluated for scheduling.
IsFrozen Indicates whether or not the EventString is frozen and cannot be moved.
ParaServiceAreaId ID number of the Para Service Area (from the ParaServiceAreas table).
ProviderContractId ID number of a Provider Contract to associate with the eventstring (from the ProviderContract table).
ProviderRunCost Total cost to be billed to a Provider for the run.
ProviderCostBreakdown String containing a breakdown of the provider cost by trip and Provider.
ProviderRunCostInvoiced Amount that was sent to the Provider for payment.
ProviderInvoiceDate Date the Provider was invoiced for the run's trips.
ProviderInvoiceTime Time the Provider invoice was sent. Value is in seconds from midnight.
ParaTimeRules Numeric value indicating what Para Time rule to use (Garage, First Pickup, Last Drop off or Last Pickup).
FromTimeRule Numeric value indicating what From Time rule to use (Garage, First Pickup, Last Drop off or Last Pickup).
ToTimeRule Numeric value indicating what To Time rule to use (Garage, First Pickup, Last Drop off or Last Pickup).
BidEmployeeId Employee ID used to bid on the run (from the Employee table). Employees usually bid on which runs they wish to do by seniority.
AssignTypeId Custom assignment type identifier (from OpsCustomAssignmentTypes.AssignTypeId). References the associated custom assignment type.
AssignListId ID of an Assignment list of drivers. Drivers can be broken into groups and assigned to runs using a list of drivers.
BidAssignTypeId Assignment type ID to be used to assign drivers to the run.
ModBy User that last modified the record.
ModDate Date the record was last modifid.
ModTime Time the record was last modified. Value is in seconds from midnight.
JobClassId Job class identifier (from OpsJobClasses.JobClassId). References the associated job class.
WorkJobClassId Job class identifier and alias (from OpsJobClasses.JobClassId). References the associated work job class.
DivisionId Division identifier (from MasterDivisions.DivisionId). References the associated division.
WorkAssignmentViolations String that denotes restrictions to the assignment of the run to an employee.
VehicleAssignmentViolations String that denotes restrictions to the assignment of the run to a vehicle.
GarageId ID number of the garage (from the Garages table).
VehicleAssignTypeId Hard-coded type ID of the vehicle type that the run can be assigned to.
ParkingLayoutId Unique ID of a parking lot layout (from the ParkingLayouts table).
LineGroupAbbr Line group identifier (from MasterLineGroup.LineGroupId). References the associated line group.
Comments Comments about the record.
ReportTime Time in seconds required by a driver to sign in to a vehicle, do the checklist, etc.
ClearTime Time in seconds required by a driver to log out of a vehicle, do the post-trip checklist, etc.
PassengerCount Total number of passengers assigned to the EventString.
TripCount Total number of trips assigned to the EventString.
RunTime Total length of time in seconds of the EventString.
RevenueRunTime Total time in seconds that the run is generating revenue (total billable time).
RunDistance Total distance in meters the EventString will travel.
RevenueRunDistance Total distance in meters the EventString will travel that generates revenue.
RunDirectDistance Total direct distance of the EventString in meters.
RevenueRunDirectDistance Total direct distance of the EventString in meters that the run is generating billable revenue.
RunSlackTime Total time in seconds that the run that is not generating revenue (not billable time).
RunCategoryId Unique ID of a run category that logically groups runs to types (from ParaRunCategory table).
BreakRuleId Unique ID of a break rule for the run (from the ParaRunBreakRule table).
DirNum Number indicating what direction the vehicle is travelling (In or Out).
WorkTimeExtensionFlag Internal use only.
MinLength Minimum length of time that the run must last before it will be scheduled (in seconds).
CallDriver Flag that indicates the run driver is to be called with updated notifications.
PullOutComment Comment to associate with the EventStrings Pull Out, usually for the driver.
ClusterType Hard-coded character type of a cluster run (M = master, C = cluster).
ClusterOverlapFromRule Hard-coded value for the overlap to determine where the overlap will be applied when scheduling (Pullout or First Event).
ClusterOverlapToRule Hard-coded value for the overlap to determine where the overlap will be applied when scheduling (Pullin or Last Event).
MaxClusterEmptyTime Total time that is not scheduled in seconds. Used for the Master Cluster run from which child runs will be created.
MasterEvStrId EventString ID of a Cluster runs Master Cluster.
MirrorEvStrId EventString ID of a run that was mirrored to create this run.
IsBumpRun Indicates whether or not the EventString is a bump run (a run that will take its overflow from other runs).
BumpRule Hard-coded value to determine which Bump rule to use when scheduling.
MaxTrips Maximum number of trips allowed on a bump run. Run must be a bump run.
OverdraftTrips Number of trips allowed that exceeds the MaxTrips. Applies to bump runs.
MaxProviderCost Maximum allowable cost that can be charged to a provider for a bump run.
OverdraftProviderCost Allowable cost that exceeds the MaxProviderCost that can be charged to a provider for a bump run.
ActualSignOnTime Log in time recorded on a device used by the driver when accessing the EventStrings manifest. Value is in seconds from midnight.
ActualSignOffTime Log off time recorded on a device used by the driver. Value is in seconds from midnight.
SignInRequired Indicates the driver is required to log in to the device.
SignOffRequired Indicates the driver must log out when exiting the device.
OrderNo Order number attached to the run.
RequireOrderNo Flag that indicates the run requires an order number.
EligibleForSwapping Flag that indicates the run can change to another vehicle or vehicle type.
LineDirId Direction of the run (0 = Outbound, 1 = Inbound).
MaxEscorts Indicates the maximum number of Escorts the vehicle used for the EventString can have at one time.
SignId Sign-up period identifier (from SignUpPeriods.SignId).
Status Internal use only.
DefaultVehicleId Unique ID of a vehicle that is assigned as the run's default vehicle when scheduling.
IsInPlanningMode Indicates that the EventString record is in Planning Mode. Will not be used.
BankCode Bank/Branch code that will receive donation deposits.
DonationCode Code for the type of donation being made and who will receive the donation.
PreviousVehicleId Unique ID of a vehicle previously assigned to the run.
Deposit Total amount of donations deposited.
StreetValidityCRC Street router validity CRC (Cyclic Redundancy Check) currently being used by this object.
StreetValidityCRC Street router validity CRC (Cyclic Redundancy Check) currently being used by this object for times past midnight (x-time).