1.1.4 Gateway Webservices Application

This topic explains systematic instructions to create a property file through the Gateway Webservices application type.

  1. On the Gateway Property File Creation screen, select Gateway Webservices application type.

    Figure 1-23 Gateway Property File Creation



  2. Click Next.
    The Multi Entity Names screen displays.

    For more information, refer to the fields description table.

    Table 1-12 Multi Entity Names - Field Description

    Field Description
    MultiEntity Required Select the MultiEntity Required checkbox for enabling the multi-entity deployment.

    After selecting this checkbox, the + and - icons will be enabled for capturing the entity name.

    + Click + to add a new row for capturing the new entity name.
    - Select the entity name and click -, the deletion of the existing entity name will be done.
    Entity Name Specify the entity name as a single word. For example, ENTITY1
  3. Click Next.
    The Property File Creation screen displays.

    Figure 1-25 Property File Creation



    Table 1-13 Property File Creation - Field Description

    Field Description
    SSO Required Select this checkbox to enable single sign-on (SSO). If you select this checkbox, you must specify the SSO Key.
    SSO Key Specify the SSO key. If you have checked the box SSO Required, it is mandatory to specify the SSO key.

    If you have checked the box SSO Required, then the installer will skip the following two screens and will directly navigate to the SSL screen shown below in this manual.

    If you have not checked the box SSO Required, then click Next. The following screen is displayed.

    External User Login Required Check this box to enable user login using MSAD/LDAP user ID.

    Note: If you check this box, the user can log in with MSAD/LDAP server user ID as well as OBCL user ID. If you do not check this box, the user can login using OBCL user ID only.

    External Password Required Check this box to allow user login using MSAD/LDAP password irrespective of the user ID.
    If you check this box, the user can log in using MSAD/LDAP server password only. The user ID can be one of the following -
    • MSAD/LDAP user ID
    • FCUBS user ID

    If you do not check this box, then the installer skips the following screen and directly navigates to the Modifying Gateway Properties screen.

    Authentication Type Select the authentication type. This is the type of external server that is used. Select one of the following options -
    • MSAD (Microsoft Active Directory)
    • LDAP (Lightweight Directory Access Protocol)
    The default option is MSAD. However, it can be changed.
  4. Click Next.
    The Property File Creation screen displays.

    Figure 1-26 Property File Creation



    For more information, refer to the fields description table.

    Table 1-14 LDAP server details.

    Field Description
    LDAP Server URL Specify the URL to access the LDAP server where the external user ID and password are maintained.
    LDAP SSL Enabled Check this box if the LDAP server is SSL enabled. If you check this box, then you need to specify the SSL port also in the field LDAP SERVER URL. By default, this check box is unchecked. However, you can change this.
    Security Authentication Type Depending on the authentication mechanism supported by the LDAP server, select one of the following -
    • Simple
    • Strong
    Notes:
    • Different servers support different authentication mechanisms.
    • By default, the security authentication type is Simple, however, you can change this.
    Domain Name Specify the domain name.
    LDAP Server Timeout Specify the LDAP server timeout in milliseconds. This must be a positive integer value.

    For example, specify 1000, 10000 or 5000. If it is zero or less, it indicates that no read timeout is specified. Then the wait for the response infinite until it is received.

    By default, the LDAP server timeout is zero, however, you can change this.

  5. Click Next.
    The Property File Creation screen displays.

    Figure 1-27 Property file Creation - Modify Gateway Properties



    For more information, refer to the fields description table.

    Table 1-15 Property File Creation - Field Description

    Field Description
    XSD Path Specify the path to the XSD file. The file name is not required. File separator must be /. There must be a / at the end. All the relevant XSD files must be manually copied to this location.
    For example,
    • For Windows - D:\Kernel11.1\GW_WS\XSD\
    • For Linux - /Kernel11.1/GW_WS/XSD/
    Logger File Specify the path to the gw_ ws_logger.properties file with the file name. The file must be manually copied to the specified location.
    For example,
    • For Windows - D:\Kernel11.1\GW_WS\config\gw_ws_logger.properties
    • For Linux - /Kernel11.1/GW_WS/config/gw_ws_logger.properties
    Debug Path Specify the path to the folder where the application creates the logs. There must be a / at the end. You need to manually create the folder structure.
    For example,
    • For Windows - D:\Kernel11.1\GW_WS\log\
    • For Linux - /Kernel11.1/GW_WS/log/
    Security Key for Encryption Specify the security key for the encryption. Here, in this case, it is oraclefinancials.
    SMS Pool Name Specify SMS Pool Name. Here, in this case, it is jdbc/fcjdevDSSMS.
    DataSource The JDBC data source is an object bound to the JNDI tree and provides database connectivity through a pool of JDBC connections.
    POSS Datasource Check this box if POSS is required. If you check this box, specify the POSS Datasource Name in the field below this.
    OPSS CSF Available Indicates whether OPSS-CSF is installed or not.

    Note: Select this only if Oracle Platform Security Services - Credential Store Framework (CSF) is installed as per the guidelines in the pre-requisite document. It is recommended that you install CSF for safeguarding application-specific security credentials.

    Distributed Schema
    • If the schema is distributed, select Yes.
    • If the schema is not distributed, select No
    .
    MSG IN LOG Required Select Yes or No from the drop-down.
    MSG OUT LOG Required Select Yes or No from the drop-down.
  6. Click Next.
    The Property File Creation screen displays.

    Figure 1-28 Property File Creation



  7. On the Property File Creation screen, specify the name of the EJB application deployed.
    For example, GWEJB
  8. Click Next.
    The Gateway Property File Creation screen displays.

    Figure 1-29 Gateway Property File Creation



    For more information, refer to the fields description table.

    Table 1-16 Gateway Property File Creation - Field Description

    Field Description
    EJB JNDI Name If you build the EJB application with the GWEJB name, this will create the name with which the EJB EAR file is built.

    If you select EJB Call Type as REMOTE, this will create <EJB_APPLICATION_NAME>#com.ofss.fcubs.gw.ejb.GWEJBRemote in GW_WS_Prop.properties file.

    For example, Weblogic/ : GWEJB #com.ofss.fcubs.gw.ejb.GWEJBRemote

    Application Server URL Specify the URL of the application server where the web service application is hosted.

    For example, Weblogic: t3://10.10.10.10:7001

    User Name Specify the user name to access the application server where the EJB application is deployed.

    For example, INFRA

    Password Specify the password for the user name.
    EJB Look Up Specify the EJB look up type from the drop-down list. The options are LOCAL/REMOTE.
    Application Type Specify the application type from the drop-down list.
    Notes:
    • If the Application Type is INTEGRATED then the EJB Look Up should be selected as LOCAL.
    • If the Application Type is INDIVIDUAL then the EJB Look Up should be selected as REMOTE, and EJB should configure in any server. (REMOTE only works with the combination of EJB and GWWS).
    • The Installer creates two files viz. gw_ws_logger.properties and GW_WS_Prop.properties in the path provided to save the files.
  9. Click Next.
    The Property Installation screen displays.

    Figure 1-30 Property Installation



    The property file will be created in a temporary folder.

  10. Click Property File to view the created property file.
  11. Click Save to save the created property file in the desired location.
    The property file will be created in a temporary folder.

    For Gateway EAR Building, refer to the Installer EAR Building document.