> search
> advanced search

> Home      > eTools      > OASIS      > OASIS Template Interface Description for S&CP V1.4     
 
OASIS Template Interface Description for S&CP V1.4



 
General
All access to the PJM OASIS requires that the user be registered with PJM and that this registration precedes any login.

Login is required to start a virtual session on the web server. This is necessary in order to provide some continuity to the user without each web request (URL) having to contain a complete username and password and header. The virtual session is maintained on the server side by user, session, and company information stored in an online database. On the client side, the session is maintained by a persistent client state object called a "cookie". Use of cookie filters, browsers or client-side fetch programs which disable or do not support HTTP cookies is not supported.



The Standards and Communication Protocols (S&CP) for the Open Access Same-time Information System (OASIS). This document may be found at http://www.tsin.com/ under "Library of Documents." This document describes templates and their characteristics (version 1.4)

As a convenience, PJM has modified the fetch_http program (initially provided to the OASIS community by PacifiCorp) to handle the use of the Siemens-format cookies. To download a tar file containing the modified source click here.

Login

A PJM OASIS Account is required to begin a session on any Siemen's OASIS node. The session is maintained via the OASIS database on the server end and a HTTP cookie on the client side.

A login is required to begin a Transmission Customer session on a Siemens OASIS node. The session is maintained on the server side by information stored in the OASIS database. The session is maintained on the client side through the use of an HTTP cookie.

The format for the login template is:
http://pjmoasis.pjm.com/OASIS/PJM/data/login?user={user_name}&passwd={user_password}&pprov={provider_alias}

Where
{user_name} is your PJM OASIS username
{user_password} is the password corresponding to your PJM OASIS username
{provider_alias} is the alias for your service's primary provider (i.e. PJM, MISO, etc.)

The response to a successful login request will be the ASCII text: "You are logged in."



After a successful login a HTTP cookie will be returned via the server HTTP response header. The HTTP cookie will have the following form:
Set-Cookie: Siemens_Oasis={value}.

This cookie must accompany each subsequent request as part of the header and in the following form:
Cookie: Siemens_Oasis={value}.

Logout
The format for the logout template is:
http://pjmoasis.pjm.com/OASIS/PJM/data/logout

Note that the HTTP header must contain the cookie text returned to the client during the login process. The response to the logout request will be the ASCII text: "You are logged out."
Template Requests
Each time you submit a request, your submission will be checked for:
1. Valid session cookie
2. Access to the requested information from the primary provider you logged in under
If either condition is violated, you will receive and ASCII text error message. Otherwise, you will receive the requested information or, in the case of an upload, a status header.

Template requests have the following general format:
http://pjmoasis.pjm.com/OASIS/PJM/data/{template}?{template_parameters}

Where
{template} is a valid template as defined by S&CP version 1.4.
{template_parameters} are the arguments accepted by {template} as defined by S&CP version 1.4.
Note that the HTTP header must contain the cookie text returned to the client during the login process.

When following the S&CP document for submitting the Transrequest template, please keep these PJM header additions in mind:

PAY_CONGESTION
FTR_REQUESTED


These fields should be entered in this order at the end of the template string.
Note: FTR_REQUESTED field need only contain a value for FIRM products.

Template Examples

Login
http://pjmoasis.pjm.com/OASIS/PJM/data/login?user=my_username&passwd=my_password&pprov=PJM

Logout
http://pjmoasis.pjm.com/OASIS/PJM/data/logout

Transrequest Template - Firm Request
Template Code (TXT)

Transrequest Template - Non Firm Request for multi hour multi-megawatt requests
Template Code (TXT)

Transrequest Template - Non Firm Request
Template Code (TXT)

Transoffering Template
Template Code (TXT)

List Template
Template Code (TXT)

Company Abbreviations

The following are defined for Messages but are not used for transmission or ancillary services at this time:

AE - Atlantic Energy
BGE - Baltimore Gas and Electric
DPL - Delmarva Power and Light
GPU - GPU Energy
PECO - PECO Energy
PEPCO - Potomac Electric Power Company
PPL - PPL Transmission
PSEG - Public Service Electric and Gas
UGI - UGI Utilities Inc
Time Zones
PJM's OASIS accepts all date and time options as a string of 16 charters with the last two designating the time zone.

The PJM OASIS accepts the following time zones:

AD - Atlantic Daylight Time UTC - 3 hours
AS - Atlantic Standard Time UTC - 4 hours
ED - Eastern Daylight Time UTC - 4 hours
ES - Eastern Standard Time (North America) UTC - 5 hours
MD - Mountain Daylight Time UTC - 6 hours
MS - Mountain Standard Time UTC - 7 hours
PD - Pacific Daylight Time UTC - 7 hours
PS - Pacific Standard Time UTC - 8 hours
UT - Universal Coordinated Time UTC