Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

This page covers:

Overview: Set Targets and Add Results offline using an Excel template

Users can report Targets and Results data offline using Amp Impact by downloading the data to an Excel file and then uploading the Excel file(s) to a project once connectivity is restored. To use this functionality, the user must first download the templates from the Set Targets and/or Add Results component(s), input the data into the downloaded template(s), and then upload the template(s) back to the Set Targets / Add Results component(s). The uploaded data will then reflect in the Set Targets / Add Results components in the Project record.

Users cannot download or upload Targets data to or from an Excel file using the Set Targets Lightning Web Component. Instead, use the SetTargets Visualforce Page to allow users to report Targets data offline.

Download Results data to an Excel template LIGHTNING WEB COMPONENT

  1. To download the Results template for a specific Reporting Period and Geographic Area, the user needs to click the “Download Results” button.

The downloaded Results template will contain only the project indicators that are currently displaying in the Add Results table. If the table is filtered (or search is active), then only the filtered project indicators that are displayed on the table will be downloaded. 

The downloaded Results template will have empty Result cells if Results have not been added for the downloaded project indicators. If the Results have been added, those result values will be displayed in the downloaded template.

2. A popup window appears after clicking the Download Results button. It will ask the user to confirm generating the Excel sheet for the particular Reporting Period and Geographic Area selected. In this popup, the user can either click “Generate” or “Cancel.”

If there is no Project Indicator linked to a Geographic Area and Reporting Period, then clicking on “Generate” will prompt an error message.

Admin Note: The header, body text, and button label in the “Generate Excel” popup are controlled by custom labels and can be customized as per an organization's needs. The body text is controlled by Generate_Results_Excel_Text, button label ‘Generate’ is controlled by Generate_Excel_Button, and the header is controlled by Generate_Excel_Header.

3. If there is at least one Project Indicator linked to a Geographic Area and Reporting Period, then selecting “Generate” will generate the Results template, and the user will get an option to “View” and “Download” the generated Results template. On this popup,

  • Selecting View will help users to view the template. It opens a new tab where users can preview the file before downloading it.

  • Selecting Download will prompt the download of the Excel file onto the user’s device.

4. The generated Results Excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. 

  • ContentVersion record’s Created Date is the time stamp of download. 

  • ContentVersion record’s Owner field displays the name of the user who downloaded the file. 

  • If a user downloads an Excel file multiple times for the same Geographic Area and Reporting Period, these ContentVersion files are updated to reflect the last download date, and the owner of the ContentVersion record is updated to the user who last downloaded the Results. 

  • The user may access all of the versions that have been downloaded by selecting “View previous versions.”

  • The updated ContentVerion file is posted on Chatter of the related Reporting Period record. 

Using the Download_Targets_Header custom label, the user may edit the header in this popup. 

5. The downloaded Results template will have two tabs:

  • The first tab will be labeled as “Instructions” - this tab will outline how to enter data in a compatible format to successfully upload the document onto the AddResults page.

  • The second tab will reflect the Reporting Period and Geographic Area for which the Results template is downloaded. The tab label is formatted as follows: ‘[Reporting Period label] - [Geographic Area name]’. Below the header on the second tab, users can find the date and time of the download and the name of the user who downloaded the file. 

6. The Result values can be added to the second tab of the downloaded Result template spreadsheet.

The user can edit the following in the downloaded template:

  • The number of tabs

  • The values in the input cells which are indicated by the blue background

  • The text in the comments column per Project Indicator where Data_Type__c = Input (Comments may not be uploaded for Aggregated/Calculated Project Indicators on AddResults)

The following portions of the Excel sheet should NOT be edited in order to successfully upload the entered Result values in the Result template

  • The header text on the tab with the downloaded data

  • The names of the column headers in the downloaded tab

  • The name of the downloaded tab

  • The existence of one tab with the Reporting Period and Geographic Area as the label

The Results template has the following limitations as of the latest release: 

  • Currency codes are NOT seen for Currency Project Indicator Results

  • Percentage sign is NOT seen for percentage Project Indicator Results

  • HTML markdown characters are expected to be seen which includes formatting specific characters. (eg HTML markdown for new line, bold text etc.)

  • Images are not expected to be printed in excel

  • URLs are not expected to be hyperlinked in the excel cell

Admin Note: Instructions in the downloaded template reflect any customizations made to the Instructions by the System Administrator using Custom Labels and Translation Workbench. The downloaded Results template spreadsheet's locale representation is determined by the settings of the Spreadsheet/Excel application installed on the user's system.

Upload Results from an Excel template LIGHTNING WEB COMPONENT

After entering the results into the downloaded Results template, the user can now upload that template to the project.

  1. Navigate to the Add Results page on the Project record and click the Upload Results button (as highlighted in the screenshot)

2. In the Upload Results popup, click on Attach File and select the Results template saved on the user’s device. Alternatively, the user can drop the Result template in the drop zone (indicated by the dotted box) inside the popup.

3. a. If the selected file is validated, a green checkmark will be displayed next to the attached file.

b. If the selected file is not validated, a red cross will be displayed next to the attached file, and a list of error messages will be displayed below the attached file.

c. Please correct the errors in the Results template and then repeat steps 1-3.

4. After validation of the template, click on the Upload button to upload the reported Results to the Project.

5. Once the user clicks Upload, the system will upload the Results and display the status of the Results. The details include:

a. Number of successfully uploaded Result records

b. Number of Result records not uploaded

6. The user can choose to download the Success log by clicking on the View Successes button.

a. The success log Excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. With each generation of the success log, these ContentVersion files are updated to reflect the last upload date, and the owner of the content version record is updated to the user who last uploaded the results. ContentVersion records also allow users to access previous versions that have been uploaded by selecting ‘View previous versions’.

b. The updated ContentVerion file is posted on Chatter of the related Reporting Period record.

7. If some Results have not been uploaded sucessfully, please click on View Errors to download the Error log to the user’s device.

a. The error log Excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. With each generation of the error log, these ContentVersion files are updated to reflect the last upload date, and the owner of the content version record is updated to the user who last uploaded the results. ContentVersion records also allow users to access previous versions.

b. The updated ContentVerion file is posted on Chatter of the related Reporting Period record.

c. Refer to the errors listed in the Error log to correct them (see screenshot below).

d. Once all errors have been rectified, repeat steps 1–3 to upload the corrected Results to the Project.

8. Once the Results have been uploaded successfully, click on the Close button.

9. The Add Results page will automatically refresh and display the uploaded Results.

The ability for users to access the download Excel button can be controlled through the Results custom setting (please refer to Installation guide for access and setup details).

Download Targets data to an Excel template VISUALFORCE PAGE

Admin Note: The ability for users to access the download Excel button can be controlled through the Set Targets custom setting (please refer to Installation guide for access and set-up details).

  1. To download Targets for Project Indicators for a specific Reporting Period and Geographic Area, the user clicks the Download button.

Users can decide which Targets are downloaded by applying Filters (using the Filter button and/or the Search text bar). On open, the Rxcel file will contain only Targets that match the filters applied at the time of download.

2. A popup window appears after clicking the Download button. The “Generate” popup will ask the user to confirm generating the Excel sheet for the particular Reporting Period and Geographic Area selected. In this popup, the user can either click Generate or Cancel.

a. Selecting Cancel will exit from the ‘Generate’ popup. The page will remain on the SetTargets page.

b. Selecting Generate will prompt a ‘Confirm’ popup.

If there is no Project Indicator linked to a Geographic Area and Reporting Period, then selecting Generate will prompt an error message. 

Admin Note: Using custom labels, the user may edit/customize the following in the ‘Generate’ popup:  Generate_Excel_Text,Generate_Excel_Button, Generate_Excel_Header.

3. The ‘Confirm’ popup will ask the user to confirm the download of the Excel sheet for the particular Reporting Period and Geographic Area selected. In this popup, users can either click Confirm or Cancel.

a. Selecting Cancel will close the popup, and the user will remain on the SetTargets page.

b. Selecting Confirm will prompt the download of the Excel file onto the SetTargets page. 

Admin Note:  Using custom labels, the user may edit the following in the Confirm popup: Download_Targets_Header.

4. Once Confirm has been selected, the file will download. On opening the file, two tabs will be displayed: 

a. The first tab will be labeled “Instructions.” This tab will outline how to enter data in a compatible format to upload the document to the SetTargets page

b. The second tab will change dynamically to reflect the Reporting Period and Geographic Area, and will be formatted as follows: ‘[Reporting Period label] - [Geographic Area name]’. Below the header, the date and time of download and the name of the user who downloaded the file will be displayed.

The downloaded Targets Excel file will be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user downloads an Excel file multiple times for the same Geographic Area and Reporting Period, these ContentVersion files are updated to reflect the last download date, and the owner of the ContentVersion record is updated to the user who last downloaded the Targets. The user may access all of the versions that have been downloaded by selecting ‘View previous versions’.

Upload Targets from an Excel template VISUALFORCE PAGE

Admin Note: The ability for users to access the download Excel button can be controlled through the Set Targets custom setting (please refer to Installation guide for access and setup details).

  1. Once the Targets have been downloaded for a given Reporting Period and Geographic Area, the user can open the downloaded Excel to view and add Targets to upload. See the section above on downloading Targets to an Excel template for details.  

  2. To upload the Targets, data may be added to the second tab of the Excel spreadsheet.

The user can edit the following in the downloaded template:

  • The number of tabs

  • The values in the input cells which are indicated by the blue background

  • The text in the comments column per Project Indicator where Data_Type__c = Input (Comments may not be uploaded for Aggregated/Calculated Project Indicators on AddResults)

The following portions of the Excel sheet should NOT be edited in order to successfully upload the entered Target values in the template:

  • The header text on the tab with the downloaded data

  • The names of the column headers in the downloaded tab

  • The name of the downloaded tab

  • The existence of one tab with the Reporting Period and Geographic Area as the label

3. Once data has been entered into the Excel template, the user must navigate to the SetTargets page and click the Upload button in the top right corner of the screen.

3. Selecting the Upload button will prompt a ‘Step 1’ popup to allow the user to attach the file to be uploaded for that particular Geographic Area and Reporting Period

  • The user may click Cancel at any time and return to the SetTargets page, with no records updated.

  • When attaching a file, ensure the file type is .xlsx. Clicking Attach will prompt the next popup.

If the uploaded document is not in .xlsx format, the user will receive an error message when trying to attach and must re-upload the document in .xlsx format.

4. The ‘Step 2’ popup confirms the Reporting Period, Geographic Area, and Project name of the Targets data. Click Upload to continue with the Targets upload.

  • The user may click Cancel at any time and return to the SetTargets page with no records updated.

5. Once the upload is complete, the 'Step 3: Confirm Upload’ popup will appear. The popup will ask the user to confirm that the records uploaded should update the Targets for the chosen Reporting Period and Geographic Area 

  • Selecting No will cancel out of the popup with no records updated

  • Selecting Yes will confirm the upload, and the records will update

  • Upon selecting “Yes” in Step 3, the user will receive a popup that reads ‘Step 4: Operation Complete.' This popup includes the number of successfully updated records and the number of errors that occurred. On this popup, the user can select from three options:

    • View Successes shows the user the successful uploads. Clicking on the View Successes button will download an Excel file with all of the indicators that were successfully uploaded. This file will download on the SetTargets page, and a record on ContentVersion will also be created.

      • If there were no successes, the View Successes button will not display in the ‘Step 4’ popup.

      • The uploaded success log Excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user uploads an Excel file multiple times for the same Geographic Area and Reporting Period, these ContentVersion files are updated to reflect the last upload date, and the owner of the ContentVersion record is updated to the user who last uploaded the Targets. The user may access all of the versions that have been uploaded by selecting ‘View previous versions’.

      • The rows in the downloaded success log will be ordered by alphabetically ascending Indicator definitions.

    • View Errors shows the user an error log of records that were not successfully uploaded and the associated errors. Clicking on the View Errors button will download an Excel file with all of the indicators that were unable to be uploaded with a column explaining what the error was. This file will download on the SetTargets pages and a record on ContentVersion will also be created.

      • If no errors occurred, then the View Errors button will not display in the ‘Step 4’ popup.

      • The uploaded error log excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user uploads an excel file multiple times for the same Geographic Area and Reporting Period, and if some errors are generated on upload, these ContentVersion files are updated to reflect the last upload date, and the owner of the ContentVersion record is updated to the user who last uploaded the Targets. The user may access all of the versions that have been uploaded by selecting ‘View previous versions’.

      • The rows in the downloaded error log will be ordered by alphabetically ascending Indicator definitions.

    • Close closes the popup once the success/error logs have been downloaded. This will automatically refresh the SetTargets page and display the newly updated records.

The uploaded Targets Excel file will be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user uploads an excel file multiple times for the same Geographic Area and Reporting Period, these ContentVersion files are updated to reflect the last upload date, and the owner of the ContentVersion record is updated to the user who last uploaded the Targets. The user may access all of the versions that have been uploaded by selecting ‘View previous versions’.

Download Results data to an Excel template VISUALFORCE PAGE

Admin Note: The ability for users to access the download Excel button can be controlled through the Results custom setting (please refer to Installation guide for access and setup details).

  1. To download the Results template for a specific Reporting Period and Geographic Area, the user needs to click the Download Results button. 

The downloaded Results template will contain only the Project Indicators that are currently displaying in the Add Results table. If the table is filtered (or search is active), then only the filtered Project Indicators that are displayed on the table will be downloaded. 

The downloaded Results template will have empty Result cells if no results are added for the downloaded Project Indicators. If the Results have been added, those result values will be displayed in the downloaded template. 

Admin Note: The visibility of the Download Results button on the addResults component can be controlled through the design attribute “Hide Results Download Button.” The organization can choose to hide this button by setting this Design Atribute to TRUE. 

2. On the click of the “Download Results” button, a popup opens. The ‘Generate’ popup will ask the user to confirm generating the Excel sheet for the particular Reporting Period and Geographic Area selected. In this popup, the user can either click Generate or Cancel.

a. Selecting Cancel will exit from the ‘Generate’ popup. The page will remain on the AddResults page.

b. Selecting Generate will prompt a ‘Confirm’ popup.

If there is no Project Indicator linked to a Geographic Area and Reporting Period, then selecting Generate will prompt an error message. 

Using custom labels, the user may edit/ customize the following in the ‘Generate’ popup: Generate_Excel_Text, Generate_Excel_Button, Generate_Excel_Header.

3. If there is at least one project indicator linked to a Geographic Area and Reporting Period, then selecting Generate will prompt a ‘Confirm’ popup. The ‘Confirm’ popup will ask the user to confirm the download of the Excel sheet for the particular Reporting Period and Geographic Area selected. In this popup, users can either click Confirm or Cancel.

Using custom labels, the user may edit the following in the ‘Confirm’ popup: Download_Targets_Header.

a. Selecting Cancel will close the popup, and the user will remain on the AddResults page.

b. Selecting Confirm will prompt the download of the Excel file to the user’s device.

4. Once Confirm has been selected, the file will download. Upon opening the file, two tabs will be shown:

a. The first tab will be labeled as “Instructions’ - this tab will outline how to enter data in a compatible format to upload the document onto the AddResults page

b. The second tab will change dynamically to reflect the Reporting Period and Geographic Area, and will be formatted as follows: ‘[Reporting Period label] - [Geographic Area name]’. Below the header, the date and time of download and the name of the user who downloaded the file are also displayed.

The downloaded Results Excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user downloads an Excel file multiple times for the same Geographic Area and Reporting Period, these ContentVersion files are updated to reflect the last download date, and the owner of the ContentVersion record is updated to the user who last downloaded the results. The user may access all of the versions that have been downloaded by selecting ‘View previous versions’.

Upload Results data from an Excel template VISUALFORCE PAGE

Admin Note: The ability for users to access the download excel button can be controlled through the Results custom setting (please refer to Installation guide for access and set-up details).

  1. Once the Results have been downloaded for a given Reporting Period and Geographic Area, the user can open the downloaded Excel to view and add Results to upload. (Please see the section above on downloading Results as an Excel template).

  2. To upload the Results, data may be added to the second tab of the Excel spreadsheet:

The following may be edited:

  1. The number of tabs

  2. The values in the input cells which are indicated by the blue background

  3. The text in the comments column per Project Indicator where Data_Type__c = Input (Comments may not be uploaded for Aggregated/Calculated Project Indicators on AddResults)

The following portions of the Excel sheet may NOT be edited in order to comply with the compatibility of Results Upload.

  1. The header text on the tab with the downloaded data

  2. The names of the column headers in the downloaded tab

  3. The name of the downloaded tab

  4. The existence of one tab with the Reporting Period and Geographic Area as the label

3. Once data has been entered into the excel sheet, the user must navigate to the AddResults page and click the Upload button in the top right corner of the screen

4. Selecting the Upload button will prompt a ‘Step 1’ popup to allow the user to attach the file to be uploaded for that particular Geographic Area and Reporting Period.

  • The user may click on “Cancel” at any time and return to the AddResults page, with no records updated.

  • When choosing a file, ensure that the file type is .xlsx. Clicking Attach will prompt the next popup.

If the uploaded document is not in .xlsx format, the user will receive an error message when trying to attach and must re-upload the document in .xlsx format.

5. Once the ‘Step 2' popup appears, click on the Upload button. The popup will confirm the Reporting Period, Geographic Area, and Project name. 

6. Once the upload is complete, a ‘Step 3: Confirm Upload’ popup will appear. The popup will ask the user to confirm that the records uploaded should update the Results for the chosen Reporting Period and Geographic Area 

  • Selecting No will cancel out the popup with no records updated.

  • Selecting Yes will confirm the upload, and the records will update.

7. Once the user has selected Yes, there will be a popup that reads ‘Step 4: Operation Complete,’ with the number of successfully updated records and the number of errors that occurred. On this popup, the user can select from three options:

  • View Successes shows the user the successful uploads. Clicking on the View Successes button will download an Excel file with all of the indicators that were successfully uploaded. This file will download on the AddResults page, and a record on ContentVersion will also be created.

    • If there were no successes, the View Successes button will not display in the ‘Step 4’ popup.

    • The uploaded success log Excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user uploads an Excel file multiple times for the same Geographic Area and Reporting Period, these ContentVersion files are updated to reflect the last upload date, and the owner of the ContentVersion record is updated to the user who last uploaded the Results. The user may access all of the versions that have been uploaded by selecting ‘View previous versions’.

    • The rows in the downloaded success log will be ordered by alphabetically ascending Indicator definitions.

  • View Errors shows the user an error log of records that were not successfully uploaded and the associated errors. Clicking on the View Errors button will download an Excel file with all of the indicators that were unable to be uploaded, with a column explaining what the error was. This file will download on the SetTargets pages, and a record on ContentVersion will also be created.

    • If no errors occurred, then the View Errors button will not display in the ‘Step 4’ popup.

    • The uploaded error log excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. If a user uploads an excel file multiple times for the same Geographic Area and Reporting Period, and if some errors are generated on upload, these ContentVersion files are updated to reflect the last upload date, and the owner of the ContentVersion record is updated to the user who last uploaded the Targets. The user may access all of the versions that have been uploaded by selecting ‘View previous versions’.

    • The rows in the downloaded error log will be ordered by alphabetically ascending Indicator definitions.

  • Close closes the popup once the success/error logs have been downloaded. This will automatically refresh the SetTargets page and display the newly updated records.

The uploaded Results excel file will all be stored as ContentVersion files under the Files related list on the relevant Reporting Period. With each upload of Results these ContentVersion files are updated to reflect the last upload date, and the owner of the content version record is updated to the user who last  uploaded the results. ContentVersion records also allow users to access previous versions.

  • No labels