INQUIRE BRFACILITY

Description

The INQUIRE BRFACILITY command returns information about a bridge facility. This is a virtual terminal used by the 3270 bridge mechanism to simulate a real 3270 when running a CICS 3270 application in a bridged environment. You can use this command in any application running in the Link3270 bridge program or AOR region where the bridge facility was created, to retrieve information about any active bridge facility, even if it is not your principal facility.

Browsing

You can also browse through the bridge facilities installed in your system by using the browse options (START, NEXT, and END) on INQUIRE BRFACILITY commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

BRFACILITY(data-value)

Specifies the 8-byte facility token of the bridge facility about which you are inquiring.

KEEPTIME(data-area)

Returns a full word binary field showing the length of time (in seconds) that the bridge facility is kept if inactive.

• If the bridge facility being displayed is a Link-Bridge, this value is the time that was specified when the facility was allocated, or a default value of 5 minutes. If the KEEPTIME value is larger than the value of the BRMAXKEEPTIME system initialization parameter, it is reduced to BRMAXKEEPTIME.
• If the facility being displayed is a Web-Bridge, the KEEPTIME value is initially set to be the Webdelay terminal keep time (the second part of the WEBDELAY system initialization parameter).

LINKSYSNET(data-area)

Returns the 8-byte applid of the AOR if the Link3270 bridge request is routed to another region. If the request is processed in the same region as the Link3270 bridge program, then this field is blank. This field may change if dynamic transaction routing makes more than one attempt at running the first transaction in a Link3270 session. This field is only set in the Link3270 bridge program region.

LINKSYSTEM(data-area)

Returns the 4-byte SYSID of the AOR if the Link3270 bridge request is routed to another region. If the request is processed in the same region as the Link3270 bridge program, then this field is blank. This field may change if dynamic transaction routing makes more than one attempt at running the first transaction in a Link3270 session. This field is only set in the Link3270 bridge program region.

NAMESPACE(cvda)

Returns a CVDA value indicating the scope of the name space used to allocate bridge facility names. CVDA values are:

LOCAL

The bridge facility was allocated by the START BREXIT bridge mechanism, so its name is unique only in the local region where it is created.

SHARED

The bridge facility was allocated by the Link3270 bridge mechanism, so its name is unique across all CICS Link3270 bridge regions in the CICSplex who have access to a shared DFHBRNSF namespace file.

NETNAME(data-area)

Specifies the 8-byte virtual netname name of the bridge facility about which you are inquiring.

REMOTESYSNET(data-area)

Returns an 8–byte field giving the applid of the router. This field is only set in the AOR region. It is blank if the AOR is the router region.

REMOTESYSTEM(data-area)

Returns a 4-byte giving the SYSID of the router. This field is only set in the AOR region. It is blank if the AOR is the router region.

TASKID(data-area)

Returns a full word binary field showing the number of the task running the user transaction. This field is only set in the AOR. This field is zero the bridge facility is currently not in use.

TERMID(data-area)

Specifies the 4-byte virtual terminal name of the bridge facility about which you are inquiring.

TERMSTATUS(cvda)

Returns a CVDA value indicating the status of the bridge facility. CVDA values are:

ACQUIRED

The bridge facility is currently in use.

AVAILABLE

The bridge facility is not in use. It can be reused by the client.

RELEASED

SET BRFACILITY RELEASED has been issued for the bridge facility. It will be deleted on the next cleanup cycle.

TRANSACTION(data-area)

Returns a 4-byte field giving the name of the user transaction being run by the 3270 bridge, as known in the current region. This value is blank if the bridge facility is currently not in use.

USERID(data-area)

Returns an 8-byte field giving the userid associated with this bridge facility.

Conditions

END

RESP2 values:

1

There are no more resource definitions of this type.

ILLOGIC

RESP2 values:

1

You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.

NOTAUTH

RESP2 values:

100

The user associated with the issuing task is not authorized to use this command.

NOTFOUND

RESP2 values:

1

The specified bridge facility cannot be found.