Difference between revisions of "Auto Upload"

From BudgetLink Wiki
Jump to navigation Jump to search
 
(25 intermediate revisions by 2 users not shown)
Line 3: Line 3:
Auto Upload is a function that runs the [[Get Data]] process on a schedule. The main purpose of Auto Upload is to remove the manual running of the [[Get Data]] process and to move the processing to a non-productive time such as overnight.
Auto Upload is a function that runs the [[Get Data]] process on a schedule. The main purpose of Auto Upload is to remove the manual running of the [[Get Data]] process and to move the processing to a non-productive time such as overnight.


== How to test to ensure Auto Upload can run ==
== Prerequisits ==


[[File:AutoUploadFile.png|300px|thumb|right|The Auto Upload.xls file within the system folder of BudgetLink]]
Before setting up auto upload action the following steps first


BudgetLink requires the Auto Upload function to be switched on before this process will work. Once switched on, we recommend you test out that it is configured correctly and can run. You can do so by following these steps.
==== Enable Workspaces for Auto Upload ====
Make sure that each workspace you wish to run is enabled for Auto Upload


# Ensure that BudgetLink is closed;
To do this, go back to the Main Menu, click Workspace, then edit your workspace and make sure the Enable Auto Uplaod is ticked
# Locate the '''Auto Upload.xls''' file in the BudgetLink '''System''' folder and double click to open;
# BudgetLink will then open, start the Get Data process and then close when the Get Data process is complete.


<br clear=all>
==== Test the Auto Upload can be run manually ====
 
Test the Auto Upload manually to ensure it is running correctly. For more information, see [[Test the Auto Upload can be run manually]].


== How to set up Auto Upload ==
== How to set up Auto Upload ==
Line 26: Line 27:
# In the Daily form, enter the '''Start date and time''' that the first Auto Upload will occur and click '''Next''';
# In the Daily form, enter the '''Start date and time''' that the first Auto Upload will occur and click '''Next''';
# In the Action form, select '''Start a program''' and click '''Next''';
# In the Action form, select '''Start a program''' and click '''Next''';
# In the Start a Program form, click '''Browse…''' and select the Auto Upload.xls file in the BudgetLink System folder and click '''Open''';
# In the Start a Program form, click '''Browse…''' and select the '''AddonsLink.GetData.exe''' file in the System folder and click '''Open'''. The path will display in the Program/script field. Click '''Next''';
# The path of the Auto Upload.xls file will display in the Program/script field. Click '''Next''';
# In the Summary form, select '''Open the Properties dialog for this task when I click Finish''' and click '''Finish''';
# In the Summary form, select '''Open the Properties dialog for this task when I click Finish''' and click '''Finish''';
# In the General tab, select '''Run whether user is logged on or not'''. If you do not have Administrator rights then click '''Change User or Group…''' and change the user to be the Administrator. Click the '''Actions''' tab;
# In the General tab, select '''Run whether user is logged on or not'''. If you do not have Administrator rights then click '''Change User or Group…''' and change the user to be the Administrator. Click the '''Actions''' tab;
# In the Actions tab, click '''Edit'''. The Edit Action dialog box will appear.
# In the Actions tab, click '''Edit'''. The Edit Action dialog box will appear.
# In the Settings tab, tick the checkbox '''Stop the task if it runs longer than:''' and choose '''2 hours''' in the dropdown next to it;
# In the Settings tab, tick the checkbox '''If the running task does not end when requested, force it to stop''';
# In the Program/script field, ensure that the path is a UNC path and not a mapped drive. A UNC path begins with the server name. Click '''OK''' to close the Edit Action dialog box and click OK to close the Properties dialog box. Enter your password if required.
# In the Program/script field, ensure that the path is a UNC path and not a mapped drive. A UNC path begins with the server name. Click '''OK''' to close the Edit Action dialog box and click OK to close the Properties dialog box. Enter your password if required.
# To test the Auto Upload process, select '''Task Scheduler Library''' to the left of the Task Scheduler form. Select the Auto Upload task and click '''Run'''.
# To test the Auto Upload process, select '''Task Scheduler Library''' to the left of the Task Scheduler form. Select the Auto Upload task and click '''Run'''.


=== Notes ===
* When choosing a time to run the auto upload process, ensure your chosen time does not conflict with backups or other system processes.


== Notes ==
* When browsing to the '''AddonsLink.GetData.exe''' file, ensure that the path is a UNC path and not a mapped drive. A UNC path begins with the server name.


* When choosing a time to run the auto upload process, ensure your chosen time does not conflict with backups or other system processes.
* For older versions of BudgetLink, you will need to browse to the '''Excel.exe''' and include the UNC path to the '''Auto Upload.xls''' file located in the system folder.


* When browsing to the Auto Upload.xls file, ensure that the path is a UNC path and not a mapped drive. A UNC path begins with the server name.
== Test the Auto Upload Scheduled Task is configured correctly ==


Once the Auto Upload Scheduled tasks is configured, we recommend you test it. For more information, see [[Test the Auto Upload Scheduled Task is configured correctly]].


== Related Topics ==
== Troubleshooting the Auto Upload Scheduled Task ==


[[Get Data]]
If the Auto Upload scheduled task does not run or does not finish, see [[Troubleshooting Auto Upload Problems]].


== Questions ==
== Related Topics ==


What happens if the Task does not end?
* [[Get Data]]
Should Settings - Stop the task if it takes longer than 1 hour ?
* [[Troubleshooting Auto Upload Problems]]

Latest revision as of 23:29, 17 January 2020

Overview

Auto Upload is a function that runs the Get Data process on a schedule. The main purpose of Auto Upload is to remove the manual running of the Get Data process and to move the processing to a non-productive time such as overnight.

Prerequisits

Before setting up auto upload action the following steps first

Enable Workspaces for Auto Upload

Make sure that each workspace you wish to run is enabled for Auto Upload

To do this, go back to the Main Menu, click Workspace, then edit your workspace and make sure the Enable Auto Uplaod is ticked

Test the Auto Upload can be run manually

Test the Auto Upload manually to ensure it is running correctly. For more information, see Test the Auto Upload can be run manually.

How to set up Auto Upload

To setup Auto Upload, please follow these instructions. Note that these instructions are dependant on the version of windows you run and may vary slightly. It is also highly recommended that you get your IT personnel to setup the scheduled task.


  1. Click Start, then Control Panel, then Administrative Tools, then Task Scheduler;
  2. In the Task Scheduler form, select Create Basic Task;
  3. Enter a Name for the task (for example BudgetLink Get Data) and click Next;
  4. In the Task Trigger form, select the period for the Auto Upload to occur and click Next;
  5. In the Daily form, enter the Start date and time that the first Auto Upload will occur and click Next;
  6. In the Action form, select Start a program and click Next;
  7. In the Start a Program form, click Browse… and select the AddonsLink.GetData.exe file in the System folder and click Open. The path will display in the Program/script field. Click Next;
  8. In the Summary form, select Open the Properties dialog for this task when I click Finish and click Finish;
  9. In the General tab, select Run whether user is logged on or not. If you do not have Administrator rights then click Change User or Group… and change the user to be the Administrator. Click the Actions tab;
  10. In the Actions tab, click Edit. The Edit Action dialog box will appear.
  11. In the Settings tab, tick the checkbox Stop the task if it runs longer than: and choose 2 hours in the dropdown next to it;
  12. In the Settings tab, tick the checkbox If the running task does not end when requested, force it to stop;
  13. In the Program/script field, ensure that the path is a UNC path and not a mapped drive. A UNC path begins with the server name. Click OK to close the Edit Action dialog box and click OK to close the Properties dialog box. Enter your password if required.
  14. To test the Auto Upload process, select Task Scheduler Library to the left of the Task Scheduler form. Select the Auto Upload task and click Run.

Notes

  • When choosing a time to run the auto upload process, ensure your chosen time does not conflict with backups or other system processes.
  • When browsing to the AddonsLink.GetData.exe file, ensure that the path is a UNC path and not a mapped drive. A UNC path begins with the server name.
  • For older versions of BudgetLink, you will need to browse to the Excel.exe and include the UNC path to the Auto Upload.xls file located in the system folder.

Test the Auto Upload Scheduled Task is configured correctly

Once the Auto Upload Scheduled tasks is configured, we recommend you test it. For more information, see Test the Auto Upload Scheduled Task is configured correctly.

Troubleshooting the Auto Upload Scheduled Task

If the Auto Upload scheduled task does not run or does not finish, see Troubleshooting Auto Upload Problems.

Related Topics

Retrieved from "https://accountingaddons.com.au/wiki/budgetlink/index.php?title=Auto_Upload&oldid=4617"