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 Content Delivery computer that sends completed forms to the "server" -- the aggregation server computer.

Procedure

  1. Log on to Content Delivery as a user with the Manage application permission.
  2. If you are in a Content Delivery tool, click Home in the breadcrumb trail.
    The Content Delivery landing page appears.
  3. In the Administration Tools pane, click Manage Application.
    The Manage Application page appears.
  4. In the left navigation pane, click Global Config.
  5. Set the values on the following config items:
    NameValue
    xforms.aggregation.keyA unique string. This must match the same config 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 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 Content Delivery, 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. If you have already set up audit trail aggregation, you do not need to add this configuration item again.

    xforms.aggregation.enableSet to Yes to enable Forms aggregation.
  6. Click Save.
  7. Do one of the following:
    • For Content Delivery systems that use the built-in web app server, edit ContentDelivery_home/conf.xml.
    • For Content Delivery systems that use Apache Tomcat as the web app server, edit Tomcat_home/webapp/LiveContent/WEB-INF/conf.xml
  8. 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"/>
  9. 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 Content Delivery service.
  10. 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

  11. Validate that XForms aggregation is occurring by viewing the logs.
    • For Content Delivery systems using the built-in web app server, on the client, view ContentDelivery_home/logs/wrapper.log.
    • For Content Delivery systems using 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/