User errors¶

When it comes to user facing errors, the majority of the time it comes down to invalid configuration in the creation of the YAML files. Verification involves making sure that all files are inputted currently, no typos, correct values, correct file structure and many more. The errors below are categorized by their varying components; the gateways, the Process Manager or the processes themselves (TP, IDB, etc.).

Config exceptions¶

Error names	Description	Suggested actions
NoConfigurationException	There is no matching file in either the pipeline or default configuration folders.	Check logs for the location of the incorrect file.
InvalidFileForConfigLoadException	Missing/incorrect config file.	Context within the logs should give some information as to what exactly it is.
InvalidRegexForConfigFindException	Failed to load file due to no regular expression available.	Context within the logs should give some information as to what exactly it is.
ProcessInformationNotSetException	No process information set for pipeline.	Ensure that there is process information set in your pipeline YAML.

Dashboard exceptions¶

Error names	Description	Suggested actions
InvalidDashboardTargetException	No Dashboard target.	Make sure that the dashboard is set to the correct connection; for more information see accessing Refinery via dashboards.

Data exceptions¶

Error names	Description	Suggested actions
InvalidDataPipelineNameException	Pipeline name is not a symbol.	Check that you are using the correct pipeline name; check the pipeline YAML file and use the name as seen in the system YAML example.
InvalidDataPipelineInstanceException	Invalid pipeline instance.	Make sure pipeline instance in your pipeline is a whole number; follow creating pipelines for an example pipeline.

Entrypoint exceptions¶

Error names	Description	Suggested actions
InvalidLegacyRoutesConfigurationException	No legacy routes found on disk.	Legacy routing should be disabled or add a legacy routes file under state-config, check out entrypoint pipeline config for more info.
EntrypointConfigurationFailureException	Fails due to an empty object for the data heirarchy values in the system YAML file.	Modify the data hierarchy in the system YAML file to contain values of parameters that you want your tables to be categorised in.
EntrypointConfigurationFailureException	Fails due to an empty dictionary in the config related to the system that the current process is running in.	Modify pipeline YAML file so that the processes have the correct values. Check out creating pipelines for pipeline examples.
InvalidPipelineConfigurationException	The specified configuration in the logs does not exist.	Verify the pipeline YAML is set up correctly.
InvalidPipelineNameException	A pipeline parameter is invalid or the pipeline does not exist.	Verify that the pipeline name is at the top of the pipeline YAML.
MultipleMatchingSchemasException	There are multiple schemas that match the specified taxonomy and table name.	Modify the schema YAML to have only one table name and one taxonomy.
NoMatchingSchemaException	No schemas found matching your taxonomy and table name.	Modify the schema YAML to have only one table name and one taxonomy.
InvalidTableNameException	Table name in schema YAML is incorrect.	Validate that table name in the schema YAML is correctly assigned.

Gateway exceptions¶

Error names	Description	Suggested actions
InvalidArgumentsForGatewayException	Arguments in the function dictionary are empty.	Argument parameter must be non- empty dictionary, see gateway.
InvalidFunctionForGatewayException	Function is a null symbol.	Function variable must be a symbol, see gateway.
InvalidTargetGatewayException	Target gateway is a null symbol.	Target gateway name must be a symbol, see gateway.
NoAvailableGatewayException	No gateways available to be connected to.	Use the refinery process manager CLI command to restart the process manager.
NoGatewaysAvailableException	Failed to select gateway from current process information.	Check logs for faulty function and arguments in question, see gateway.
NoDataAvailabilityException	There is no data in the system for the query supplied.	Check that the pipelines are up, the routing status with refinery failover CLI command, and that there should be data for the query requested.
InvalidGatewayRegistrationException	The name of the gateway and/or the gateway config are invalid parameters.	Check logs and pipeline status using pipeline CLI commands.
InvalidGwExecuteTypesException	Invalid types of the queryID (guid), inputted function (symbol) and inputted arguments (dict).	Make sure that these parameters are the correct type.
NoProcessNameForGwException	Could not get a process name for a gateway.	Either configuration or system state issue. Consult logs and confirm health of pipelines and use refinery failover CLI command.
InvalidProcessStatusException	Process has returned invalid status.	Validate health of process using logs.
InvalidPipelineStatusException	Parameter that notifies all GWs of an update to the current process pipeline instance is invalid.	Validate health of pipelines using logs.
GwDownstreamProcessErrorException	Downstream process registration failed.	Check logs for the process that failed and the error occuring.
GwDownstreamProcessInvalidResponseException	Invalid dictionary keys.	Check logs for more information.
GwInvalidDownstreamProcessException	A process that the gateway does not have details for has attempted to register.	Make sure that the whole system has been restarted since any pipeline config changes.
InvalidGwFunctionException	Function is a null symbol.	Ensure correct gateway query structure, else check gateway logs if still failing.
InvalidGwClientModeException	ClientMode not in gateway config client modes list.	Gateway client modes must be one of local, sync, async or qr.
NoInstancesForFailoverException	No other instances available for pipeline. Check logs for failover information.	Use refinery failover CLI command to check the status of instances.
PrimaryTargetAlreadyFailedException	Specified target pipeline instance has already failed. Cannot update primary configuration / One or more processes in the target pipeline instance have already failed.	Check Logs for further information and for affected processes.
InvalidPrimaryTargetException	No instance to switch to being primary that matches request.	Check that instance target to swap to being primary is up and running, using the refinery failover CLI command and the refinery pipeline CLI command.
InvalidPrimarySourceException	No currently "primary" targeted process for given pipeline.	Start/restart your pipeline, using the refinery pipeline CLI command.
InvalidProcessException	Number of available process instances are 0 resulting in failure.	Check out the process layout for more information.
TargetInstanceProcessNotAvailableException	One or more target processes are not available. Cannot update primary configuration, check logs for exact error.	Start/restart your pipeline, using the refinery pipeline CLI command.
InvalidPipelineException	Number of available pipeline instances are 0 resulting in failure.	Look into how to create pipelines.
GwPostProcessingFailedException	Gateway post-processing event handler has failed.	Check logs for more information.
InvalidDateArgumentsException	Invalid GW request.	End date must be after start date.
GwInvalidProcessDataUpdateException	Invalid data availablity update.	Check logs of process sending the call for more info.

Monitoring exceptions¶

Error names	Description	Suggested actions
InvalidIntervalException	Invalid timespan value.	Timespan needs to be of type "n" and the value must also be 0D or greater. See here for the different q data types.
InvalidMetricFunctionException	The metric function is not a symbol.	Within the Monitoring Daemon, clarify the name of your metric function .
ProcessAlreadyRegisteredException	Duplicate registration received but already registered with another daemon. Ignoring Current Daemon: check logs.	Verify the registration of the process just called.
InvalidHostnameTypeException	The specified hostname is not a string.	Make the hostname a string.
InvalidPortException	The specified port is not greater than 0.	Correct the port value.
InvalidPortTypeException	The specified port is not an integer.	Correct the port type.
InvalidDataTypeException	Monitoring tables data type is invalid.	One of 'process' or 'system' depending on the type required needs to be a symbol, see monitoring for more.

Pipeline processes exceptions¶

HDB¶

Error names	Description	Suggested actions
HdbReloadFailedException	The HDB load failed or missing partition building failed.	Check logs for the error.

IPDB¶

Error names	Description	Suggested actions
NoConfigurationException	No configuration from Process Manager.	Look into how to create pipelines.
InvalidIpdbWriteRowFrequencyException	Invalid value, value is not a positive whole number.	Modify IPDB row frequency to be a positive whole number.
InvalidIpdbWriteTimerFrequencyException	Invalid timespan value, value is negative.	Modify IPDB timer frequency to be a positive timespan value.
MultipleIpdbsNotSupportedException	Only one intra-day PDB per pipeline supported.	Modify pipeline YAML file to contain 1 instance of an IPDB

PDB¶

Error names	Description	Suggested actions
PdbConfigurationException	PDB configuration is invalid.	Verify that your pipeline YAML file structure is correct, look into how to create pipelines.

Process exceptions¶

Error names	Description	Suggested actions
InvalidSystemConfigurationException	Invalid data hierarchy in system pipeline.	Look into how to create pipelines.
InvalidPipelineConfigurationException	Invalid pipelines.	Look into how to create pipelines.
ProcessIdNotSetException	Process self ID is not set, cannot add processes.	Verify that the pipelines are set up correctly.
NoHostPortForProcessException	Process isn't running, even though it's registered. It may not necessarily be the process you're trying to hit being not registered, it's anything that the metadata matched.	Ensure that `ALL` pipelines defined in YAML are running. Also verify target process is running using refinery pipeline CLI commands. Reboot pipelines once Gateway is up if the error is stil occuring
ProcessConnectionFailedException	Connection to the process fails.	Verify that target process is running using refinery pipeline CLI commands.
ProcessDataHierarchyNotSetException	System data hierarchy is not set. Cannot add processes.	Modify system YAML to contain data hierarchy, look into how to create system pipelines.
InvalidPipelineInstanceToGetException	Invalid pipeline instance in process.	Make sure that pipeline instance is a whole number, check logs.
InvalidPipelineToGetException	Invalid pipeline name in process.	Make sure that pipeline name is a symbol, check logs.
InvalidProcessTypeToGetException	Invalid process type received.	Make sure that you're specifying process type as symbol.
NoMatchingProcessesForConnectException	Connection to pipeline is broken.	Verify the health of all pipelines. Check that all processes are running and no other log errors are occuring using refinery pipeline CLI commands.

Process Manager exceptions¶

Error names	Description	Suggested actions
JournalReplayWithIDBException	Can't have a pipeline containing an RDB and IDB along with `journal-replay-on-restart` being set to true.	Modify the `journal-replay-on-restart` setting to be false. To restart the RDB after failure occurs, execute the CLI command `refinery pipeline --recover-rdb`.
ProcessManagerConnectionFailedException	Failed to connect to any configured Refinery Process Managers.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
InvalidProcessManagerTargetException	Some of the values in the host/ports list are not a host/port.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
NoProcessManagerConnectionException	Connection to pipeline is broken.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
NoProcessManagerConnectionInfoException	No Refinery Process Manager host/ports defined. Cannot connect.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
ProcessManagerConnectionFailedException	Failed to connect to any configured Refinery Process Managers.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
ProcessManagerRegistrationException	Refinery Process Manager rejected the registration request.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
NullPipelineTypeException	Invalid pipeline type.	Verify that your pipelines are set up correctly (see create pipelines).
NoActiveProcessManagersException	Can't find any Process Managers.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
NoSystemConfigurationException	No system configuration folders exist on disk. Cannot start Process Manager.	Make sure that there is a valid Config folder available (see create pipelines).
InvalidPipelineInstanceException	Check the logs for the instance(s) that do not exist for pipeline(s).	Modify pipeline to contain missing instance(s) (see create pipelines).
PipelineInstanceAlreadyRunningException	Not booting pipeline that has some running processes.	Stop the pipeline or force-start offline processes.
PipelineInstancesNotRunningException	No processes from instance(s) of the pipeline are running; check logs for specific instances and pipelines that are erroring.	Restart application using refinery application CLI commands.
SubscriptionFromProcessManagerClientException	Subscription from Process Manager failed.	Restart the Process Manager using PM CLI commands. If that's still not working restart the application using refinery application CLI commands.
InvalidPipelineConfigException	There are missing required keys in the config.	Verify that the pipelines are set up correctly.
NoSystemConfigurationException	No system configuration loaded. Cannot load pipeline configuration yet.	Verify that the process is running by using the Refinery Service Class CLI commands and then boot/reboot the Process Manager using PM CLI commands.
InvalidPipelineYamlFileException	Invalid pipeline YAML file.	Verify that the pipelines are set up correctly.
PipelineConfigurationAlreadyLoadedException	The pipeline configuration has already been loaded and this function is called again.	Must restart the process to load in new pipeline on the process manager. To reboot the Process Manager use the PM CLI commands.
InvalidSchemaYamlFileException	Invalid schema YAML file.	Validate that the schema YAML is correct.
DuplicatePipelineNameException	Pipeline already exists.	Modify pipeline name to be unique (see here for a pipeline example).
InvalidPipelineException	Invalid pipeline, check logs for the process registered in unexpected pipeline.	Verify that the pipelines are set up correctly.
InvalidRealtimePipelineConfigurationException	One or more 'realtime' pipelines have no schemas associated with them (via taxonomy): check logs.	All realtime pipelines have to have at least one schema associated with them (otherwise they won't start up).
InvalidRealtimePipelineException	Invalid realtime pipeline YAML file.	Both IPDB and EPDB must exist for peristence.
ReservedPipelineNameException	Pipeline name, check logs, is reserved for non refinery-process based pipelines.	Modify pipeline name to not be the same as a reserved name.
InvalidPortException	Process running on incorrect port.	Check logs for expected and actual ports.
DuplicateProcessException	Duplicate processes found.	Remove duplicate processes from your Process Manager.
InvalidProcessException	Received registration from unknown process; check logs for unknown process.	Check processes in the Process Manager config.
ProcessOnIncorrectHostException	Process running on incorrect host.	Check logs for expected and actual hosts.
InvalidSchemaConfigException	Invalid column configuration - 'name' is missing from some columns.	Verify that the schema YAML is correct.
ExistingTaxonomyException	Taxonomy already existing for pipeline(s); check logs to identify invalid pipelines.	Verify that the taxonomy in the pipeline and schema YAMLs are set up correctly.
InvalidTaxonomyTypeException	Invalid taxonomy configuration.	Verify that the taxonomy in the pipeline and schema YAMLs are set up correctly.
MissingTaxonomyValueException	Invalid taxonomy configuration.	Verify that the taxonomy in the pipeline and schema YAMLs are set up correctly and make sure that taxonomy has a value.
TaxonomyExistsForTableException	Taxonomy already exists for the table, check logs for erroring table.	Verify that the taxonomy in the pipeline and schema YAMLs are set up correctly; no duplicates allowed.
InvalidColumnTypeException	Check logs for invalid data type for column(s).	Valid data types can be found in the logs.
UnknownSettingException	Not all settings being parsed is known via the json schema; check logs for more info.	Verify that the schema YAML is correct and there are no typos.
ExtraTaxonomyValueException	Invalid taxonomy configuration.	Must only contain taxonomy variables in the pipeline YAML file.

Schema exceptions¶

Error names	Description	Suggested actions
InvalidTableConfigurationException	Table components are incorrect.	Verify that the schema YAML is correct.
InvalidTableNameException	Table name is incorrect.	Verify that the schema YAML is correct.
InvalidTableSchemaException	Table format/schema is incorrect.	Verify that the schema YAML is correct.
TableAlreadyExistsException	Table of the same name already exists and overwrite is set to false.	Check logs for invalid table and modify table schema if you wish to overwrite schema YAML.
TableAlreadyExistsInRootNamespaceException	There is an object in the root namespace with the same name as the table.	Check logs for invalid table and modify table schema if you wish to overwrite schema YAML.

Tickerplant exceptions¶

Error names	Description	Suggested actions
InvalidTablesForSubscriptionException	List of tables being subscribed to by the TP are an empty object.	Verify that the schema YAML is correct.
TickerPlantSubscriptionFailedException	The subscription to the TP fails for any reason.	Check logs for more information regarding the error.
InvalidHandleForSubscriptionException	Handle not valid.	Verify that the process is running by using the Refinery Service Class CLI commands.
InvalidTickerPlantSubscriptionResponseException	Tickerplant returned invalid response on subscription attempt.	Verify that susbcription was sent to correct Tickerplant and check target Tickerplant logs.
NoDeltaMessagingServerException	No Delta messaging server configured for this application.	Check whether the Delta MS has a value in the system config.
NoDMSTopicException	Delta messaging is enabled, but no topic specified.	Check whether the Delta MS publisher is enabled.
NoConfigurationException	No configuration is returned from the Process Manager.	Verify that the pipelines are set up correctly.
NoSchemasAvailableException	No schemas available for current data hierarchy.	Modify system YAML to contain data hierarchy used in the pipelines.
NoDeltaMessagingServerException	DMS subscription is enabled, but the system has no target server defined / No Delta Messaging server configured for this application.	Restart the Workflow using refinery workflow CLI commands; make sure that the Messaging Server (refinery_core_A workflow) is the only workflow running before progressing.
InvalidTpBatchSizeException	TP batch size isn't a positive whole number.	Check logs for information on batch limit.
InvalidTpPublishConfigurationException	TP Publish function is either a null symbol or doesn't exist.	Check logs to make sure all parameters are correct.
InvalidTpRolloverConfigurationException	TP Rollover function is either a null symbol or doesn't exist.	Check logs to make sure all parameters are correct.
InvalidTpRolloverTimeException	Invalid timespan Value.	Timespan needs to be of type "n" and the value must also be 0D or greater.
InvalidTpTimerFrequencyException	The update mode is set to the incorrect value.	Verify that the TP config in the pipelines are set up correctly.
NoConfigurationException	No configuration from Process Manager. Cannot configure.	Verify that the pipelines are set up correctly.

YAML exceptions¶

Error names	Description	Suggested actions
InvalidRootNodeException	Root node is not a symbol.	Verify that the YAML files are set up correctly.
YamlParseFailedException	Failed to parse YAML file.	Check by using this YAML validator to see where the issue lies.
InvalidYamlFileException	Invalid Process Manager config YAML file load system, YAMl file is not a symbol.	Verify that the YAML files are set up correctly.