PassInfoServer Context Properties
The following table explains the PASSInfoServer context properties that are used in PASS-Web:
| Property | Description |
|---|---|
| Maximum number of days ahead of the travel day that a casual booking can be created by a client. | |
| If selected, clients are allowed to book new trips on the same day as the travel day. | |
| If selected, clients are allowed to book a new trip on business days only.
This feature is for calculating the days window for PASS-Web or IVR. |
|
| SubType abbreviation if AllowSameDayBooking is selected and a special SubType is required for same day bookings created through the Web. | |
| If selected, clients are allowed to book a new trip only on the days loaded before by the Schedule Server. | |
| If selected, the client's suspended days are excluded from available booking dates. | |
| If selected, a flag is sent back to the client that represents the property’s policy on allowing an unscheduled booking to be canceled by a Web client. | |
| If selected, a flag is sent back to the client that represents the property’s policy on allowing an unscheduled booking to be scheduled by a Web client. | |
| If selected, a flag is sent back to the client that represents the property’s policy on allowing a scheduled booking to be scheduled by a Web client. | |
| If selected, a flag is sent back to the client that represents the property’s policy on allowing a scheduled booking to be canceled by a Web client. | |
| Start of a Monday window of drop-off booking times. | |
| Close of a Monday window of drop-off booking times. | |
| Start of a Tuesday window of drop-off booking times. | |
| Close of a Tuesday window of drop-off booking times. | |
| Start of a Wednesday window of drop-off booking times. | |
| Close of a Wednesday window of drop-off booking times. | |
| Start of a Thursday window of drop-off booking times. | |
| Close of a Thursday window of drop-off booking times. | |
| Start of a Friday window of drop-off booking times. | |
| Close of a Friday window of drop-off booking times. | |
| Start of a Saturday window of drop-off booking times. | |
| Close of a Saturday window of drop-off booking times. | |
| Start of a Sunday window of drop-off booking times. | |
| Close of a Sunday window of drop-off booking times. | |
| Start of the daily window of drop-off booking times. | |
| Close of the daily window of drop-off booking times. | |
| Start of a Monday window of drop-off booking times. | |
| Close of a Monday window of pick-up booking times. | |
| Start of a Tuesday window of pick-up booking times. | |
| Close of a Tuesday window of pick-up booking times. | |
| Start of a Wednesday window of pick-up booking times. | |
| Close of a Wednesday window of pick-up booking times. | |
| Start of a Thursday window of pick-up booking times. | |
| Close of a Thursday window of pick-up booking times. | |
| Start of a Friday window of pick-up booking times. | |
| Close of a Friday window of pick-up booking times. | |
| Start of a Saturday window of pick-up booking times. | |
| Close of a Saturday window of pick-up booking times. | |
| Start of a Sunday window of pick-up booking times. | |
| Close of a Sunday window of pick-up booking times. | |
| Start of the daily window of pick-up booking times. | |
| Close of the daily window of pick-up booking times. | |
| Default interval in minutes between each booking time returned by booking times methods. | |
| Minimum time in minutes between the current time and the requested time for a new
booking. Used to prevent clients from booking trips too close to the current time. |
|
| The available time (in time format) to specify whether the last booking day is an allowable booking day, for example, available time = 8:00, maximum days in advance = 2. If before 8:00, the 2nd day in advance is not valid to book, so the maximum days in advance is 1. If after 8:00, the 2nd day in advance is valid, so the maximum days in advance is 2. | |
|
|
| Number of days in advance the restriction should be applied for the Absolute time mode. | |
| Cutoff time of the day for the Absolute time mode. | |
| Used to calculate the window of valid booking times for a return trip; the minimum time in minutes that a client is required to spend at the chosen destination before being allowed to return. | |
| Logic used by PassBookingTimesWindow() to determine if any time can be returned. | |
| If selected, this property overrides times set in the and properties and matches polygon times (even if they fall outside these
windows). The OverrideWindowWithPolygonTime property returns the open and close times of the polygon from 0:00 to 24:00. |
|
|
|
| Number of days before the pick-up that the absolute time will be applied to.
Used only if TimeMode is set to Absolute. |
|
| Cancellations after this time on the day specified by DaysBeforePickup will be
considered late. Used only if TimeMode is set to Absolute. |
|
| Minimum number of minutes before trip pick-up time that a cancellation may be
made through the service. Set to 0 to disable this feature. |
|
| Minimum number of minutes before trip pick-up time that a cancellation may be
made by a driver through the service. Set to 0 to disable this feature. |
|
| If selected, cancel late tolerance will be used. | |
| If selected, weekends will be excluded when checking for late
cancellations. Must be used with Absolute time mode. |
|
| If selected, holidays will be excluded when checking for late
cancellations. Must be used with Absolute time mode. |
|
|
|
| Number of days before the pick-up that the absolute time will be applied to.
Used only if TimeMode is set to Absolute. |
|
| Cancellations after this time on the day specified by DaysBeforePickup will be
considered late. Used only if TimeMode is set to Absolute. |
|
| If a trip is canceled within this many minutes before the requested pick-up time
or any time after, the service will attempt to cancel it late (schedule status CL).
Used only if the time mode is set to Relative. |
|
| If the trip is canceled within this many minutes before the requested pick-up time or any time after, the booking will be stamped as a NoShow (schedule status NS). | |
| If the trip is canceled within this many minutes before the requested pick-up time or any time after, the booking will be stamped as a cancel at door (schedule status CD). | |
| If selected, the schedule status ID will be overwritten for canceled trips. | |
| Trip cancellation status code for late cancellations. | |
| Trip cancellation status code for in-advance cancellations. | |
| Trip cancellation status code for same day cancellations. | |
| Trip cancellation status code for at-the-door cancellations. | |
|
Check schedule status:
|
|
| Trip cancellation status code for no-show cancellations. | |
| If selected, bookings will be stamped CS if the client cancels the trip on the same day that the trip is to be taken. | |
| If selected, bookings will be stamped CS instead of CL if the client cancels the trip on the same day that the trip is to be taken but at a late time. | |
| Trip time to be used in comparisons to the current time when calculating the new SchedStatus during a CancelTrip request. | |
| If selected, a confirmation number will be generated for each cancellation. | |
| If selected, then new clients will be automatically marked as Active. This property is stored in the database. |
|
| If selected, then the ATIS faring server will be called for a booking that has just been successfully saved during a PassCreateTrip call. | |
| Subtype abbreviation to stamp bookings with when no ATIS faring solution is found. | |
| The Trip cancel code for ATIS server call failure. | |
| UserLong field (minus 1) to use for staring ATIS trip start times in Booking records. | |
| UserDouble field to use for storing ATIS trip start times in Booking records. | |
| UserDouble field to use for storing ATIS reduced fares in Booking records. | |
| UserString field to use for storing ATIS start times in Booking records. | |
| User String field for storing ATIS routes in Booking records. | |
|
Fare amount to save to a client’s companion:
|
|
|
Fare amount to save to clients:
|
|
| Client fare type when faring a booking by ATIS. | |
| Companion fare type when faring a booking by ATIS. | |
| If selected, the CreateTrip method will not auto-schedule a booking unless a successful ATIS faring call is made. | |
| Start of a Monday window of booking trip access times. | |
| Close of a Monday window of booking trip access times. | |
| Start of a Tuesday window of booking trip access times. | |
| Close of a Tuesday window of booking trip access times. | |
| Start of a Wednesday window of booking trip access times. | |
| Close of a Wednesday window of booking trip access times. | |
| Start of a Thursday window of booking trip access times. | |
| Close of a Thursday window of booking trip access times. | |
| Start of a Friday window of booking trip access times. | |
| Close of a Friday window of booking trip access times. | |
| Start of a Saturday window of booking trip access times. | |
| Close of a Saturday window of booking trip access times. | |
| Start of a Sunday window of booking trip access times. | |
| Close of a Sunday window of booking trip access times. | |
| If selected, then calculation of the ReqTime of the pick-up is based on the trip time-distance against the ReqTime of the drop-off and then the ReqTime of the drop-off will be moved to ReqLate. | |
| If selected, then calculation of the ReqTime of the pick-up uses only the average
speed. If cleared, then the MaxOBT and factors tables will be used. |
|
| If selected and a denial exists that matches a new booking, then it will be superseded by the new booking upon saving. | |
| Early tolerance when comparing requested times of denials and new bookings. | |
| Late tolerance when comparing requested times of denials and new bookings. | |
| If selected, then testing will not stop at the first test that denies the trip. | |
| The outcome when there are no tests for the eligibility condition. | |
| The outcome when the perform tests is set to No for the test condition | |
| Precedence order of eligibility tests. | |
| Custom method name of eligibility tests. | |
| If selected, the tests of all client conditions are concatenated and tested together. | |
| Default pick-up solution set of eligibility tests. | |
| Default drop-off solution set of eligibility tests. | |
| Default eligibility test solution set. | |
| If selected, eligibility test swill be performed for all new bookings. | |
| Sets the logic used by PassCreateTrip() to determine if the trip can be booked.
For more information, contact Customer Care. |
|
| Sets the logic used by PassCreateTrip() to determine which funding source is used
to pay for the trip. For more information, contact Customer Care. |
|
| Sets the logic used by PassCreateTrip() to determine the subtype abbreviation of
the booking. For more information, contact Customer Care. |
|
| Sets the logic used by PassCreateTrip() to determine if a trip can be scheduled.
For more information, contact Customer Care. |
|
| PerformCheck | If selected, ADA polygons and provider security will be checked on each newly-created booking. |
| If selected, this service will not save new bookings that fail booking verification. | |
| If selected, then the service will not allow the creation of a booking that would overlap with an already existing scheduled booking by the same client. | |
| Minimum amount of time in minutes that must exist between a new trip’s requested time and the pick-up time of an existing booking of the same client to prevent overlap. | |
| Minimum amount of time in minutes that must exist between a new trip’s requested time and the drop-off time of an existing booking of the same client to prevent overlap. | |
| If selected, then the service will not allow the creation of a booking that would
overlap with an already-existing unscheduled booking by the same client. Works with CheckForTripOverlap. |
|
| If selected, then the trip purpose of a booking must be greater than 0 (that is, a valid booking purpose). | |
| If enabled, stores PU and DO legs addresses in upper case. | |
Use bitwise operation to exclude validation checks. Exclude multiple checks by
adding these numbers. For example, 2 + 4 = 6 to
exclude ADA and Service Area.
|
|
Passengers |
Maximum number of additional passengers allowed during trip booking. |
| If selected, then the provider ID of the client in a new booking must be greater than 0 (that is, a valid provider). | |
| Minimum authorization number length. | |
| If selected, then eligibility dates of funding sources for a new booking will not be checked. | |
| If selected, then the booking purpose must match at least one of the funding source purposes when creating a booking. | |
| If selected, then clients will not be checked for suspension or eligibility. | |
| If selected, then inactive clients will not be allowed to create trips. | |
| If selected, then clients will not be checked for suspension or eligibility. | |
| If selected, then the origin and destination of a new trip must fall in at least one funding source polygon. | |
| If selected, then the time requested will be compared to the valid ADA polygon times for the pick-up and drop-off polygons. | |
| If selected, then all passengers on a trip must have a valid fare type (that is, a fare type greater than 0). | |
| If selected, then all points of a trip must be correctly geocoded. | |
| If selected, then clients who wish to book a trip must have at least one eligibility condition defined. | |
| If selected, then client eligibility rules will be enforced for all new bookings. | |
| If selected, then at least one passenger must have a Passenger Type equal to the client’s default passenger type. | |
| If selected, then load and unload times from various sources (for example, request, client record, address or location, space type, and paraservice ID) will be summed into BookingLeg records. Otherwise, only the load-unload time from the request will go into booking legs. | |
| If selected, then a new booking must have a valid paraservie ID. For example, from request, the client record, or an eligibility rule. | |
| If selected, then prepayment for all new bookings of the client will be skipped if the client’s record is set as Prepayment Not Allowed. | |
| If selected, the default companion settings in the client record are ignored and
the maximum number of additional passengers defined in the context property is enforced. If IgnoreClientCompanionSetting is cleared, the default companion settings in the client record are respected and the MaximumNumberOfAdditionalPassengers is added to the existing default number of companions. This property is selected by default. |
|
| Maximum number of trips allowed for a client on a given LDate. Subsequent trip creations will not be allowed by the PassCreateTrip method. Set to 0 to disable this feature. |
|
| Maximum number of trips allowed to be created by a given client each day.
Subsequent trip creations will not be allowed by the PassCreateTrip method. Set to 0 to disable this feature. |
|
| If selected, then the GetClientInfo method returns a flag to indicate when the client is conditionally eligible and that new bookings are not allowed to be created. | |
| If selected and DO (drop-off) Logic is used, then the requested pick-up time will
be moved outside of the drop-off early/late window (if ReqDoEtAdj > TravelTime). If cleared, then the system will use TravelTime only to calculate the requested pick-up time. |
|
| Subtype abbreviation to stamp bookings when they are first created. | |
| If selected, then paraservice area rules will be checked. | |
| If selected, then Req DO Logic adds Direct To Adj. | |
| If cleared, then only the client’s first funding source will be defaulted. | |
| If selected, then when logged in as a worker, the Escort selection will be shown on the Book a Trip page, and the Escort will be viewed on the Trip Detail page. | |
| If selected, then a fixed route alternative will be found and displayed for the user’s trip. | |
| Specifies valid passenger types. When empty, all passenger types are valid. Otherwise, trips can only be created using the specified passenger types (comma-delimited string). Note that when companion mode is "D" and the client's default companion is considered invalid, PassCreateTrip will fail. |
|
Determines how to handle phone numbers when booking trips using PassInfoServer
(that is, Trapeze6). For example, when using the Book Trip screen in PASS-Web.
|
|
| The same booking cannot be created within this number of minutes from the last time the booking was denied by Schedule Server. | |
| If selected, then the top up account module is accessible by users. | |
| If selected, the subscription function is enabled. | |
| First day of the week in a week template (also referenced by the PASS-Web calendar display) | |
| Schedule type ID used in live schedules. | |
| Schedule type ID used in template schedules. | |
| If selected, mobility aids are selectable by users. | |
| Default passenger type of a client for a new booking if a client’s record does not specify one. | |
| Default space type of a client for a new booking if a client’s record does not specify one. | |
| Passenger type of a client’s companion for a new booking if the client’s record does not specify one. | |
| Space type of a client’s companion for a new booking if the client’s record does not specify one. | |
| Fare type of a client’s companion for a new booking if the client’s record does not specify one. | |
| Default fare type for a passenger record when no others are available. | |
| Average speed for trip duration calculations in kilometers per hour (kph). | |
| ADA polygon type ID setting for the property. | |
| Jurisdiction polygon type ID setting for the property. | |
| Speed zone polygon type ID for the property. | |
| Service parameter polygon type ID setting for the property. | |
| Paraservice parameter polygon type ID setting for the property. | |
| Service area polygon type ID setting for the property. | |
| Default security group setting for the property. | |
| Name of the address type that represents a client home address. Typically, this is CH in North America. | |
| Name of the address type that represents an employee home address. Typically, this is EH in North America. | |
| Default booking subtype abbreviation. | |
| Booking subtype for solutions with transfers in it. | |
| Subtype that will cause bookings to be automatically unscheduled if updated to this subtype. | |
| Worker associates clients by the selected table. | |
| IVR survey from-date in RAW date format (YYYYMMDD). If set to 0, the survey from-date will not be checked. |
|
| IVR survey to-date in RAW date format (YYYYMMDD). If set to 0, the survey to-date is today. |
|
| If selected, can create will call bookings with given SubType (will not validate ReqTime for will call bookings). | |
| If selected, then comments will be displayed in PASS-Web. For example, on the booking screens and view trips screens. |
|
| If cleared, then clients can override existing comments or enter new comments if
there were originally no comments. If selected, comments are read-only. |
|
| If selected, then comment fields will be automatically filled in with comments
from the selected booking locations if they exist. If cleared, then comment fields will always be blank to start with. |
|
| Email address for client registration. | |
| Email address to receive feedback submissions; multiple email address may be
entered, separated by a semicolon (;). The default value is “ (a single quotation mark) and is stored in the database. |
|
| Recipient of emails for customer subscriptions, particularly with canceling, holding, or adding subscriptions. | |
| Network location of email server. | |
| Comma-separated list of eligibility conditions with the WebEnabled flag set to 1.
If any of the user’s web-enabled conditions match any of the conditions in this property, the Book Trip option will be displayed, but repeat trips will be allowed. The default value is " (a single quotation mark) and is stored in the database. To enable an easy-to-use checklist of options, in the Client Shell, click , click the Screen Modules tab. Select the check box beside Cmn_Cli_CommonScreens, and then restart the Client Shell. |
|
| If selected, then the default provider is retrieved from the ClientProvider
table. If cleared, the providerID in the Clients table is used. |
|
| If selected, then the provider message with a specific ProviderId will be displayed on the View Trip Page. | |
| If Enabled is selected, then the provider message with this ProviderId will displayed. | |
| Provider name corresponding to the ProviderId. | |
| Corresponding ProviderId message to be displayed if Enabled is selected. | |
| Provider message will appear only after this ShownTime (raw time) on the day before the trip. | |
Defines how client trips should be sorted:
The default setting is Sort by oldest trips first. |
|
| Maximum number of records that will be returned by a call to GetClientTrips.
If any query produces more, an error will be returned instead. |
|
| Number of days from the current date for which GetClientTrips will search for active subscriptions. Set to 0 to report to the end of next month. | |
| Number of months, excluding the current month, to look back for previous trips on
the View Trips page. For example, if the current month is April, the value 3 lets the user select months going back to and including January. Set to 0 to set the earliest date to January 1990. The default is 0 and is stored in the database. |
|
| Precedence order used when selecting trip times to be displayed by browsers.
If Sch/Neg/Req are all blank, EstTime will be used if available. |
|
| If selected, then in the GetClientTrips response, then the value of the SchTime field will be that of the UserTime1 field when not empty. | |
|
If selected, PassInfoServer will return results for both the current day and the previous day (when the trip time is 24:00 or greater). For example, a trip scheduled on November 29 at 26:00 would be included in the results for November 30. If cleared, the system maintains the old behavior. This property is cleared by default. |
|
| Trips on the ViewTrips page will not be shown if the subtype abbreviation is equal to this value. If blank, no trips will be hidden. | |
| If selected, then a valid password is required to log in before any service requests are allowed. A valid password can contain no characters. | |
| If selected, passwords are required to use at least one special character.
Acceptable characters are as follows: \~`!@#$%^&*()-_+={}[]|;:<>,./?" |
|
| If selected, reset password for web logic is enabled. | |
| Lists the characters that cannot be used in a client password. | |
| Specifies the minimum length of the client’s password. | |
|
Specifies the constraints of the client’s password:
|
|
| Specifies how many previous client passwords are to be stored in the ClientPasswordHistory table. | |
| The number of days a password is valid before the user needs to change or reset it. If set to 0, passwords never expire. | |
| Port number that the Schedule Server is listening on. | |
| IP address of the Schedule Server. | |
| Tolerance early for drop-off leg when a new booking is saved. | |
| Tolerance late for drop-off leg when a new booking is saved. | |
| If selected, then this service will delete bookings that fail to schedule. | |
| If selected, the service will delete bookings when scheduling solutions are requested for it but are not found. | |
| Tolerance early for pick-up leg when a new booking is saved. | |
| Tolerance late for pick-up leg when a new booking is saved. | |
| Schedule parameter set name. | |
| Schedule violation set name. | |
| If selected, then booking’s negotiated times will be synchronized with its requested times during its creation as if the client had agreed to the booking. | |
| If selected, then booking’s negotiated times will be synchronized with its scheduled times during its creation as if the client had agreed to the booking. | |
| If selected, then tolerances will be applied to drop-off requested times when implicitly synching requested or negotiated times. | |
| Subtype abbreviation to be set for bookings when no scheduling solutions are found. | |
| If selected, then the booking record will be stamped with the provider that was specified by its scheduling solution. | |
| If selected, then solutions will be filtered for duplicate scheduled times and number of transfers. | |
| If selected, then extra information like RunName and Violations will be returned with any scheduling solutions that are found. | |
| If Off, then ESW and LSW parameters will be forced to 0 when scheduling a booking. | |
| If selected, then clients will be allowed to schedule trips. If cleared, clients are not allowed to schedule. |
|
|
Whether to enforce client providers:
|
|
| If selected, then available runs will be filtered by the logged in user’s security group. | |
| Sets the logic used PassSaveSolution() to determine if a trip can be scheduled.
For more information, contact Customer Care. |
|
| Comma-separated list of dates in MMDD format of possible end dates for
subscriptions. If the user is not allowed to select an end date for a subscription, this list will be used. Otherwise, this property should be left empty. |
|
| If selected, then the current date is within the EnableRenewNumDaysBeforeExpire
and DisableRenewNumDaysBeforeExpire range. A button will be displayed for the user to automatically renew the subscription. |
|
| Number of days before a subscription expires to begin displaying a Renew
Subscription button to the user. Set to 0 to always display the button. The default value is 30. |
|
| Number of days before a subscription expires to stop displaying a Renew
Subscription button to the user. Set to 0 to always display the button. The default value is 14. |
|
| All subscriptions will be created with the IsPending flag set to this value. |