Download Reportworq

This is the archived documentation for Reportworq 5. It is kept for reference and is no longer updated.

Go to the Reportworq 6 documentation

Overview#

Reportworq Contribution enables customers to efficiently gather planning data from multiple people. Contribution Campaigns automate the process of requesting, receiving, and collating planning data.

Contribution starts with one or more planning report spreadsheets, which might normally be distributed using Reportworq. The reports are turned into Contribution templates by using a special Reportworq Excel add-in to add one or more input formulas defining input ranges that require data input from Contributors. In Reportworq, the Contribution Campaign Manager creates an input form based on one or more of these template reports and assigns it to Contributors and Approvers. Requests for data input are sent to Contributors as email notifications. Each input form can be bursted to dynamically configure it to be specific to the Contributors' area of responsibility. Contributors and Approvers access their input forms on a Reportworq web page. After Contributors complete and submit their input forms, Approvers review and approve them. Alternatively, an Approver can reject an input form, requiring the Contributors for that form to make changes and resubmit. The Campaign Manager monitors the progress of each input form and the Campaign overall.

Collected data can be exported to an Excel file, an IBM Planning Analytics instance, or to a SQL server.

Contribution is a licensed feature of Reportworq. Contribution features are available only if your organization has a valid Contribution license.

The main topics in this article are as follows:

Note: Reportworq Contribution represents the next generation of Reportworq Data Collection functionality. Contribution's web-based form creation and edit/review/approval processes make the collection of planning data easier for Administrators, Contributors, and Approvers. Reportworq Data Collection remains functional for customers who are licensed to use it.

Campaigns are stored within nested folders on the Contribution Campaigns page. In the following example, the Location Expense Planning Campaign is within the Finance > Expense Planning folder.

Tap or click the image to view it full screen

The upper area of the Contribution Campaigns page includes the following buttons and icons:

Each Campaign entry has an Actions list, which includes the following:

The interface for a Campaign consists of an edit page and a Dashboard page:

To navigate between Campaign interface pages:

Process Manager#

The Process Manager page displays Contribution-related performance information for all Reportworq servers. This information may help you make decisions about the number of Load Balancer servers required to handle Contribution processing. If a Contribution participant attempts to access a form when all servers are experiencing over 90% memory usage, the request is denied and the participant receives a message advising them to try again later.

To access the Process Manager page:

Tap or click the image to view it full screen

Icons and buttons along the top of the page are as follows:

You can expand a server entry to view details about individual Contributor sessions. To download the information for a given session as a .zip file in your Downloads folder, select its View Details icon.

Tap or click the image to view it full screen

Configuring a Campaign#

This section explains how to configure a Contribution Campaign using the edit page, which has five tabs:

Before Creating a New Campaign#

Before a new Campaign can be created, a Reportworq Administrator must set up the following in Reportworq:

Create Forms Tab#

The Create Forms tab is on the edit page. To navigate from the Dashboard to the edit page, select Modify Campaign.

Tap or click the image to view it full screen

To access the Create Forms tab for a specific Campaign if starting from the Contribution Campaigns page, navigate to the folder that contains the Campaign, and then select the name of the Campaign. The edit page opens and displays the Create Forms tab.

Tap or click the image to view it full screen

The Create Forms tab has five subtabs:

Reports Subtab

In the Report Selection area, add one or more Contribution templates, and then select all worksheets that require input from Contributors. You can also set Report configuration options such as Sheet Suppression and Sheet Naming.

Tap or click the image to view it full screen

Parameters Subtab

In the Parameter Configuration area, you can define and configure parameters. You can then dynamically create multiple worksheets based on a Parameter definition, and allow parameters to be used in burst sets.

Tap or click the image to view it full screen

Bursting Subtab

Create Burst sets to define worksheets and assign Contacts (optional).

Contacts act as default Contributors if no other Contributors are assigned. Alternatively, you can assign Contributors on the Assign Forms tab or by configuring contact mapping.

Tip: When you finish creating burst sets, you can Export them for future Import.

Tap or click the image to view it full screen

Options Subtab

Tap or click the image to view it full screen

In the General area, specify how input forms are to be named. You must include a variable so each bursted form name (File Name) is unique. In the example below, the File Name for the input form has the Region parameter variable, text, and the Contact Name Address Book variable. To insert a variable value, select the variable type from the dropdown list to the right of the File Name box, select the variable pill in the File Name box, and then select appropriate options.

If you are using a Workday Adaptive Planning Datasource, select Advanced Distribution Options and then set the Relative Start Date, which is used in Workday Adaptive OfficeConnect report specifications:

Tap or click the image to view it full screen

To configure the relative start date:

  1. To use the default relative start date with no adjustments, select Do Not Override.
  2. To set a specific start date, select Absolute Date and then specify the Start Date.
  3. To set a relative start date, select Relative Date and then do the following:

If you want to assign forms to Contributors and Approvers via contact mapping, configure the settings in the Contributor Contact Mapping area and/or the Approver Contact Mapping area. Additional configuration is required. For more information and detailed steps, see Contact Mapping.

Test Subtab

You can test input forms by generating previews and inspecting them:

  1. Select Save Changes.
  2. Select Generate Preview. A list of input forms appears.
  3. Select the Run icon beside one or more input forms. If there are no issues, the status changes from Pending to Success. After a moment, one or more Excel file names appear. If there are any issues, a Warning link appears. Select the link to diagnose any issues. You can download and review Excel files that are generated for this input form. These Excel files are the basis of the Contributor/Approver user interface, but contain more information than participants ever see. Contributors see only the print areas of these Excel spreadsheets.

The following example shows the successful results of testing the West input form.

Tap or click the image to view it full screen

Assign Forms Tab#

On the Assign Forms tab, you generate input forms and then assign one or more Contributors to each form. If the Campaign requires submitted data to be approved, you also assign one or more Approvers to each form. Contributors and Approvers can be assigned as individual contacts and/or Reportworq groups.

As an alternative to generating input forms in Reportworq, you can Upload Forms that you created by other means. When you upload an input form that has an identical Report Name as an existing form, the uploaded form replaces the existing form.
Note: The Upload Forms button is not intended for uploading Contribution input data.

The following figure shows the Assign Forms tab for a Campaign named Expense Planning, before any input forms have been generated.

Tap or click the image to view it full screen

To generate and assign forms:

  1. Select Save Changes.
  2. Select Generate Forms. The Generate Contribution Forms dialog appears.
  3. Select the forms you want to generate, and then select Run.
  4. When the Job Completed message appears, select Close. The generated forms appear on the list.
  5. If you previously exported form assignments and want to import them:
  1. For each input form on the list:
  1. If you want to save input form assignments so you can edit them in Excel and later reimport them, select Actions, and then select Export Assignments. The assignments are saved in an Excel file (.xlsx) named Forms Mapping in the Downloads folder.

Notifications Tab#

There are six default notifications that Reportworq sends to participants via email when certain criteria are met:

You can select a notification to view and edit its contents and settings.

To insert a variable in the Subject field:

  1. Position the cursor where you want to insert the variable.
  2. Expand the associated variables list and then select the variable type. A red variable pill appears.
  3. Select the variable pill and then configure the variable's properties as required.

To insert a variable in a message body:

  1. Position the cursor where you want to insert the variable.
  2. From the Reportworq menu, select Insert Variable and then select the type of variable you want to insert. In the following figure, Timestamp is selected. A red variable pill appears.
  3. Select the variable pill and then configure the variable's properties as required. Tip: If you want to apply HTML formatting to variables, first select Toggle Format Mode from the Reportworq menu. Variable pills switch to plain text codes that can more easily be selected and formatted. To avoid breaking a variable, do not edit the code between the square brackets, for example, [[code]]. Apply any formatting to the entire pill text. To return to the WYSIWYG view, toggle the format mode again.

When you finish editing, Save Changes.

The following is an example of an Approver Workflow notification.

Tap or click the image to view it full screen

Notification Templates

Notification templates enable Campaign Managers to save and reuse the contents of notifications. A template contains the message body from a notification. You can save new templates or modify existing ones, including default templates. When any template is created or modified, it is available to all Campaign Managers. Change to default templates apply to all new Campaigns regardless of who creates them.

The six default templates are designed to be used for the six default notifications. If you edit and save these default templates, new campaigns will include the modified versions as defaults. If you want to revert one of default notifications to its original version, delete it. Instead of being deleted, it will revert to its original contents.

To create or modify a template:

  1. Edit an existing template and select Save Changes.
  2. From the menu at the top of the message editor, select Templates > Save Template, and then do one of the following:
Tap or click the image to view it full screen

To Load, Rename, or Delete a Template:

  1. Select any template from the Notifications list. The message editor appears.
  2. From the menu at the top of the message editor, select Templates > Load Template. The Select a Template pane appears. You can select each template to see a preview.
  3. If you want to load a template, select it and then select OK. Tip: You can edit the loaded message to customize it for your Campaign before you select Save Changes.
  4. If you want to rename a template, select the three-dot menu beside the template name and then select Rename. Type a unique name and then select OK.
  5. If you want to delete a template or reset a default template to its original contents, select the three-dot menu beside the template name and then select Delete. Confirm the deletion.

Exports Tab#

Export definitions (exports) control how and when Contribution data is exported. Data can be exported to a Planning Analytics Cube, a Database Table, or an Excel file (.xlsx or .csv). You can create any number of exports.

An export can be run or downloaded on demand from the Exports tab, or run on demand from the Campaign Dashboard. You can also define trigger conditions that run the Export when they are met.

Tap or click the image to view it full screen

To create an export:

  1. On the Exports tab, select New Export. The New Export dialog appears.
  2. Provide a name for the export, and then select OK.
  3. Define the properties of the export as follows:
  1. If you want to create a trigger, in the Trigger area select a trigger type and then configure the trigger conditions. When the trigger conditions are met, the export runs. You can create any number of triggers. Trigger types are as follows:
  1. Define the Export Configuration, which is the information required to export data via the Export Type you selected in Step 3d. The following are examples of Export Configurations for the three Export Types (Planning Analytics Cube, File, and Database Table):

To run or download an export from the Exports tab:

Options Tab#

The Options tab contains settings related to the overall Campaign, and are grouped into four sections:

Tap or click the image to view it full screen

General Options#

Tap or click the image to view it full screen

General options are as follows:

Campaign Status (optional)#

Tap or click the image to view it full screen

Campaign Status options are as follows:

Auto Archive#

Tap or click the image to view it full screen

Auto Archive options are as follows:

Export/Import Options#

Tap or click the image to view it full screen

Export/Import options are as follows:

Managing a Campaign#

This section explains how to manage a Contribution Campaign from the Dashboard.

To access the Dashboard for a specific Campaign if starting from the Contribution Campaigns page, navigate to the folder that contains the Campaign, and then select the Dashboard button across from the Campaign name.

Tap or click the image to view it full screen

The Dashboard displays a list of generated input forms. In the following example, the Campaign is running and participants have engaged with it.

Tap or click the image to view it full screen

The Dashboard features the following information columns:

A lock icon beside the Status indicates that someone is currently reviewing or editing the input form.

Run, Pause, or Stop the Campaign#

You can Run, Pause, or Stop the Campaign:

Tap or click the image to view it full screen

Note: Automations such as schedules, webhooks, and workflow events for notifications or exports do not run when a campaign is paused or stopped.

Search and Filter#

You can use the Search box to filter the list. You can also filter the list to display only input forms that have a specific status. The number beside each predefined filter name indicates how many forms have that status.

Tap or click the image to view it full screen

Actions#

The buttons in the Actions column provide access to the following options:

Tap or click the image to view it full screen

The Form Details tab displays a list of data changes, validation issues, and general comments from Contributors and Approvers. It includes entries for all worksheets of the input form. When you select an item in the list, the corresponding data cell on the input form becomes active (green box).

Tap or click the image to view it full screen

You can expand or collapse the list for each worksheet.
To refresh the list, select a different tab and then select the Form Details tab.

To the left side of each each list item is one of the following icons:

If the list item is followed by a comment icon , the cell has one or more associated comments. Select the icon to open the cell's comment box.
The Form Details tab itself shows the number of changes , and indicates the presence of validation warnings or validation errors . If there are both warnings and errors, only the validation error icon is shown.

Tap or click the image to view it full screen

Update Forms#

You can regenerate all input forms to ensure they are current.

Update Forms regenerates the input forms to show refreshed and recalculated data if the input form has been configured to load data from a supported datasource. The user's modifications to the form are retained.

Download All Forms#

Download All Forms downloads copies of all forms if none or all forms are selected. If one or some of the forms are selected the Download Selected Form(s) button appears instead. The forms are saved to the local Downloads folder as Excel .xlsx files. If multiple forms are downloaded, they are packaged in a .zip file. Downloaded forms are intended for review purposes only, not for data entry.

Send Notifications#

You can send notifications to invite Contributors and Approvers to participate in the Campaign, or to remind them of outstanding tasks to be completed. You can also send custom messages. Notifications work only when the Campaign is running.

Tap or click the image to view it full screen

Notifications are as follows:

Run Exports#

To export data, select an export definition from the Run Export list. You can export data anytime the Campaign is running.

Clear Data#

To delete saved data and reset the selected input forms to Not Started status, select Clear Data.
Tip: If no input forms are selected, Clear Data applies to all forms.

End the Campaign#

The following optional tasks are typically performed at the end of a Campaign:

  1. On the Dashboard page, check the Status of all forms to determine whether the Campaign has gathered all the data you need. You can Send Notifications to prompt participants to finish their work.
  2. Stop the Campaign.
  3. Export the data (Run Export).
  4. Download All Forms if you might want to view the data recorded on the input forms later and/or keep an archive of the forms. The forms are downloaded as a .zip file in the Downloads folder.
  5. Send a Custom Message (Send Notifications > Custom Message) to All Contributors and All Approvers to let the participants know the campaign is over. If you select the Attach Input Forms option, participants will receive a copy of the forms they submitted or approved.
  6. Export the Campaign if you want to save the entire Campaign, including gathered data, to the Downloads folder as a .zip file. On the Contribution Campaigns page, from the Actions list, select Export Campaign.

Workflow for Contributors and Approvers#

A Reportworq Contribution Campaign can solicit and collect planning data from multiple Contributors. For example, a Campaign might gather budgeting data from each regional manager for each state within their region. Contributors provide data on web-based input forms, and then an Approver reviews and approves the data. Depending on Campaign settings, data approval may not be required, in which case the data is considered approved as soon as any Contributor submits it.

Each input form can be assigned to any number Contributors and Approvers. You may be a Contributor for some input forms and an Approver for others.

Whether you are a Contributor, Approver, or both, your Reportworq activity begins when you receive an invitation to participate. The invitation includes a link that prompts you to log in and then opens Reportworq in a web browser. In the following example, Reportworq displays a list of input forms that require the participant's attention.

Tap or click the image to view it full screen

For input forms that have an Edit Form button, you are a Contributor.
For input forms that have a Review Form button, you are an Approver.

Note: You may have access to multiple workspaces. If the workspace icon is visible in the top toolbar, select it to view a list of workspaces.

To open an input form, select its name or its button (Edit Form or Review Form).

Tap or click the image to view it full screen

The input form looks almost identical for Contributors and Approvers. The example above includes multiple worksheets, each containing data for one state. This worksheet layout features a table of values and two charts. As the data is edited, the charts and calculated values are updated in real time.

The design of input forms is based on a Microsoft Excel spreadsheet, so they include features similar to those found in Excel. For example:

Symbols on worksheet tabs indicate whether they contain data validation warnings and/or errors . If the worksheet contains both warnings and errors, only the errors icon is shown.

If you are a Contributor, your job is to review the input form and edit data in the input cells of each worksheet as required. You can also review and add general comments and cell-level comments. You can Close the form at any time to save your data changes as a work in progress, but comments are not saved. When you are finished editing data and adding comments, Submit the form.

If you are an Approver, your job is to review data and comments on each worksheet of the submitted input form. You can add general comments and, depending on Campaign settings, you may be able to edit data and add cell-level comments. When you are finished reviewing/editing the data and adding comments, you must either Reject or Approve the form.
If you Reject the input form, a Contributor must review it, make changes if needed, and resubmit.

The following figure shows input cells.

Tap or click the image to view it full screen

Symbols that may appear within input cells are as follows:

Tap or click the image to view it full screen

Details Pane#

The Details pane provides information and tools to assist Contributors and Approvers. The following icons appear along the top of the Details pane:

Tap or click the image to view it full screen

Add Cell Comment -- Opens the Commentary dialog for the selected cell. You can view previous comments and/or type a new one. Alternatively, you can select a cell's comment icon to open its Commentary dialog.

Highlight Input Cells -- Turns green highlighting of input cells on and off. Highlighting may help you identify data you need to review and/or edit.

Undo and Redo:

Because Reportworq maintains a list of actions as you perform them, you can undo or redo multiple actions by selecting undo or redo repeatedly. If you close an input form and reopen it, the list is still active and you can undo or redo earlier actions. If you submit, approve, or reject an input form, the list of actions is cleared.

Settings -- The dropdown list includes the following settings:

Show/Hide Details -- Extends and retracts the Details tab.

The Details pane has two tabs - Workflow and Form Details.

Workflow Tab#

The Workflow tab displays an event record consisting of status changes and associated comments from Contributors and Approvers. Comments from your current session are saved only if you select Submit, Approve, or Reject. They are not saved if you select Close.

Below the event record are one or more action buttons. When you finish reviewing and/or editing the input form, select the appropriate button:

Below are examples of the Workflow tab when validation errors are blocking submission (left) and showing the event record after the input form has been approved (right).

Tap or click the image to view it full screen

Form Details Tab#

The Form Details tab displays a list of data changes, validation issues, and general comments from Contributors and Approvers. It includes entries for all worksheets of the input form. When you select an item in the list, the corresponding data cell on the input form becomes active (green box).

Tap or click the image to view it full screen

You can expand or collapse the list for each worksheet.
To refresh the list, select a different tab and then select the Form Details tab.

Beside each list item is one of the following icons:

If the list item is followed by a comment icon , the cell has one or more associated comments. Select the icon to open the cell's comment box.

The Form Details tab shows the number of changes , and indicates the presence of validation warnings or validation errors . If warnings and errors are both present, only the validation error icon is shown.

Tap or click the image to view it full screen

Viewing and Editing Forms Offline in Excel#

If the Download Form button is present, you can download the form and view it in Excel.

If the Upload Form button is also present, you can download the form, edit it in Excel, and then upload it to Reportworq.

Tap or click the image to view it full screen

To view, edit, and upload a form:

  1. Select Download Form. The form is saved to the Downloads folder on your computer, as an Excel .xlsx file.
  2. Open the form in Excel.
  3. Edit data in the input range of each worksheet as required.
  4. Save and close the file.
  5. In the Reportworq web interface, open the form.
  6. Select Upload Form, navigate to the file, and select Open. Any values you changed offline appear in Reportworq, just as they would if you had edited them online.

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.