Documentation Center

Setting Up Forms Aggregation - Client

Forms aggregation lets you gather all of the floating and document-attached form instances being generated on multiple client systems onto a single server so that you can analyze them.

About this task

For the purposes of this procedure, "client" is the Legacy Content Delivery computer that sends completed forms to the "server" -- the aggregation server computer.

Procedure

  1. Log on to Legacy Content Delivery as a user with the Manage application permission.
  2. In the Legacy Content Delivery Administration Tools pane, click Manage Application.
    The Manage Application page appears.
  3. In the left navigation pane, click Global Config.
  4. Set the values on the following config items:
    NameValue
    xforms.aggregation.keyA unique string. This must match the same configuration value on the server.
    xforms.aggregation.urlURL of the server, in the following format: http://server_host_id:server_port_#/ContentDelivery/ where server_host_id is the server host name and server_port_# is the port on which the server Legacy Content Delivery instance is running. server_port_# is specified if you need to replace the standard port, in most cases this is not needed. A standard example would be http://aggregation.lc.example.com/ContentDelivery/ (where lc refers to an example related to output, and aggregation specifies it further as a server dedicated to aggregation)
    host.idHost ID of the client.

    This is a unique key that identifies the client.

    xforms.aggregation.enableSet to Yes to enable Forms aggregation.
  5. Click Save.
  6. Edit Tomcat_home/webapp/LiveContent/WEB-INF/conf.xml.
  7. Un-comment the line that defines the job for aggregation: <job name="xforms.aggregation" type="user" xquery="/db/LiveContent/ui/skins/base/xql/xforms_aggregation.xql" period="1800000" delay="0"/>
  8. Adjust the following values to set the timing of aggregation:
    OptionDescription
    periodFrequency, in milliseconds, that the aggregation occurs.
    delayDelay, in seconds, before aggregation occurs after restarting the Legacy Content Delivery service.
  9. Do one of the following:
    • On Windows, restart the LiveContent XML Database service.
    • On Linux, log in as the root user, and type the following at a command prompt:

      /etc/init.d/SDL_LiveContent restart

  10. Validate that XForms aggregation is occurring by viewing the logs: If you use Tomcat, look for Tomcat_home/logs/tomcat7std-out*.log or tomcat7std-err*.log.
    The success and failure messages appear like one of the following:
    XForms Aggregation: status=FAIL message=required URL not
    defined
    XForms Aggregation: status=DISABLED
    XForms Aggregation: status=SUCCESS enable=yes selected=3
    stored=3 marked=3 serverURL=http://aggregation.lc.example.com/ContentDelivery/