Latest Documentation
RecordPoint 4.0 Documentation
Records365 Documentation


Documentation for older versions
RecordPoint 3.9 Documentation
RecordPoint 3.8 Documentation


Articles in this version

Page tree
Skip to end of metadata
Go to start of metadata
 Article Contents

Introduction

To assist the system administrator with the bulk configuration of the RecordPoint Active Queue Timer Jobs, we provide a set of PowerShell scripts that enable the export and import of the timer job configuration.
The relevant scripts are:

  • RecordPoint-Export-ActiveQueueTimerJobs.ps1
  • RecordPoint-Import-ActiveQueueTimerJobs.ps1

These scripts allow the system administrator to apply tiering of the processing schedules for large numbers of queues by providing for bulk export and import of the timer job configuration via CSV file.
Both scripts are included as part of the distribution of the product and be found within the Scripts directory.

Running the scripts

Export Active Queue Timer Jobs

  1. Use RecordPoint-Export-ActiveQueueTimerJobs.ps1 to extract the current scheduling information for the active site queues:
  2. From a windows command prompt running under Administrator, run the following command from the directory containing the Powershell script:
    ./RecordPoint-Export-ActiveQueueTimerJobs.ps1 <outputfile.csv>
    Where <outputfile.csv> is the location of the file in which you would like to save the output of the script.
  3. Open the output file in a text editor or with Excel. You will see one row for each timer job with the following columns:
    • WebApplication,JobName,JobId,ScheduleType,Interval,BeginDayOfWeek,EndDayOfWeek,BeginDay,EndDay,BeginMonth,EndMonth,BeginHour,BeginMinute,BeginSecond,EndHour,EndMinute,EndSecond
    • The first three columns identify the job and the SharePoint active site and should not be altered.
    • The remaining columns specify the schedule to which the job will run and may be modified in accordance with the following schedule types.
    • Any data provided that is not relevant to the selected schedule type will be ignored.

Schedule Type

Minutes

This schedule will repeatedly run the job with a gap of a set number of minutes.
• Interval: the number of minutes between each scheduled run of the job.
• BeginSecond: the second during each scheduled minute after which the schedule must start.
• EndSecond: the second during each scheduled minute after which the schedule must have started.

Hourly

This schedule will run the job every hour.
• BeginMinute: the minute during each hour after which the schedule must start.
• EndMinute: the minute during each hour after which the schedule must start.

Daily

This schedule will run the job once per day at the given time. Note: system local time.
• BeginHour: The hour (in 24 hour notation) at which the job will begin.
• BeginMinute: The minute of the selected hour at which the job will begin.
• BeginSecond: the seconds of the selected hour at which the job will begin.

Weekly

This schedule will run every week on the days specified in between the start and end times.
• BeginDayOfWeek: The first day of the week on which the jobs will run. You must provide at least the first three characters of the name of the day.
• EndDayOfWeek: The last day of the week on which the jobs will run. You must provide at least the first three characters of the name of the day.
• BeginHour: The hour (in 24 hour notation) after which time the job will begin.
• BeginMinute: The minute of the selected hour after which time the job will begin.
• BeginSecond: the seconds of the selected hour after which time the job will begin.
• EndHour: The hour (in 24 hour notation) by which time the job will have begun.
• EndMinute: The minute of he selected hour by which time the job will have begun.
• EndSecond: the seconds of the selected hour by which time the job will have begun.

Monthly

This schedule will run every month on the day specified between the given times.
• BeginDay: The day of the month on which the job will run. You can provided any value between 0 and 31 but RecordPoint recommends that you do not choose a value higher than 28.
• BeginHour: The hour (in 24 hour notation) after which time the job will begin.
• BeginMinute: The minute of the selected hour after which time the job will begin.
• BeginSecond: the seconds of the selected hour after which time the job will begin.

Import Active Queue Timer Jobs

  1. Use RecordPoint-Import-ActiveQueueTimerJobs.ps1 to set the desired scheduling information for the active site queues:
  2. From a windows command prompt running under Administrator, run the following command from the directory containing the Powershell script:
    ./RecordPoint-Import-ActiveQueueTimerJobs.ps1 <inputfile.csv>
    Where <inputfile.csv> is the location of the file in which you would have saved the scheduling information set in step 2/.
  • No labels