Download Reportworq
⬇ Guide PDF

Data collection processing#

Data Collection is the write-back layer that takes collected contribution input, an uploaded input workbook or one received in a monitored mailbox, and writes its values back to the target system, for example a TM1 or Planning Analytics cube or a SQL table. This guide is for the administrator who runs and troubleshoots that processing.

Data Collection is part of the licensed Contribution capability. Without it, the Data Collection settings show "Data Collection is not included in your license," and you contact Reportworq to enable it.

When to use it. After contribution forms are submitted or approved and a campaign export runs, or whenever input workbooks arrive by upload or into the monitored mailbox and need to post to the source planning system.

Before you start#

Two write-back paths#

Reportworq writes contribution data back to a planning system in two ways. They share the licensed Contribution capability and nothing else: they are separate pipelines, they reach the target by different means, and a given round uses one or the other.

A campaign export does not go through the Data Collection engine. It does not queue a write-back item, and it does not evaluate the hidden write-back formulas. If you are looking for a campaign's values in the write-back activity list, they will not be there; a campaign's exports are recorded in the campaign's own activity.

The rest of this guide covers the Data Collection engine path.

How write-back items are processed#

Write-back items enter one of two ways and then move through the same processing pipeline.

  1. Upload. An administrator or author uploads an input workbook from the write-back activity view (Upload…). With Automatically process uploaded files turned on, the upload processes on arrival. Otherwise, select the pending item and run Process.
  2. Mailbox. The monitored inbox is polled on a configured frequency, and matching messages become items. Select Check Inbox to poll on demand.

Each item begins Pending, moves to Running as the engine writes its data to the target, and finishes Complete. The write-back activity grid lists every item with its Filename, Submitter, Uploaded, Processed, and Status, plus per-row Run and Details actions.

After a file is processed, an audit record of the write-back outcome is written to the input archive.

Configure Data Collection#

Open Configuration ▸ Data Collection to set the processing behavior.

Setting What it does
Enable Data Collection Turns the feature on (requires the Contribution capability).
Automatically process uploaded files Processes an upload immediately instead of waiting for a manual Process.
Enable Verbose Logging Adds diagnostic detail for troubleshooting.
Enable Trace Logging Adds deeper diagnostic detail. Use only when Reportworq support asks, since it is heavier.
Process Messages How far back, in days, mailbox messages are considered (the lookback window).
Polling Frequency How often the inbox is polled.
History Retention How long, in days, processed history is retained.
Proportional Writeback (PA) Off by default. Off rejects consolidated-cell updates; on lets Planning Analytics spread the value. See below.

Let consolidated-cell writes through (Proportional Spreading)#

By default, Reportworq rejects any attempted update to a Planning Analytics consolidated cell, matching the Planning Analytics Excel add-in. If a form appears to "lose" a top-level input, that input was most likely rejected for this reason.

To allow a submission to a consolidated cell, turn on Proportional Writeback. The value is then sent to Planning Analytics with the proportional-spread marker (a P prefix), so Planning Analytics allocates it across the leaf cells based on their existing data.

Set up the monitored mailbox#

Open Configuration ▸ Data Collection ▸ Mailbox Settings and complete the connection.

Setting Notes
Provider Modern Authentication (Microsoft 365 OAuth app registration) or Basic Auth (username and password).
Protocol POP3 or IMAP.
Server / Port Your mail server host and port.
Use SSL TLS/SSL for the connection.
Username / Mailbox address The mailbox account (the mailbox address under Modern Authentication).
Password The mailbox credential (Basic Auth).

Exchange Online mailbox: two traps#

If the monitored mailbox never picks up messages against Exchange Online, it is almost always one of these two causes:

Prune the monitored mailbox#

Reportworq records processed mailbox messages in its own internal database so it never reprocesses the same message. That means the mailbox itself is not emptied by processing, and processed messages accumulate in it over time.

Apply a retention rule to the monitored inbox, for example archive or delete messages after a set period, so the mailbox does not grow unbounded. The processed-message history that Reportworq keeps is separately bounded by the Days to Keep setting.

Notes and limits#

Going deeper. For live memory pressure on the contribution worker fleet during a large collection round, see Contribution processes. For symptom-to-fix pairs, see Troubleshooting index.

Feedback on this page

Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.

Email feedback on this page

Or write to support@reportworq.com directly.