Skip to content
KX Refinery - Documentation
Welcome
Type to start searching
KX Refinery
Administration
Command Line Interface
Server API
Client API
Sandbox
Monitoring
Release Notes
KX Refinery - Documentation
KX Refinery
Administration
Administration
Introduction
How To Guides
How To Guides
Cluster Deployment Guide
How to Add a Custom Client Package
Multi-Pipeline Data Sharding Guide
How to Enable Security Feature
Foreign Keys within Refinery
ID Mapping
My First Realtime UDF
Using Non-Symbol Identifiers with getTicks
Using Non-Time Series Data in Refinery
Process Recovery Guide
Loading Static Data
CLI 'man' Pages
CLI 'man' Pages
refinery(8) -- command line interface for KX Refinery
refinery-application(8) -- core start and stop commands
refinery-configuration(8) -- configuration parameter management
refinery-datacopy(8) -- Refinery data copy command.
refinery-failover(8) -- application failover management
refinery-install(8) -- Refinery package download and installation
refinery-logs(8) -- log file viewing and management
refinery-monitoring(8) -- Monitoring components and data capture interface
refinery-pipeline(8) -- pipeline start / stop / status commands
refinery-process-manager(8) -- Refinery process manager start and stop commands
refinery-process(8) -- individual process management
refinery-service-class(8) -- service class start and stop commands
refinery-udf(8) -- User-defined function management
refinery-user(8) -- User management
refinery-workflow(8) -- workflow start and stop commands
Pipelines Guide
Pipelines Guide
Introduction to Pipelines
Creating Pipelines
Creating Environment-Based Pipelines
Setting Environment-Based Process Settings
Pipeline Processes
Domain Specific Guides
Domain Specific Guides
Finance
Finance
Introduction
Quick Start Guide
Calendar Data
Client Data Upload
Corporate Actions - Supported CorAx Types
Datascope Plus Integration
Feed handler Setup & Configuration
Filter Rules & Condition Code Management
Request/Report Generation
Watchlist Management
Quick Start Guide
Architecture
Gateway
Creating New Domain and Client Packages
Data Persistence in Refinery 5
Domain and Client Extensions
Setting up Refinery
Refinery installation via CLI
Using Par.txt in Refinery
Upgrading Refinery and Packages
Intraday database (IDB)
IPDB and EPDB
Late Data
Data Copy
Domain API Plugins
Error Exception List - User Facing
Fault Tolerance
Fault Tolerance and Process Recovery
Pivoting Datasets
Internal process events
Query Logging and User Analysis
Real-time Conditional Analytics
Real-time UDF
Static User-Defined Functions
Time Zone Allocation per Pipeline
User Management
Upgrading to Refinery 5 FAQ
Command Line Interface
Command Line Interface
Command Line Interface
Application
Configuration
Datacopy
Failover
Install
Logs
Monitoring
Pipeline
Process
UDF
User
Workflow
Server API
Server API
Server-side API
Data Services (getTicks)
Analytics Services (getStats)
UDF's - An Introduction
Analyst Refinery Plugin
Supported Time Zones
Parameter Quick Reference
Parameter Validation
Domain Specific APIs
Domain Specific APIs
Finance
Finance
Server-side API
Data Services (getTicks)
Analytics Services (getStats)
Bars Services (getBars)
Reference Data Services (getRef)
Data Summary Services (getSummary)
Parameter Quick Reference
Parameter Validation
Realtime UDF
Q realtime UDF
Client API
Client API
C# API
C# API
Introduction
Core Components
Core Components
Service Class
Service Exception Class
Publisher Class
Query Result Class
Streaming Analytics
Query Execution
Configuration
Configuration
Prerequisites
Application Configuration File (App.config)
Logging Configuration
Examples
Examples
Creating Your First Application
Configuring a Logger
Using the applyFilter Parameter in the C# API
Creating a Keyed Table
Specifying the Returned dateTimeKind
Creating a kdb+ Timestamp
Publishing Data
Troubleshooting
Troubleshooting
Common Errors
Performance
Performance
Query Performance
Appendix
Appendix
None
Type Mapping
Java API
Java API
Introduction
Getting Started
Getting Started
Flow Diagrams
Packages
Prerequisite Guidelines
Core Components
Core Components
Service
Service Exception
Publisher
Query Result
Query Manager Support
Logging
Configuration
Apply Filtering
Appendix
Appendix
Type Mapping
Date and Timestamp Types
Sample Application
Quick Start Guide
DaaSJavaApiCore tests
Sandbox
Sandbox
Welcome
Sandbox Installation Guide
Sandbox Admin Guide
Sandbox User Guide
Application Programming Interfaces
Architecture
Features
User-defined functions
User types
Monitoring
Monitoring
System monitoring
Accessing Monitoring data
Alerting
Enabling user authentication
Custom metrics
Dashboards
Data descriptions
Installing Monitoring
Available Metrics
Monitoring hooks
Running multiple component instances
Notes
Enabling Refinery capture
Running components
Enabling TLS encryption
Troubleshooting runtime errors
Upgrade issues
Release Notes
Release Notes
Introduction
5.15.7
5.15.6
5.15.5
5.15.4
5.15.3
5.15.2
5.15.1
5.15.0
5.14.0
5.13.2
5.13.1
5.13.0
5.12.0
5.11.3
5.11.2
5.11.1
5.11.0
5.10.4
5.10.3
5.10.2
5.10.1
5.10.0
5.9.4
5.9.3
5.9.2
5.9.1
5.9.0
5.8.5
5.8.4
5.8.3
5.8.2
5.8.1
5.8.0
5.7.7
5.7.6
5.7.5
5.7.4P1
5.7.4
5.7.3
5.7.2
5.7.1
5.7.0P1
5.7.0
5.6.3P1
5.6.3
5.6.2P1
5.6.2
5.6.1P1
5.6.1
5.6.0
5.5.7
5.5.6
5.5.5
5.5.4
5.5.3
5.5.2
5.5.1
5.5.0
5.4.3
5.4.2
5.4.1
5.4.0
5.3.0
5.2.1
5.2.0
5.1.0
5.0.0
Welcome
¶
This section contains all the documentation for the KX Refinery Sandbox.