APSYSUFFIX (JANUS DEFINE parameter): Difference between revisions
Add transparency filename suffix convention Tag: Blanking |
Add documentation for APSYSUFFIX parameter |
||
| Line 1: | Line 1: | ||
APSYSUFFIX x — Specify Application System suffix for IMAGINET port routing | |||
APSYSUFFIX is a [[JANUS DEFINE#parmlist|parameter]] of the [[JANUS DEFINE]] command, which defines and sets characteristics of a Janus port. APSYSUFFIX specifies a single-character suffix that identifies the Application System (APSY) instance associated with a broker connection. This suffix is sent to Model 204 during the [[Imagine Transparency]] handshake to enable per-suffix routing, allowing a single IMAGINET port to serve multiple Imagine Database Store (DBS) instances. | |||
==Syntax== | |||
<p class="syntax">APSYSUFFIX <span class="term">x</span> | |||
</p> | |||
Where: | |||
:<var>x</var> is a single alphanumeric character (A-Z or 0-9) that identifies the APSY suffix for this broker instance. | |||
==Usage== | |||
* When APSYSUFFIX is specified, the broker sends the suffix character and the associated DBS name to Model 204 during the IMAGINET connection handshake. Model 204 uses this information to route requests to the correct DBS instance. | |||
* Without APSYSUFFIX, all IMAGINET connections are routed to a single, default DBS instance. | |||
* APSYSUFFIX is typically used in conjunction with the <code>dbsName</code> and <code>dbsPort</code> broker options to associate each suffix with a specific DBS instance. For example, suffix "T" might connect to a test DBS instance, while suffix "L" connects to a live instance. | |||
* The suffix value is case-insensitive; it is converted to uppercase before being sent to Model 204. | |||
Valid only for [[JANUS DEFINE#type|IMAGINET]] port types. | |||
==Example== | |||
In the Imagine broker configuration, a broker started with suffix "T" and DBS name "db" would communicate this to Model 204 via the IMAGINET port: | |||
<pre> | |||
startBroker --apsySuffix=T --dbsName=db --dbsPort=7777 | |||
</pre> | |||
On the Model 204 side, the IMAGINET port is defined normally. The suffix routing is driven by the broker, not by the JANUS DEFINE itself. The APSYSUFFIX keyword on JANUS DEFINE enables the IMAGINET port to accept and process suffix information from connecting brokers. | |||
==See also== | |||
* [[Imagine Transparency]] | |||
* [[List of Janus commands]] | |||
* [[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]] | |||
Revision as of 22:11, 15 April 2026
APSYSUFFIX x — Specify Application System suffix for IMAGINET port routing
APSYSUFFIX is a parameter of the JANUS DEFINE command, which defines and sets characteristics of a Janus port. APSYSUFFIX specifies a single-character suffix that identifies the Application System (APSY) instance associated with a broker connection. This suffix is sent to Model 204 during the Imagine Transparency handshake to enable per-suffix routing, allowing a single IMAGINET port to serve multiple Imagine Database Store (DBS) instances.
Syntax
APSYSUFFIX x
Where:
- x is a single alphanumeric character (A-Z or 0-9) that identifies the APSY suffix for this broker instance.
Usage
- When APSYSUFFIX is specified, the broker sends the suffix character and the associated DBS name to Model 204 during the IMAGINET connection handshake. Model 204 uses this information to route requests to the correct DBS instance.
- Without APSYSUFFIX, all IMAGINET connections are routed to a single, default DBS instance.
- APSYSUFFIX is typically used in conjunction with the
dbsNameanddbsPortbroker options to associate each suffix with a specific DBS instance. For example, suffix "T" might connect to a test DBS instance, while suffix "L" connects to a live instance. - The suffix value is case-insensitive; it is converted to uppercase before being sent to Model 204.
Valid only for IMAGINET port types.
Example
In the Imagine broker configuration, a broker started with suffix "T" and DBS name "db" would communicate this to Model 204 via the IMAGINET port:
startBroker --apsySuffix=T --dbsName=db --dbsPort=7777
On the Model 204 side, the IMAGINET port is defined normally. The suffix routing is driven by the broker, not by the JANUS DEFINE itself. The APSYSUFFIX keyword on JANUS DEFINE enables the IMAGINET port to accept and process suffix information from connecting brokers.