Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Warning

OECN RPC based on USP is considered obsolete and unsupported. The SSDT recommends that ITC sites use OECN VXS /wiki/spaces/CTD/pages/623294 for OECN RPC services. This document is retained for historical purposes for sites still maintaining a USP installation. ITC continuing to use USP-based RPC services should not contact the SSDT for support.

Panel
Table of Contents
outlinetrue
indent20px
stylenone
printablefalse

Introduction

Important: OECN RPC based on USP is considered obsolete. The SSDT recommends that ITC sites use OECN VXS for OECN RPC services. This document is retained for historical purposes for sites still maintaining a USP installation.OECN State Software contains an RPC (Remote Procedure Call) service. The RPC service allows remote State Software contains an RPC (Remote Procedure Call) service. The RPC service allows remote client software (e.g. web applications) to make remote calls to standard OECN software routines via an XML interface. The primary purpose of the RPC service is to expose standard OECN software functions and business logic for use in web based or graphical user interfaces.

...

OECN VXS

The remainder of this document discusses USP as the transport layer for the OECN RPC service. If you prefer an alternative to USP, you should skip this document and use OECN VXS. /wiki/spaces/CTD/pages/623294.

Universal Service Provider (USP)

...

The “As Is” license from HP does not provide any software support for the USP. As of July 2008, the SSDT no longer maintains a support contract with STABILIT. The SSDT will be attempt to provide support for USP to the OECN DA Sites using it with state software. However, sites having problems with USP will be encourage to switch to OECN VXS /wiki/spaces/CTD/pages/623294 when possible for OECN RPC.

...

Start the configuration process with:

Code Block

$ @OECN$:OECNRPC_CONFIG

See the following sections for more information about the operation of the configuration utility.

...

·Table 1 Minimal SETUPENV parameters

{table:border=1} {tr} {td:valign=top}{*}Parameter{*}{td} {td:valign=top}{*}Value{*}{td} {td:valign=top}{*}Notes{*}{td} {tr} {tr} {td:valign=top}SECTION{td} {td:valign=top}district code{td} {td:valign=top}Entity code for the district{td} {tr} {tr} {td:valign=top}DESCRIPTION{td} {td:valign=top}District name{td} {td:valign=top}Description of the district as it will be seen by the remote user{td} {tr} {tr} {td:valign=top}TYPE{td} {td:valign=top}DISTRICT{td} {td:valign=top}OECN RPC will only allow access to “DISTRICT” type entries{td} {tr} {tr} {td:valign=top}LOGICAL Or:GROUP_TABLE Or:TABLE{td} {td:valign=top}\[Varies by package\] {td} {td:valign=top}At a minimum, each district entry must provide a definition for logicals required by the package(s) being used by the district. For USAS and USPS, OECN$DTA must be defined. The definition may be provided as a hard-coded location using LOGICAL or as a reference to a logical name table, as appropriate for the DAS configuration. For EMIS, the entry might provide a definition for EMIS_ROOT or other similar logical that is used in conjunction with EMIS_SELECT.{td} {tr} {tr} {td:valign=top}IDENTIFIER{td} {td:valign=top}UIC or identifiers{td} {td:valign=top}One or more IDENTIFIER parameters must be specified to allow access to the appropriate users. OECNRPC will not permit a remote client to see entries to which they have not been explicitly granted access.{td} {tr} {table}
Wiki Markup
HTML Table
border1
Table Row (tr)
Table Cell (td)
valigntop
Parameter
Table Cell (td)
valigntop
Value
Table Cell (td)
valigntop
Notes
Table Row (tr)
Table Cell (td)
valigntop
SECTION
Table Cell (td)
valigntop
district code
Table Cell (td)
valigntop
Entity code for the district
Table Row (tr)
Table Cell (td)
valigntop
DESCRIPTION
Table Cell (td)
valigntop
District name
Table Cell (td)
valigntop
Description of the district as it will be seen by the remote user
Table Row (tr)
Table Cell (td)
valigntop
TYPE
Table Cell (td)
valigntop
DISTRICT
Table Cell (td)
valigntop
OECN RPC will only allow access to “DISTRICT” type entries
Table Row (tr)
Table Cell (td)
valigntop
LOGICAL
Or:GROUP_TABLE
Or:TABLE
Table Cell (td)
valigntop
[Varies by package]
Table Cell (td)
valigntop
At a minimum, each district entry must provide a definition for logicals required by the package(s) being used by the district. For USAS and USPS, OECN$DTA must be defined. The definition may be provided as a hard-coded location using LOGICAL or as a reference to a logical name table, as appropriate for the DAS configuration. For EMIS, the entry might provide a definition for EMIS_ROOT or other similar logical that is used in conjunction with EMIS_SELECT.
Table Row (tr)
Table Cell (td)
valigntop
IDENTIFIER
Table Cell (td)
valigntop
UIC or identifiers
Table Cell (td)
valigntop
One or more IDENTIFIER parameters must be specified to allow access to the appropriate users. OECNRPC will not permit a remote client to see entries to which they have not been explicitly granted access.

EMIS Configuration

OECN RPC will also use SETUPENV to establish the EMIS logical context for multiple databases. This is done using the same OECN$EMIS_DBS file used by EMIS_SELECT. Therefore, sites using OECN RPC must establish the standard OECN$EMIS_DBS file to define the available databases.

...

Below is an example of a minimal OECN$SETUP.INI file suitable for OECN RPC. The example has been simplified to just the parameters required by OECN RPC. However, DA Sites are free to use other features of SETUPENV to set logicals depending on their configuration and other uses of SETUPENV. See the OECN System Managers Manual for more information regarding SETUPENV and the OECN$SETUP.INI file.

Code Block

! Define entry for District A
!
SECTION=DISTA
TYPE=DISTRICT
DESCRIPTION="District A"
LOGICAL=OECN$DTA,DKA100:[DISTA.DATA]
IDENTIFIER=”[DISTA,*]”      ! UIC group of District A users
! Define entry for District B
!
SECTION=DISTB
TYPE=DISTRICT
DESCRIPTION="District B"
LOGICAL=OECN$DTA, DKA100:[DISTB.DATA]
IDENTIFIER=DISTB_BUSINESSOFFICE  ! Identifier of District B Business Office users
IDENTIFIER=DISTB_SECRETARIES     ! Identifier of District B Secretaries posting REQs

...

For SETUPENV used interactively, the default IDENTIFIER parameters is:

Code Block

IDENTIFIER=”[*,*]”

This allows all users to see the entry. For OECN RPC the default IDENTIFIER is:

Code Block

IDENTIFIER=OECN_SYSMAN

This restricts the entry to only OECN DAS personnel by default. This difference in behavior is intended as a security constraint to make it more difficult for remote network clients from discovering district databases inappropriately. It also reduces confusion on the remote client by preventing a user from attempting to select a district they do not have access to.

...