GetScreen Service

Description

This service returns an XML representation of a screen for a Rulebase.  The screen must be identified by id or name.  Session data can be sent with the screen request, and the Oracle Determinations Server uses the session data to help populate the form.  The session data will differ depending on whether the request is to the Specific or Generic Service.

Request

The GetScreen request consists of the following elements:

"screen-name"(choice of this or screen-id)

A screen identified by its name

"screen-id" (choice of this or screen-name)

A screen identified by its id

"screen-entity" (optional)

The reference to the entity to use in the screen.  This entity reference, if provided, must exist in the session-data.

"session-data" (optional)

The session data used in the screen. When GetScreen is called using the Specific service. This element will be named for the Rulebase (see Setting Session Data below). When calling a Generic service this element is always "session-data".

Example Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:typ="http://oracle.com/determinations/server/9.3/entityscreentest/types">
    <soapenv:Body>
        <typ:get-screen-request>
            <typ:screen-id>s1@Screens_screens_xint</typ:screen-id>
        </typ:get-screen-request>
    </soapenv:Body>
</soapenv:Envelope>

Response

The response will be an XML representation of a screen with the following elements:

"get-screen-response"

The Response element.

"screen"

This is the definition of the screen only one screen will be returned.  The Screen element has the following attributes:

"id" – the identifier for the screen

"name" (optional) – the name of the screen (not all screens have a name)

"title"- the title of the screen

"is-automatic"- a Boolean value indicating if the screen is automatically generated, (true) or defined in the rulebase (false).

“entity” - the entity the screen is associated with

"entity-label" - this is the label for the entity, as passed in in the session-data of the request

"screen-control"

This is a single screen control within a screen.  The screen-control element gas the following attributes:

"control-type" – the type of control. The Control type will be one of: custom, entity, fixed, flow, entity-association, date, goal, group, label money, number, boolean, selection, text.

"default" (optional) – the default value of the control type

"line-count" (optional) – for a control-type "text" the number of vertical lines of space to be provided by a text control

"value" (optional) – the current value of the control

"attribute-id" (optional) – for a control derived from an attribute, the id (name) of that attribute

"caption" – the caption for a control

"is-inferred" (optional) - if the value for the control is an inferred value, this will be true

"is-mandatory" (optional) – if the value for the control must be provided, this value will be true

"is-read-only" (optional) – if the value for the control is read-only (cannot be modified), this value will be true

"style" (optional) – the selection style for a control. Will be one of: Radiobutton, Dropdown, Listbox, Checkboxes.

"code-table-item" (optional, more than one) – A sub-element of screen-control, when the control type is a choice (selection control for example) there may be one or more code-table-item elements, representing a selection or choice. The code-table-item has the following attributes:

"code" – the selection code for the item "value" – value the display value for the tem.

"properties" (optional) – a list of custom properties for a control. For a description of the properties element, see the assess method below.

 

A screen definition will be returned as the response. The session data will be incorporated into the screen, but the session data is not returned like Assess.

Example Response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:typ="http://oracle.com/determinations/server/9.3/entityscreentest/types">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <typ:get-screen-response>
      <typ:screen entity="global" id="s1@Screens_screens_xint" is-automatic="false"
           title="sun shining">
        <typ:screen-control attribute-id="a1" caption="is the sun shining?"
             control-type="boolean" default=""/>
      </typ:screen>
    </typ:get-screen-response>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Possible Errors