All products
Features and administration common to all FairCom products
This section provides documentation that applies to all FairCom products. It is an administrator and developer guide for common features.
Section | Description |
|---|---|
A chronological list and description of features added to FairCom products. | |
Details of system requirements for various platforms. | |
A full reference to FairCom Replication features and capabilities. | |
A numerical listing of all error codes that could be generated by any FairCom product. | |
An explanation of FairCom DB Notify which automatically captures data change events and publishes them as MQTT messages. Systems that subscribed to these messages will receive guaranteed notification of data changes. | |
All major terms used by FairCom products, plus some related terms. | |
Quick and advanced installation instructions for all FairCom products, including a section on creating Docker containers for FairCom servers. | |
Categorized groupings of standard message patterns for all jsonAction APIs with detailed descriptions of the properties for each message. | |
Tutorials for developers to quickly start using FairCom APIs. | |
Concepts, methods, and terms used by FairCom for communication and message security. | |
An overview of the FairCom user interfaces with tutorials on how to use them. |
This section provides documentation that applies to all FairCom products including DB, RTG, Edge, and MQ
FairCom products
DB
RTG
MQ
Edge
jsonAction API
accounts
sessions and services
code packages
FairCom JSON API actions use required and optional parameters to complete specific operations. The following table shows the limits of these parameters.
Attribute | Description | Limits |
|---|---|---|
Size of disk reads and writes | Limited on Windows | |
The file ID number | 1 to 4294963200 | |
Size of a file | 1 to 16 Exabytes | |
fixed-length record | Size of a fixed length record. | 1 to 64KB |
Number of users in a group | 0 to 16 per user | |
Number of indices per data file. | 0 to 64 (default) | |
memory files | Memory file limitations | |
open files | Number of concurrently opened files | 1 to 32767 |
Password limitations | 1 to 64 bytes | |
records per file | Number of records per file | No limit |
Number of segments per index | 1 to 16 (default) | |
SQL CHECK constraint clause | Length of a FairCom DB SQL CHECK constraint clause | 20000 bytes |
SQL column (NATIONAL CHARACTER) | Length of a FairCom DB SQL column for VARBINARY and VARCHAR specifying the character set designated as NATIONAL CHARACTER | 1 to 3275 bytes |
SQL column (standard) | Length of a FairCom DB SQL column for standard data types. | 0 to 65500 bytes |
SQL connection string | Length of a FairCom DB SQL connection string | 0 to 100 bytes |
SQL default value | FairCom DB SQL default value specification | 0 to 8192 bytes |
SQL error message | Length of a FairCom DB SQL error message | 0 to 511 bytes |
SQL identifier | Length of a FairCom DB SQL identifier | 1 to 32 bytes |
SQL nesting levels | Number of FairCom DB SQL nesting levels for view references | 0 to 25 |
SQL procedure arguments | Number of arguments in a FairCom DB SQL CALL statement | 0 to 50 |
SQL recursion level | Number of FairCom DB SQL recursion levels for stored procedures | 0 to 10 |
SQL statement input parameters | Number of input parameters in a FairCom DB SQL statement | 0 to 512 |
SQL statement length | Length of a FairCom DB SQL statement | 1 to 32MB (prior to V10.2, the limit was 35,000 characters) |
SQL statement nesting levels | Number of nesting levels in a FairCom DB SQL statement | 0 to 25 |
SQL statement outer references | Number of or outer references in a FairCom DB SQL statement | 0 to 25 |
SQL statement table references | Number of table references in a FairCom DB SQL statement | 1 to 250 |
SQL storage attribute | Length of a FairCom DB storage_attribute | 1 to 2000 bytes |
SQL table check constraints | Number of check constraints in a FairCom DB SQL table | 0 to 4000 |
SQL table columns | Number of FairCom DB columns in a SQL table | 1 to 2500 |
SQL table foreign constraints | Number of foreign constraints in a FairCom DB SQL table | 0 to 4000 |
Number of index components for all indexes on a FairCom DB SQL table | 0 to 2048 (configurable) | |
SQL view definition | Length of a FairCom DB SQL view definition | 1 to 65000 bytes |
Length of a table name | 1 to 64 bytes | |
Support for UNIFRMAT files | Available only for non-transaction processed files. | |
Length of a FairCom DB user name | 1 to 31 bytes POSIX standard | |
variable-length record | Size of a variable length record | 1 to 2GB |
A large variable-length record read or write operation could fail with Windows error 1450. To avoid this Windows error, see Enforce Maximum Disk Read/Write Sizes on Windows to set the maximum read/write size.
The file ID number of a transaction-controlled file is incremented each time the file is opened. If error 534, Pending File ID overflow: 534 is written to CTSTATUS.FCS see File ID Overflow.
The file size limit is 16 Exabytes (18 million terabytes). See File Size and Operating System Limits for more information.
The System Administrator can create one or more Groups. Each group is assigned a unique Group ID that is a 32-byte ASCIIZ string.
To provide a convenient way for users with related needs to share information, each user is assigned membership in one to 16 groups. The Administrator adds the groups to the system and assigns users to them. Each user has a default group, which counts as one of the user’s 16 groups. If a user is not assigned to a group, the user’s default group is the GUEST group.
When an application program logs on to the FairCom Server with one of the extended functions, it sends a User ID and user password to the FairCom Server. Logging on with one of the equivalent standard functions or sending a NULL User ID with one of the extended functions automatically assigns the User ID of GUEST and membership in the GUEST group. If a User ID or password that does not exist is sent, the initiating call to the FairCom Server returns an error code and the program is not connected to the FairCom Server.
The index limit defaults to 64 but can be increased using MAX_DAT_KEY in ctsrvr.cfg to a theoretical limit of 32767, although a practical limit exists well before this value.
Each User can have an optional user password. The password limit is 64 bytes. For more information about passwords, see Automatically Enforce Password Strength.
The segment limit defaults to 16 but can be increased using MAX_KEY_SEG in ctsrvr.cfg to a theoretical limit of 32767, although a practical limit exists well before this value.
The limits of the table index components are configurable in ctsrvr.cfg by MAX_DAT_KEY (default 64) and MAX_KEY_SEG (default 32).
Table names must meet the following requirements:
Must be 64 bytes or less in length
Must start with an upper or lowercase letter
Must not contain special characters other than underscore "_"
Can include a mix of upper-lower case characters but are treated as case-insensitive.
Note
Actions that take a “tableName” will return an Error 4054 if the table name does not meet these requirements. If this error is returned by "createTable", "createIntegrationTable", "createInput", or "createTransform", check the supplied "tableName" property to ensure it meets requirements.
UNIFRMAT support is only available for non-transaction processed files. See Limitations for more information.
A user name, user ID, or account name is a 32-byte null-terminated ASCII string, which implies 31 bytes are available. The following characters are allowed in the name:
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
0123456789
._-
A hyphen character (-) cannot be used as the first character.
The server ignores the case of the ASCII characters. Therefore, the server considers TEST_1.FairCom-4 to be the same as test_1.faircom-4.
Note
FairCom based these limitations on the POSIX standard for the Portable Filename Character Set.