Welcome
Developing
Developing EGL applications
Enterprise Generation Language (EGL) is a programming language that you can use to focus on business problems instead of software technologies. Within the Rational® development environment, you can use EGL wizards and other tools to write complex applications with minimal effort.
EGL Language Reference
The EGL Language Reference covers the fundamental use of the language, including its concepts, syntax, and keywords. This volume is intended for a developer writing EGL applications with some experience in procedural programming.
EGL core system libraries and variables
EGL library serviceLib
The serviceLib functions get and set service variable information.
getSOAPResponseHeaders()
The getSOAPResponseHeaders function gives access to the SOAP response headers that are provided to a service requester. This function is available only in a Java- or JavaScript-based requester that relies on JAX-WS rather than JAX-RPC.

Overview
Getting started
Installing
Upgrading and migrating
Developing
- Model driven development of EGL code
- Generating source code from UML models
  You can use transformations to create source code from a UML model. First you must create a transformation parameters file and then apply those parameters to a model.
- Generating the EGL Dependency Graph from EGL projects
- Generating Source Code from OpenAPI Documents
- Developing EGL applications
  Enterprise Generation Language (EGL) is a programming language that you can use to focus on business problems instead of software technologies. Within the Rational® development environment, you can use EGL wizards and other tools to write complex applications with minimal effort.
  - How to use this documentation
  - Additional information about EGL
    The most recent EGL documentation is in the Rational® Business Developer Information Center.
  - EGL Programmer's Guide
    The EGL Programmer's Guide covers using EGL within the Eclipse Integrated Development Environment (IDE), as well as some of the common programming tasks that EGL developers perform.
  - EGL Generation Guide
    The EGL Generation Guide covers the process of converting EGL code to Java™ or COBOL source code, including the processes and the files involved. This section is intended for a developer who will generate or deploy EGL applications.
  - EGL Language Reference
    The EGL Language Reference covers the fundamental use of the language, including its concepts, syntax, and keywords. This volume is intended for a developer writing EGL applications with some experience in procedural programming.
    - General syntax
    - System data parts
    - User-defined data parts
    - Logic parts
    - Correspondence between a JSON string and an EGL variable
      This topic describes the EGL record that corresponds to a JavaScript™ Object Notation (JSON) string. Other topics describe the functions (serviceLib.convertFromJSON() and serviceLib.convertToJSON()) that are used by a Rich UI developer to convert JSON data to or from a variable, as may be necessary to access a third-party REST service. A failure in either function causes a RuntimeException.
    - Correspondence between a JSON string and an EGL variable for zOS and IBM i
      This topic describes the EGL record that corresponds to a JavaScript Object Notation (JSON) string. This topic describes the functions—serviceLib.convertFromJSON() and serviceLib.convertToJSON()—that are used by an EGL developer to convert JSON data to or from a variable either for zOS or IBM i systems. A failure in either function causes a RuntimeException.
    - Special considerations for JSON support on IBM i:
    - Correspondence between an XML string and an EGL variable
      This topic describes the EGL record that corresponds to an Extensible Markup Language (XML) string. Other topics describe the functions (serviceLib.convertFromXML and serviceLib.convertToXML) that are used by a Rich UI developer to convert XML data to or from a variable, as may be necessary to access a third-party REST service.
    - EGL statements
    - EGL core system libraries and variables
      - EGL library dateTimeLib
        The date and time system functions and variables let you manipulate and retrieve the system date and time in a variety of formats.
      - EGL library JavaLib
        The javaLib library access local Java® objects and classes through your generated Java™ code.
      - EGL library lobLib
        The lobLib system library provides support functions for large objects (BLOB and CLOB types).
      - EGL library mathLib
        The EGL mathLib functions perform common mathematical and trigonometric functions.
      - EGL library serviceLib
        The serviceLib functions get and set service variable information.
        bindService()
        convertFromJSON()
        The serviceLib.convertFromJSON() system function converts a JSON string into a record or dictionary.
        convertFromURLEncoded()
        The serviceLib.convertFromURLEncoded() system function returns a version of a Universe Resource Locator (URL) that is decoded; for example, the returned string has a space rather than the following combination: %20. You might use this function if a REST service returned a URL and you wished to process the value of a query parameter. This function is the complement of ServiceLib.convertToURLEncoded().
        convertToJSON()
        The serviceLib.convertToJSON() system function converts a record or dictionary into a JSON string. For details on the conversion, see “Correspondence between a JSON string and an EGL variable.”
        setRestResponse
        The system function serviceLib.setRestResponse allows an EGL Java REST Service to set a custom HTTP response depending on the business logic.
        setCICSRestResponse
        The system function serviceLib.setCICSRestResponse allows an EGL CICS REST Service to set a custom HTTP response depending on the business logic.
        convertToURLEncoded()
        The ServiceLib.convertToURLEncoded() system function converts a string into a Universe Resource Locator (URL), which identifies a web page or represents the resource that will be accessed by a REST service. The function is useful if you wish to use a URL that includes spaces or other characters that are not valid in the URL. For example, if your URL includes query parameters and the value of a parameter includes a space, the function returns a valid URL, with a plus sign (+) in place of the space.
        endStatefulServiceSession
        The serviceLib.endStatefulServiceSession() system function ends the HTTP session being used by a service. The action releases runtime resources; specifically, the resources used to access EGL REST-RPC services that in turn access UI programs or stateful IBM® i programs.
        getCurrentCallbackResponse
        The system function serviceLib.getCurrentCallbackResponse provides access to details from the HTTP response that is received by a callback function or onException function in a Rich UI application.
        getOriginalRequest
        The serviceLib.getOriginalRequest() system function provides access to an HTTP request. If the function is invoked in a callback or onException function, the HTTP request was sent to the service during the specific call that caused the service to invoke the callback or onException function. If serviceLib.getOriginalRequest() is invoked elsewhere, the HTTP request was sent to the service during the most recent invocation of the call statement; and in the absence of a previous call statement, the HTTP request fields are empty.
        getRestRequestHeaders()
        The serviceLib.getRestRequestHeaders() system function gets the HTTP request headers from a variable that is used to access a REST service. This function is available in an EGL-generated Java- or JavaScript-based requester of a REST service.
        getRestResponseHeaders()
        The serviceLib.getRestResponseHeaders() system function gets the HTTP response headers from a variable that is used to access a REST service. This function is available in an EGL-generated Java requester of a REST service.
        getRestServiceLocation()
        The serviceLib.getRestServiceLocation() system function returns the base URI used to access a REST service.
        getSOAPRequestHeaders()
        The getSOAPRequestHeaders function returns the SOAP request headers that are provided by a service requester. This function is valid only in an EGL-generated, Java-based SOAP service and only if the service relies on JAX-WS rather than JAX-RPC.
        getSOAPResponseHeaders()
        The getSOAPResponseHeaders function gives access to the SOAP response headers that are provided to a service requester. This function is available only in a Java- or JavaScript-based requester that relies on JAX-WS rather than JAX-RPC.
        getTCPIPLocation()
        The serviceLib.getTCPIPLocation() system function returns the host name and port number that provide TCP/IP access to an EGL service.
        getWebServiceLocation()
        The serviceLib.getWebServiceLocation() system function returns the URL that provides access to a web (SOAP) service.
        setHTTPBasicAuthentication()
        The serviceLib.setHTTPBasicAuthentication() system function provides simple HTTP header authentication that uses 64bit encryption.
        setProxyBasicAuthentication()
        The serviceLib.setProxyBasicAuthentication() system function gives the user access to the EGL Rich UI Proxy when that access is protected by JEE basic authentication. The function lets you provide a user ID and password, which are automatically encrypted for inclusion in an HTTP header. For background information, see EGL Rich UI security,
        setRestRequestHeaders()
        The serviceLib.setRestRequestHeaders() system function sets the HTTP headers that are transmitted to a REST service.
        setRestServiceLocation()
        The serviceLib.setServiceLocation() system function sets the base URI used to access a REST service.
        setSOAPRequestHeaders()
        The setSOAPRequestHeaders function sets the request headers that will be transmitted to a SOAP service. This function is available only in a Java- or JavaScript-based requester that relies on JAX-WS rather than JAX-RPC.
        setSOAPResponseHeaders()
        The setSOAPResponseHeaders function sets the response headers that will be returned to a service requester. This function is available only in an EGL-generated, Java-based SOAP service and only if the service relies on JAX-WS rather than JAX-RPC.
        setTCPIPLocation()
        The serviceLib.setTCPIPLocation() system function sets the host name and port number that provide TCP/IP access to an EGL service.
        setWebServiceLocation()
        The serviceLib.setWebServiceLocation() system function sets the URL that provides access to a web (SOAP) service.
      - EGL library strLib
        The strLib functions manipulate and convert data to and from STRING variables and format date/time variables.
      - EGL library sysLib
        The sysLib system library contains miscellaneous functions and one variable.
      - sysVar system variable
        The sysVar system variable holds a variety of values.
      - EGL library XMLLib
        This topic describes the XMLLib functions and variable definitions.
    - Accessing data in EGL
      Whenever you access a data store in EGL, the data goes into a record.
    - Applications with user interfaces
    - VisualAge® Generator compatibility
    - Appendices
    - Importing product-supplied projects
      You can click a link to download the current version of Rich UI projects. The capability is useful if you deleted a project or want a clean version.
  - Rational® COBOL Runtime Guide for zSeries®
    This manual provides information about customizing and administering the IBM® Rational® COBOL Runtime.
  - Rational® Business Developer EGL Server Guide for IBM® i
    This manual provides information about customizing and administering EGL Server for IBM® i on the host.
  - Generation for VSE Feature Reference
    This reference manual provides z/VSE-specific information about developing and generating EGL programs in the VSE environment.
- Source code analysis with code review
  With code review, you can create configurations of coding rules for EGL source code. You can then run the configurations to check the source code for consistency with the rules.
- Responsive Design Support in RBD
  What is Responsive Design? Responsive design is an approach for creation of web pages that automatically scales its content and elements to match the screen size on which it is viewed. So, instead of designing multiple websites for different devices with variable screen sizes, we can design just one website that scales up or down automatically, to match the device it’s being viewed on.
Samples
Troubleshooting and support
EGL runtime error messages
Reference
Glossary
Using the help
Notices for IBM Rational Business Developer documentation

getSOAPResponseHeaders()

The getSOAPResponseHeaders function gives access to the SOAP response headers that are provided to a service requester. This function is available only in a Java- or JavaScript-based requester that relies on JAX-WS rather than JAX-RPC.

Syntax

serviceLib.getSOAPResponseHeaders(variable Service | Interface in,
                                  headerRecord any inout)

variable: A variable used to access the service. The variable is based on a Service or Interface part.
headerRecord: A non-structured record. For an example, see EGL support for accessing SOAP headers.