-
Notifications
You must be signed in to change notification settings - Fork 30
Configurable Values
sheldonabrown edited this page Jul 30, 2013
·
18 revisions
| Location Key | Meanding | To Change |
|---|---|---|
| config service | Configurable Value in TDM configuration service /api/config/list | Webservice call or via Admin UI |
| application context | XML configured of Spring framework which manages dependencies | Edit file and start web container (i.e., Tomcat) |
| code | A constant embedded in a Java file, often at the top of the file | Code change, rebuild deployment, release |
Key denotes the constant name or configuration value reference.
Default Value is the value as it exists if not changed or overridden.
Description hints at the purpose of the configuration.
All configuration points are listed by the modules they belong to.
| Location | Key | Description | Default Value |
|---|---|---|---|
| configuration file | admin.senderEmailAddress | Send email address of bundle build results | |
| configuration file | admin.instanceId | Instance id (for eg AWS instance id) of the server instance running admin server | |
| application context | admin.chefRole | Chef role identifier for admin module | |
| application context | bucketName | Directory name having bundle building files | |
| application context | gtfsPath | GTFS files location | |
| application context | stifPath | STIF files location | |
| application context | configPath | Configuration directory | |
| application context | buildPath | The directory where a built bundle is stored | |
| code | WAIT_SECONDS | Time to wait for a response when proxying a request to admin server | 120 |
| code | MAX_PING_COUNT | Number of 5 second pings to wait for admin server to boot | 60 |
| code | MAX_ERRORS | Number of consecutive pings that fail to consider server dead | 20 |
| code | DEFAULT_TDM_URL | Default TDM url to use if url is not injected or configured | http://tdm |
| code | BUNDLE_RESOURCE | Application context creating ‘OneBusAway’ services required for bundle building | classpath:org/onebusaway/transit_data_federation/bundle/application-context-bundle-admin.xml |
| code | DEFAULT_STIF_CLEANUP_URL | Script location to clean up STIF data | https://github.com/camsys/onebusaway-nyc/raw/master/onebusaway-nyc-stif-loader/fix-stif-date-codes.py |
| code | DEFAULT_AGENCY | Default agency to use for bundle building | MTA |
| code | DATA_DIR | Directory that stores bundles to be built | data |
| code | OUTPUT_DIR | Directory that holds built bundles | outputs |
| code | INPUTS_DIR | Directory that provides GTFS and STIF files to bundle build process | inputs |
| code | DEFAULT_TRIP_TO_DSC_FILE | File providing trip to DSC mappings | tripToDSCMap.txt |
| code | BUILD_DIR | Directory under output directory that holds built bundles | builds |
| code | CHUNK_SIZE | Buffer size used when writing files to output stream | 1024 |
| code | TRANSIT_FEED | Version of google transit data to download | transitfeed-1.2.11 |
| code | MAX_COUNT | Number of seconds in 5 second increment to poll for bundle build timeout | 3600 |
| code | DEFAULT_OPERATIONAL_API_HOST | Default host name to use for operational API if host name is not configured in configuration service on TDM | archive |
| code | PING_API | API url for remote instance for bundle building | /ping/remote |
| code | LOCAL_HOST | instance id for running admin server locally | localhost |
| code | DEPOT_ID_PATH | Directory that stores depot files | depot_id_map |
| code | DSC_PATH | Directory that stores DSC files | destination_sign_codes |
| Location | Key | Description | Default Value |
|---|---|---|---|
| configuration file | tdm.crewAssignmentRefreshInterval | Time in minutes after which crew assignments are refreshed | |
| configuration file | tdm.vehicleAssignmentRefreshInterval | Time in minutes after which vehicle assignments are refreshed | |
| application context | tdm.chefRole | Chef role identifier for TDM module | |
| data sources | cronExpression | Cron expression for persisting UTS and SPEAR data everyday | |
| code | ROUTE | Column index for route column in DSC CSV File | 1 |
| code | DSC | Column index for dsc column in DSC CSV File | 2 |
| code | MESSAGE | Column index for message column in DSC CSV File | 3 |
| code | TEST_ROUTE_ID | Test route id for service alerts test support | test route id |
| code | ALL_OPERATORS | Constant to add all operators to service alerts list | ALL_OPERATORS |
| code | DEFAULT_BUNDLE_STAGING_DIRECTORY | Default bundle staging directory to use if it is not configured in configuration file | activebundles |
| code | DEFAULT_CONFIG_DIRECTORY | Default configuration directory to use if not configured in configuration service when deploying bundles to TDM | "" |
| code | DEPOT_PATH | Directory of depot id maps on S3. This directory contains depot files | depot_id_map |
| code | DSC_PATH | Directory of destination sign code CSV files on S3 | destination_sign_codes |
| code | STATUS_STARTED | Constant to indicate bundle deploy start status | in_progress |
| code | STATUS_COMPLETE | Constant to indicate bundle deploy complete status | complete |
| code | STATUS_ERROR | Constant to indicate bundle deploy error status | error |
| code | STATUS_STAGING_COMPLETE | Constant to indicate bundle staging complete status | staging_complete |
| code | DEFAULT_DSC_DIRECTORY | Default DSC directory to use if not configured in configuration file | destination_sign_codes |
| code | DEFAULT_DEPOT_ID_DIRECTORY | Default depot directory to use if not configured in configuration file | depot_id_map |
| Location | Key | Description | Default Value |
|---|---|---|---|
| configuration file | operational-api.host | Server name that hosts operational API | |
| configuration file | operational-api.historicalRecordLimit | Maximum number of records returned by operational API | |
| code | MAX_RECORD_LIMIT | Default number of records returned by operational API if not configured in configuration service | 3000 |
| code | DEFAULT_QUERY_TIMEOUT | Default number of seconds to allow query to process before killing | 600 |
| code | LOAD_FACTOR | Percentage of maximum capacity after which cache holding real time records expands its size | 0.75 |
| code | DELAY_THRESHOLD | Maximum delay in milliseconds after which inference queue is considered behind when listening messages | 10000 |
| Location | Key | Description | Default Value |
|---|---|---|---|
| provided by build | front-end.version | Used for JS and CSS cache breaking | |
| configuration file | display.hideTimeout | Number of seconds after which a bus is hidden from users because of not sending messages | |
| configuration file | display.previousTripFilterDistance | The distance beyond which a bus will be filtered out of SIRI SM calls, when on the previous trip, that the monitored call is on | |
| configuration file | display.googleAnalyticsSiteId | The google analytics site ID used for tracking visits to all interfaces | |
| configuration file | display.googleAdsClientId | The google ads site ID used for ads on the we page | |
| configuration file | display.googleMapsClientId | The google maps site ID used when using the google maps enterprise geocoder and styled maps | |
| configuration file | display.staleTimeout | Number of seconds after which data is considered “stale” because the bus is not sending messages | |
| configuration file | display.googleMapsSecretKey | The google maps secret key used when using the google maps enterprise geocoder and styled maps | |
| configuration file | display.stalledTimeout | Number of minutes after which a bus, if it does not move, is considered to not be making progress | |
| config service | display.mapCenterLat | The center latitude for the map when the page first loads. Must also provide display.mapCenterLon and display.mapZoom | |
| configuration file | display.mapCenterLon | The center longitude for the map when the page first loads. Must also provide display.mapCenterLat and display.mapZoom | |
| configuration file | display.mapZoom | The zoom level for the map when the page first loads. Must also provide display.mapCenterLon and display.mapCenterLat | |
| configuration file | createAPIKey | A boolean indicating whether or not to create an ‘OBANYC’ API key on context initialization |
| Location | Key | Description | Default Value |
|---|---|---|---|
| configuration file | inference-engine.outputQueuePort | Port number on which, inference engine connects with output queue for putting processed messages | |
| configuration file | inference-engine.inputQueuePort | Port number on which, inference engine connects to input queue for processing inbound messages | |
| configuration file | inference-engine.inputQueueName | Name of the queue from which, inference engine reads inbound messages | |
| configuration file | inference-engine.outputQueueHost | Server that hosts output queue for inference engine | |
| configuration file | inference-engine.inputQueueHost | Server that hosts input queue for inference engine | |
| configuration file | inference-engine.outputQueueName | Name of the queue on which, inference engine puts processed messages | |
| code | VehicleStateLibrary._layoverStopDistance | How close a bus needs to be to the layover location to be eligible for layover status. (Subject to other layover constraints—e.g. last stop of assigned trip) | 400 |
| code | VehicleStateLibrary._offBlockDistance | How close a bus needs to be to the block to be considered serving that block. | 1000 |
| code | VehicleStateLibrary._terminalSearchRadius | Distance from first/last stop to be considered at a terminal. Checks all trips first/last stops. | 150 |
| code | VehicleInferenceInstance._automaticResetWindow | When updates between records exceed this time, the inference process is reset automatically. (milliseconds) | 20 minutes |
| code | ParticleFactoryImpl._initialNumberOfParticles | The number of particles that should be proposed initially. | 200 |
| code | MotionModelImpl._motionThreshold | Meters the bus needs to move to be considered in motion. | 20 |
| code | MotionModelImpl._essNoRunInfoTransitionThreshold | The effective sample size below which resampling will occur when no run info is available. | 0.60 |
| code | MotionModelImpl._essRunInfoTransitionThreshold | The effective sample size below which resampling will occur when run information is available. | 0.65 |
| code | JourneyStateTransitionModel._remainingTripDistanceDetourCutoff | The minimum-required distance left on the trip to be eligible for detour state. | 280 |
| code | JourneyStateTransitionModel.LAYOVER_WAIT_TIME | The number of seconds which a vehicle cannot move to be eligible for layover status. | 120 |
| code | BlockStateService._tripSearchRadius | Distance in meters to search around the current lat/long for blocks. | 60 |
| code | BlockStateService._tripSearchTimeAfterLastStop | Time in ms to search after the last stop time on the trip, compared against the search time, to determine whether the trip is active. | 5 hours |
| code | BlockStateService._tripSearchTimeBeforeFirstStop | Time in ms to search before the first stop time on the trip, compared against the search time, to determine whether the trip is active. | 5 hours |
| code | BlockStateService._oppositeDirMoveCutoff | If the distance moved backwards exceeds this number, the bus is not considered to have moved backwards (i.e. no check is made against orientation to verify). | 10 |
| code | BlockStateService._requireDSCImpliedRoutes | Set this field to true if you want to require snapped states match the DSC implied Route. | true |
| code | BlockStateService._requireRunMatchesForNullDSC | Set this field to true if you want to only allow snapping to best fuzzy or operator assigned runs, when no valid DSC is available. | true |
| code | BlockStateService._maximumDetourDistanceInMeters | Maximum distance in meters a bus can be away from a route geometry and still be eligible for detour status | 600 |
| code | BlocksFromObservationServiceImpl._tripSearchTimeBeforeFirstStop | Search window for active trips: slop before the start of the trip (ms). | 60 minutes |
| code | BlocksFromObservationServiceImpl._tripSearchTimeAfterLastStop | Search window for active trips: slop after the end of the trip (ms). | 30 minutes |
| code | ParticleFilter._resampleThreshold | Effective sample size, below which resampling will occur. | 0.75 |
| code | ParticleFilter._debugEnabled | Keeps debugging information in memory. | false |
| code | ParticleFilter._maxLikelihoodParticle | Flag for option to use the maximum likelihood particle as reported result. (as opposed to the most likely particle within the most likely phase/trip pair) | false |
| Location | Key | Description | Default Value |
|---|---|---|---|
| configuration file | tds.inputQueueName | Name of the queue, from which transit data service reads inbound messages | |
| configuration file | tds.inputQueuePort | Port number on which, transit data service connects to input queue for processing messages | |
| configuration file | tds.inputQueueHost | Server that hosts input queue for transit data service | |
| code | BUFFER_SIZE | Buffer size when reading records from STIF file | 4096 |
| code | INFERENCE_PROCESSING_THREAD_WAIT_TIMEOUT_IN_SECONDS | Time in seconds to wait for inference threads to exit | 60 |
| code | _fileDownloadRetries | Number of retries for downloading a file from TDM | 2 |
| code | SCHEDULE_WINDOW_BEFORE | Lower bound in milliseconds of schedule window for schedule service (milliseconds) | 15 minutes |
| code | SCHEDULE_WINDOW_AFTER | Upper bound in milliseconds of schedule window for schedule service (milliseconds) | 60 minutes |
| code | NON_REVENUE_MOVE_DATA | Constant for refreshing non revenue moves data when changing bundle on TDM | __non_revenue_moves_data |
| code | NON_REVENUE_STOP_DATA | Constant for refreshing non revenue stop data when changing bundle on TDM | __non_revenue_stop_data |
| code | DESTINATION_SIGN_CODE_DATA | Constant for refreshing dsc data when changing bundle on TDM | __dsc_data |
| code | TERMINAL_DATA | Constant for refreshing terminal data when changing bundle on TDM | __terminal_data |
| code | RUN_DATA | Constant for refreshing dsc data when changing bundle on TDM | __run_data |
| Location | Key | Description | Default Value |
|---|---|---|---|
| code | MAX_SMS_CHARACTER_COUNT | Maximum number of characters allowed in a SMS | 160 |
| code | HTMLIZE_NEWLINES | Indicates whether service alert message descriptions should have html line breaks | false |
| code | SESSION_RESET_WINDOW_IN_SECONDS | Time in seconds after which session is reset | 20 minutes |
| Location | Key | Description | Default Value |
|---|---|---|---|
| code | V1 | Version no. 1 of NYC API | 1 |
| code | V2 | Version no. 2 of NYC API | 2 |
| code | NO_VERSION | Constant to indicate no version is specified for API | -999 |
| code | DEFAULT_SEARCH_RADIUS_WITH_QUERY | Default search radius if radius is not present in the client request | 10000 |
| code | DEFAULT_SEARCH_RADIUS_WITHOUT_QUERY | Default search radius when radius and query fields are not present in the client request | 500 |
| code | MAX_BOUNDS_RADIUS | Maximum search radius when searching trips for location | 20000 |
| code | MISSING_REQUIRED_FIELD | Message given by Struts validator if a required field is missing | missingRequireField |
| code | INVALID_FIELD_VALUE | Error message given by Struts validator if a field has invalid value | invalidFieldValue |
| code | RESPONSE_OK | Response code if request is executed successfully by the server | 200 |
| code | RESPONSE_INVALID_ARGUMENT | Response code if there are validation errors when processing the request | 400 |
| code | RESPONSE_UNAUTHORIZED | Response code if the user is not authorized to use the API | 401 |
| code | RESPONSE_RESOURCE_NOT_FOUND | Response code when resource is not found on the server | 404 |
| code | RESPONSE_OUT_OF_SERVICE_AREA | Response code for out of service area | 440 |
| code | RESPONSE_SERVICE_EXCEPTION | Response code if there is an internal server error when processing the request | 500 |
| Location | Key | Description | Default Value |
|---|---|---|---|
| code | PUBLISHER_KEY | Publisher key of bhs queue | bhs_publisher |
| code | DEFAULT_BHS_QUEUE | Default queue topic if none configured | bhs_queue |
| code | DEFAULT_PROTOCOL | Default queue protocol if none configured | tcp |
| code | DEFAULT_HOST | Default queue host if none configured | * |
| code | DEFAULT_PORT | Default queue port if none configured | 5563 |