Configuring a dynamic custom web portal

You can integrate the on-demand target function into your own website by configuring a dynamic web portal. This type of integration allows your website to communicate with the IBM® BigFix® Remote Control server through a set of service URLs.

About this task

The URLs can be used in the following ways.
  • To submit custom session data to the IBM BigFix Remote Control server, so that it can be saved to the server.
  • To validate the connection code, to check it before the on-demand target application and delivery plug-ins are downloaded.
  • To retrieve the broker environment configuration dynamically and avoid having to manually edit the properties file. For example, when the set of brokers changes, or a new trusted certificate is added.
The on-demand target function requires a dynamic web to be set up because the interactions between your web server and the internal IBM BigFix Remote Control server must be programmed into your website. Therefore, a good working knowledge of the specific dynamic web technology that is used in your environment is required.

Many different technologies can be used to implement a dynamic website. Details cannot be provided about how to achieve the required function because the necessary steps are different depending on the chosen underlying technology.

To configure a dynamic portal, complete the following steps:

Procedure

  1. Go to the following directory on the remote control server.
    RC_SERVER_INSTALL_DIR\wlp\usr\servers\trcserver\apps\TRCAPP.ear\trc.war\ondemand

    Where: RCSERVER_INSTALL_DIR is the IBM BigFix Remote Control server installation directory. The ondemand directory contains 9.x.x version number directories.

  2. Copy the following files and directories from the latest version number directory to a version number directory on your own website.
    Files
    ODTJPlugin.jar, ODTIEPlugin.cab, odtffplugin.xpi, and TRCPlayer.jar.
    Directories
    lnx32, lnx64, and win32.

    The contents of these directories must be copied also to your website.

  3. Create a page for the target user to enter the custom data and the connection code.
    The page can be generated by your web server. You can use the trc/broker/OnDemandCustomDataConfig service URL to retrieve the current set of custom data fields that are configured on the IBM BigFix Remote Control server.
    Table 1. /trc/broker/OnDemandCustomDataConfig URL

    Description of the parameters and output for the /trc/broker/OnDemandCustomDataConfig URL.
    URL /trc/broker/OnDemandCustomDataConfig
    HTTP Method GET
    Parameters N/A
    Output HTTP 200 OK with the following payload:
    <response>
<remotecontrol>
<field name="Field1" label="Label for Field 1" 
required="true or false"/>
<field name="Field2" label="Label for Field 2" 
required="true or false"/>
....
</remotecontrol></response>

    The number of <field> elements that are returned depends on the configuration in the ondemand.properties file on the server.

    The name attribute specifies the parameter name that is expected for the field, when it is submitted back to the server.

    The label attribute specifies the display value for the locale that is requested in the HTTP request by using the Accept-Language header.

    The required attribute is a true or false value. The attribute specifies whether a value is required for this field when submitted to the IBM BigFix Remote Control server.
    When the page is submitted to the dynamic portal, the data can be sent to the IBM BigFix Remote Control server by using the URL broker/OnDemandSessionData. The OnDemandSessionData URL validates the connection code and any custom data fields provided.
    Note: The data must be sent because the target user's browser cannot access the IBM BigFix Remote Control server directly, but can access only your dynamic portal.
    Table 2. /trc/broker/OnDemandSessionData URL

    Description of the parameters and output for the /trc/broker/OnDemandSessionData URL.
    URL /trc/broker/OnDemandSessionData
    HTTP Method POST
    Parameters conn_code
    Output HTTP 200 OK - If the data is correct

    No payload

    HTTP 404 - The connection code is unknown

    No payload

    HTTP 400 - The required session information is empty or not provided

    No payload

    HTTP 408 - The required session has timed out

    No payload
    If the data is successfully submitted, the dynamic portal can redirect the target user to the page where the installation plug-in is activated.
  4. Create a launching page.
    For information about the content for generating the pages, see step 4. You can generate the launching page from your web server by using the trc/broker/OnDemandSessionConfig URL. The OnDemandSessionConfig URL returns the configuration to be used by the plug-ins. A simple page must be created that forwards the request to the server and returns the configuration data. Set the value of the config_url parameter to the URL of the page. The plug-ins then use the URL defined in the config_url parameter to retrieve the configuration from the IBM BigFix Remote Control server.
    Table 3. /trc/broker/OnDemandSessionConfig URL

    Description of the parameters and output for the /trc/broker/OnDemandSessionConfig URL.
    URL /trc/broker/OnDemandSessionConfig
    HTTP Method GET
    Parameters conn_code
    Output HTTP 200 OK - Connection code is valid
    ConnectionCode=12345
BrokerList=rcbroker.example.org:8881
-----BEGIN CERTIFICATE-----
Base64 encoded certificate data
-----END CERTIFICATE-----

    Where: Base64 encoded certificate data is the certificate data for the specific certificate.

    HTTP 404 - Connection code is unknown

    No payload
    .