1. Working with Oracle Forms
  2. Administration
  3. Oracle Forms Configuration Helper Script

Oracle Forms Configuration Helper Script

The Oracle Forms Configuration Helper script frmconfighelper helps administrators easily perform typically complex post install, Forms configuration tasks.

Before using the Helper script, it is assumed that you have successfully installed Oracle Forms 14c and completed its initial configuration using the config.sh or config.bat script. Use of this script is preferred over attempted to make these changes manually.

The Oracle Forms Helper Script is located in MW_HOME\forms\provision directory.

For more information about using this script, run the script without any arguments. This will present detailed usage information.

The script includes the following functions:

  • enable_ohs: Enables routing for the location/forms from OHS to the Forms managed server(s) under cluster cluster_forms.

    Note:

    When enable routing to multiple Forms managed servers, provide the managed server host port information in sequence.
  • deploy_app: Deploys formsapp ear file, overriding the context-root and servlet alias to the specified managed server.
  • update_app: Updates a deployed app (with an overridden context root) after applying FMW Forms Services patches.
  • enable_webgate: Used only if partner app is registered via OAM console. This should not be used if enable_sso was previously used.
  • create_machine: Creates a new (remote) WLS machine for custom Forms application deployment (see create_managed_server).
  • create_managed_server: Creates a new managed server for custom Forms application deployment (see deploy_app).
  • enable_sso: Enables Webgate configuration in the OHS instance, performs partner application registration using OHS SSL and non-SSL ports and copies over the Webgate artifacts to the OHS instance.

Note:

Make sure to back up the Domain before performing any administration tasks on it using this script.

Table -26 frmconfighelper script

Option When to use it What it does Components Requiring Restart
enable_webgate

When you have added any new OHS instances and you want to individually enable Webgate configuration on the OHS instance.

This command should not be used if the enable_sso command was previously used.

Enables Webgate configuration on the OHS instance.
  • Admin Server
  • OHS
deploy_app

After you have run the Config Wizard and, want to deploy the Forms javaEE application again to override the default context-root and the Forms servlet alias.

Example: The default Forms JavaEE application access URL is:

http(s)://host:port/forms/frmservlet

If you override the context-root to sales and Forms Servlet alias to salesservlet, the application access URL will be:

http(s)://host:port/sales/salesservlet
  • Overrides the Forms JavaEE application context-root, Forms Servlet alias and packages the Forms JavaEE application into a new ear file.
  • Deploys the ear file to the Weblogic Domain and activates it the Managed Server.

You need to create the Managed Server before you run deploy_app option.

  • Admin Server
  • Managed Server associated with deployment
update_app When you ran deploy_app option and you want to update the custom application after a patch release. Updates the JavaEE custom ear file created with deploy_app option after a patch release.
  • Admin Server
  • Managed Server associated with deployment
enable_ohs When you have created a new OHS instance and you want to enable routing to a Forms Managed server. Adds Managed server routing directives to the template forms.conf, copies it over to the OHS instance.
  • Admin Server
  • OHS
create_machine Used when working with a remote node or if a default machine is not desirable for adding managed servers for custom deployments created by this utility. Creates a new WLS machine.  
create_managed_server

Used to create a custom managed server that will host a customized Forms J2EE app deployment.

This managed server is intended to be used with the custom app deployed created by this utility (see deploy_app). This function should not be used for creating generic, non-Forms servers.

 Creates a custom managed server.  
enable_sso Used to enable SSO with SSL in the Forms environment.
  • Enables OHS-Forms Managed Server routing.
  • Enables Webgate configuration on the OHS instance.
  • Performs partner application registration on the OHS instance.
  • Creates a policy on the OAM server to protect the Forms and Reports application.
  • Admin Server
  • WLS_FORMS
  • OHS
  • Syntax

    frmconfighelper.cmd <option> <arguments>

  • Options
    • enable_ohs <domain-home> <ohs-instance> <forms-managed-server1-host> <forms-managed-server1-port> <forms-managed-server2-host> <forms-managed-server2-port>
    • deploy_app <new-context-root> <new-servlet-alias> <managed-server>
    • update_app <Forms-context-root> <Forms-servlet-alias>
    • enable_webgate <domain-home> <ohs-instance>
    • create_machine <wls-machine-name> <machine-host-name>
    • create_managed_server <mananged-server-name> <wls-machine-name> <managed-server-port> <standalone>
    • enable_sso <oam-host> <oam-port> <ohs-host> <ohs-ssl-port> <ohs-non-ssl-port> <domain-home> <ohs-instance>

Argument Description

The argument description of each of the functions included in the script are provided in this section.

The details of argument description are as follows:

  • enable_ohs
    • domain-home: Domain Home directory
    • ohs-instance: OHS instance name (example ohs1)
    • forms-managed-server(n)-host: Forms managed server host
    • forms-managed-server(n)-port: Forms managed server port
  • deploy_app or update_app
    • new-context-root: new context root for the formsapp
    • new-servlet-alias: new servlet alias for the formsservlet
    • managed-server: target managed server for the new application
  • enable_webgate
    • domain-home: Domain Home directory
    • ohs-instance: OHS instance name (example ohs1)
  • create_machine
    • machine-name: WLS machine name
    • host-name: Remote WLS machine host name
  • create_managed_server
    • managed-server-name: Managed server name
    • wls-machine-name: WLS machine name
    • managed-server-port: Managed server port number
    • standalone (optional): Indicates standalone managed server which is not part of any cluster.
  • enable_sso
    • oam-host: OAM Server host name
    • oam-port: OAM Server port number
    • ohs-host: OHS host name
    • ohs-ssl-port: OHS SSL port number
    • ohs-non-ssl-port: OHS NON-SSL port number
    • domain-home: Domain Home directory
    • ohs-instance: OHS instance name (example ohs1)

Examples of each Function

Follow the examples provided for each of the functions include in the script.

  • enable_ohs
    frmconfighelper.sh enable_ohs /middleware/user_projects/domain/base_domain ohs1 wlshost.example.com 9001 wlshost.example.com 9010
  • deploy_app
    frmconfighelper.sh deploy_app sales salesservlet WLS_FORMS3
  • update_app
    frmconfighelper.sh update_app sales salesservlet
  • enable_webgate.
    frmconfighelper.sh enable_webgate /middleware/user_projects/domain/base_domain ohs1
  • create_machine
    frmconfighelper.cmd create_machine SalesRemoteMachine remotehostname
  • create_managed_server (2 examples)
    frmconfighelper.cmd create_managed_server WLS_SALES AdminServerMachine 9010
    frmconfighelper.cmd create_managed_server WLS_FINANCE AdminServerMachine 9020 standalone
  • enable_sso
    frmconfighelper.cmd enable_sso_ssl oamhost.example.com 7001 ohshost.example.com 4443 7777 
/middleware/user_projects/domain/base_domain ohs1