- 24 Oct 2024
- 22 Minutes to read
- Print
- DarkLight
Contribution Campaigns
- Updated on 24 Oct 2024
- 22 Minutes to read
- Print
- DarkLight
Overview
ReportWORQ Contribution enables customers to efficiently gather planning data from multiple Contributors. 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 input formula(s) defining input range(s) that require Contributor data entry. 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 them to be specific to the Contributor’s 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 the input form, requiring the Contributor 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.
Navigation
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.
Users can select an existing Campaign, add a New Folder, or add a New Campaign.
The Campaign interface consists of an Edit page and a Dashboard page. When a user selects an existing campaign or adds a new one, it opens on the Edit page, where they can configure the Campaign. On the Dashboard, users can run and manage the Campaign.
Buttons on the Edit page and on the Dashboard enable users to switch between them.
Configuring a Campaign
This section explains how to configure a Contribution Campaign using the Edit page, which has five tabs:
Create Forms - Add template reports, add parameters, define bursting, and select options.
Assign Forms - Generate input forms and then assign Contributors and Approvers to the forms.
Notifications - Edit the contents of notifications and configure related options.
Exports - Define one or more methods of exporting collected data.
Options - Set additional options such as whether data approval is required.
Before Creating a New Campaign
Before a new Campaign can be created, a ReportWORQ Administrator must set up the following in ReportWORQ:
Contribution template(s) - These are reports that contain formulas to identify data input ranges. These templates are created in Excel, using a special ReportWORQ add-in. Contribution templates must be added to ReportWORQ as Report Providers.
Tip: Remember to set the desired print area for the input form when designing it in Excel. The Contributor sees only the set print area when they open the input form for data entry.
Address Book Contacts - All potential Contributors and Approvers must be listed in the ReportWORQ Address Book. For each designated Contact, select the Contribution User check box and specify an email address for receiving notifications. The number of Contribution users may be limited, depending on your organization’s ReportWORQ license.
Create Forms Tab
The Create Forms tab is on the Edit page. To navigate from the Dashboard to the Edit page, select Switch to Edit.
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.
The Create Forms tab has five areas:
Reports
Parameters
Bursting
Options
Test
Reports
In the Report Selection area, add the Contribution template(s), and then select the worksheet(s) that require input from Contributors. You can also set Report configuration options such as Sheet Suppression and Sheet Naming.
Parameters
You can define and configure parameters during the Create Forms process. You can then dynamically create multiple worksheets based on a Parameter definition, and allow parameters to be used in burst sets.
Bursting
Create Burst sets to define worksheets and assign Contacts (optional).
By default, the assigned Contacts are the Contributors. Alternatively, you can assign Contributors later in the process.
When you finish creating burst sets, you can Export them for future Import.
Options
In the Distribution Options 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 text, the Region variable, and a timestamp variable (AD). To insert a variable value, drag a variable pill into the File Name box, select the pill, and then select appropriate options.
Test
You can test input forms by generating previews and inspecting them:
Save Changes.
Select Generate Preview.
A list of input forms appears.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 area of these Excel spreadsheets.
The following example shows the successful results of testing the West input form.
Assign Forms Tab
On the Assign Forms tab, you can Generate Forms for the Campaign, and then assign Contributors to them. Always Save Changes before generating input forms.
If the Campaign requires all submitted data to be approved, assign one or more Approvers to each input form. Each submitted form requires only one approval, regardless of how many Approvers are assigned to it. The Campaign-wide requirement for approval is controlled by a setting on the Options tab.
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.
Notifications Tab
There are six default notifications that ReportWORQ sends to participants via email when certain criteria are met:
Approver Invitation - sends invitations to all Approvers in the Contribution Campaign, at the scheduled start time or when executed from the Campaign Dashboard.
Approver Reminder - sends reminders to all Approvers who have pending input forms that require approval, at scheduled intervals or when executed from the Campaign Dashboard.
Approver Workflow - sends notifications to Approvers when an input form has been submitted for approval or recalled by the Contributor.
Contributor Invitation - sends invitations to all Contributors in the Contribution Campaign, at the scheduled start time or when executed from the Campaign Dashboard.
Contributor Reminder - sends reminders to all Contributors who have pending input forms that require submission, at scheduled intervals or when executed from the Campaign Dashboard.
Contributor Workflow - sends a notification to a Contributor when their submitted input form has been approved or rejected by an Approver.
You can select a notification to view and edit its contents and settings. To insert a variable value, drag a variable pill to where you want to insert the variable, select the pill, and then select the appropriate options. When you finish editing, Save Changes.
The following is an example of an Approver Workflow notification.
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:
Edit an existing template and select Save Changes.
From the menu at the top of the message editor, select Templates > Save Template, and then do one of the following:
If you want to create a template, specify a unique Template name.
If you want to modify a template, select it from the list.
To Load, Rename, or Delete a Template:
Select any template from the Notifications list.
The message editor appears.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.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.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.
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 control how and when Contribution data is exported. Data can be exported as a Planning Analytics Cube, a Database Table, or an Excel .xlsx file.
To define an export, you specify a name and data model, set filters, specify the export type, and set triggers (optional).
Filters
You can choose whether to export data from approved forms only, or to include data from submitted forms that have not been approved. You can also choose whether to export all data, or only data that has changed. Unsubmitted work in progress is never exported.
Triggers
Data exports can be run on demand from the Dashboard. You can also set one or more triggers to run the export. Triggers are optional.
Trigger types are as follows:
Schedule Trigger - runs the export at the scheduled time.
Webhook Trigger - runs the export when a specified Action Name is received via a specified webhook URL.
Form Status Change Trigger - runs the export when a specified status change occurs.
Export Type
You can export data as a Planning Analytics Cube, a Database Table, or an Excel .xlsx file.
The following is an example of an Export Definition that exports approved data to an Excel file when the Workflow: Approved trigger condition is met.
The following is an example of an Export Configuration that exports to a Database Table.
The following is an example of an Export Configuration that exports to a Planning Analytics Cube.
Options Tab
On the Options tab, you can do the following:
Specify whether submitted input forms require approval.
Allow or disallow Approvers to modify data on input forms. If selected, Approvers can edit data submitted by Contributors and add cell-level comments.
Edit messages that are generated when the campaign is Paused or Stopped. The messages appear in the activity log.
You can also distribute the messages via email. Specify the email address of the sender and the recipient(s). If there are multiple recipients, separate their email addresses by inserting a semi-colon and a space between them. For example, person1@rw.com; person2@rw.com; person3@rw.com.Configure options that allow Contributors to export and reimport input forms as Excel files.
Export/Import options are as follows:Allow for Export/Import of Excel file for Contributors - When selected, Contributors can export input forms as Excel files, edit them, and reimport them back into ReportWORQ Contribution.
Hide cells outside a defined Print Area - When selected, exported forms include cells that are within the Print Area only. The Print Area was defined when the Contribution template was created.
Restrict editing to input cells only - When selected, Contributors can edit cells that are within the input range only. When not selected, Contributors can edit any cells, but all changes to cells outside of the input range are discarded.
Protection password (and lock/unlock visibility) - When set, the sheet(s) and workbooks open password-protected. Any user with access to the password can change the state on the Excel Review tab ribbon. The user will only be able to input data into the specified input ranges no other changes, such as adding columns or rows, can be made. The lock icon hides/shows the password.
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.
The Dashboard displays a list of generated input forms. In the following example, the Campaign is running and participants have engaged with it.
The Dashboard features the following information columns:
Name - The name of the input form.
Status - Can be one of the following:
Not Started - No data has been saved. The Contributor may have opened the input form to edit it, but has not submitted it and has not selected Close & Return to save their modified data.
In Progress - The Contributor has modified data and closed the input form, but has not submitted it. They can open the form again to edit and submit it.
Submitted - The Contributor has reviewed the input form, edited data as desired, and submitted the form.
Rejected - An Approver has reviewed and rejected the submitted input form. The Contributor must adjust their input and resubmit.
Approved - An Approver has reviewed and approved the submitted input form.
A lock icon beside the Status indicates that someone is currently reviewing or editing the input form.
Modified - Indicates how recently the Status of the input form changed, or how recently the form was Unlocked or Reset.
Contributor - The name of the person who is assigned to complete and submit the input form.
Approvers - The name(s) of the person(s) who can approve the completed input form after the Contributor submits it. This column is present only if the Campaign is set to require approvals. Only one approval is required for a given form, regardless of how many Approvers have been assigned to it.
Run, Pause, or Stop the Campaign
You can Run, Pause, or Stop the Campaign:
Run Campaign - Input forms become available for editing by Contributors and for review by Approvers. Running the Campaign does not trigger ReportWORQ to issue invitation notifications.
Pause Campaign - Input forms are not available to Contributors or Approvers.
Stop Campaign - Input forms are not available to Contributors or Approvers.
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.
Actions
The buttons in the Action column provide access to the following options:
Unlock Form - Releases the input form so it can be reopened.
Reset Form - Deletes all edited data and comments and changes the input form status to Not Started.
Download Form - Downloads a copy of the form. Downloaded forms are intended for review purposes only, not for data entry.
View Progress - Opens a view of the input form and the Details pane. You can review current and historical data, and comments made by the Contributor and Approver(s).
The Workflow tab displays an event record consisting of status changes and associated comments. Select a node on the workflow timeline to view the input form data as it was when the corresponding event occurred.
The Form Details tab displays a list of data changes, validation issues, and general comments from the Contributor and Approver(s). 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).
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:
- The data value is valid.
- Validation warning - The data value should be reviewed for accuracy, but it does not block form submission or approval.
- Validation error - The data value is not valid. It must satisfy validation requirements before the form can be submitted or approved.
The Form Details tab 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.
Update Forms
You can regenerate all input forms to ensure they are current.
Updating 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 becomes selectable. 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.
Notifications are as follows:
Approver Invitation - sends invitations to all Approvers in the Campaign.
Approver Reminder - sends reminders to all Approvers who have pending input forms that require approval.
Contributor Invitation - sends invitations to all Contributors in the Campaign.
Contributor Reminder - sends reminders to all Contributors who have pending input forms that require submission.
Custom Message - opens an editor where you can create a custom message and send it to your choice of recipient group(s).
You can also include input forms that are relevant to recipients, delivered as attached Excel files.
To insert a variable value, drag a variable pill to where you want to insert the variable, select the pill, and then select appropriate options. When the message is ready, select Send & Close.
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 form(s) 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 tasks are typically performed at the end of a Campaign:
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.
Stop the Campaign.
Export the data (Run Export).
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.
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.
Workflow for Contributors and Approvers
A ReportWORQ Contribution Campaign solicits and collects 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 the Contributor submits it.
Each input form is assigned to one Contributor and any number of 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.
For input forms that have an Edit Form button, you are the Contributor.
For input forms that have a Review Form button, you are an Approver.
To open an input form, select its name or its button (Edit Form or Review Form).
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.
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. When you are finished editing data and adding comments, you must 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, the Contributor must review it, make changes if needed, and resubmit.
The following figure shows input cells.
Symbols that may appear within input cells are as follows:
The green box indicates the active cell. If you select a change on the Form Details tab, the green box moves to the corresponding input cell.
A red triangle or a blue triangle in the top left corner of a cell indicates that there is a data validation issue. Hover over the triangle to view the validation message. Values in cells with red triangles must be corrected before the input form can be submitted. Values in cells with blue triangles should be reviewed for accuracy, but the validation issue does not block form submission.
A comment icon in the top right corner of a cell indicates there are comments added by the Contributor and/or Approver(s). Select the icon to view the commentary. Depending on your role and the Campaign settings, you may be able to type a comment in response. The figure below shows commentary for an input cell.
Tip: You can cut, copy, and paste values using standard Windows shortcuts (CTRL+X, CTRL+C, CTRL+V).
Details Pane
The Details pane provides information and tools to assist Contributors and Approvers. The following symbols appear along the top of the Details pane:
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. | |
Revert All Changes - If you are the Contributor, reverts all input cells to their original data values. If you are an Approver, reverts only the changes you made during the current session. Cell comments are not deleted. | |
Settings - You can hide or show system messages on the Workflow list. If system messages are shown, you can group/ungroup them. | |
Show/Hide Preview - 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 the Contributor and Approver(s). Comments from your current session are saved only if you select Submit, Approve, or Reject. They are not saved if you select Close & Return.
Below the event record are one or more action buttons. When you finish reviewing and/or editing the input form, select the appropriate button:
Submit - When the Contributor is finished editing, they Submit their changes. The input form then becomes available to Approvers.
If the Submit button is unavailable, one or more validation errors are blocking submission. The Contributor must fix the errors before they can submit the form.Recall Form - There are two scenarios in which this button may apply:
If the Contributor has submitted the input form but wants to make changes, they can recall the form, edit data and comments as needed, and then submit it again. The Contributor cannot recall an approved form.
If an Approver reviews an input form after it has been approved, they can recall the form.
The Approver can then edit the previous Approver’s general comment on the Workflow tab. Depending on Campaign settings, the Approver may also be able to modify data values and add cell-level comments.
Note: Any changes made by the previous Approver are considered to have been made by the current Approver.
After the Approver is finished making changes, they can Approve the form or Reject it. If they reject the form, the Contributor must edit and resubmit it for review and approval.
When you Recall a form, the form view closes and the list of input forms appears. To open the form, select Edit Form or Review Form.
Reject - An Approver can Reject the submitted input form, in which case the Contributor must edit and resubmit it for review and approval.
Approve - An Approver who has finished reviewing the submitted input form can Approve it.
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).
Form Details Tab
The Form Details tab displays a list of data changes, validation issues, and general comments from the Contributor and Approver(s). 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).
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:
- The data value is valid.
- Validation warning - The data value should be reviewed for accuracy, but it does not block form submission or approval.
- Validation error - The data value is not valid. It must satisfy validation requirements before the form can be submitted or approved.
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.
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.
To view, edit, and upload a form:
Select Download Form.
The form is saved to the Downloads folder on your computer, as an Excel .xlsx file.Open the form in Excel.
Edit data in the input range of each worksheet as required.
Save and close the file.
In the ReportWORQ web interface, open the form.
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.