How to Configure Schedule Task in xPortalNet Software

Problem (Issue) Statement:	How to Configure Schedule Task in xPortalNet Software
Description:	A guide to configure Schedule Task. This feature is applicable when user want to execute any Action Procedures created in xPortalNet software. Schedule Task is used to allow user to schedule a particular action procedures to be executed at a specified schedule. The schedule type can be configured to be upon service startup, recurring or one time only. User must configure the Action Procedures prior to configuring the Schedule Task.
Related Software:	xPortalNet IS v1.5.0.125 or higher
Related Hardware:	NIL
System Application:	Visitor Management System
Symptom and Finding:	NIL
Cause:	For first time guide to configure the Schedule Task in xPortalNet software.
Solution:	Warning! Users are not recommended to run any xPortal software in Windows XP* operating system as the system is unstable* Users are also advised to stop the xPortal Services before shutting down the Server PC* to prevent any missing transaction issues.* . . Summary To Configure Schedule Type: Once at services startup. To Configure Schedule Type: Recurring. To Configure Schedule Type: One time. To View the Schedule Task Log Files. Step-by-step Guide: To Configure Schedule Type: Once at services startup. Select this schedule type when user want to execute* the Action Procedures only once during the xPortalNet Service startup.* Step 1: In the Edit Schedule window, please select Schedule Type: Once at services startup. ^{Figure 1: Edit Schedule Window.} Step 2: Click OK to save the changes. Step 3: Observe the Latest Event List. Explanation: Once the xPortalNet Service is started, the Schedule Task will be started and the Action Procedures are executed once. ^{Figure 2: Latest Event List.} ^. ^. To Configure Schedule Type: Recurring. The Recurring type has several options that user can choose according to their preferences. Here are a few scenarios as reference. Step 1: In the Edit Schedule window, please select Schedule Type: Recurring Step 2: Configure the Frequency, Daily Frequency and Duration as shown below: Step 3: Click OK to save the configuration then observe software transaction from the Latest Event List. Recurring Scenario 1 Frequency → Occurs: Daily , Recurs every: 1 day Daily frequency → Occurs once at: 17:40 Duration → Start Date: 2016/10/01 , End Date: 2016/11/30 ^{Figure 3: Edit Schedule Recurring Scenario 1.} Explanation: The Schedule Task will run and execute the Action Procedures at the same time on a daily basis: 17:40 everyday from 2016/10/01 until 2016/11/30. ^{Figure 4: Latest Event List.} . . Recurring Scenario 2 Frequency → Occurs: Daily , Recurs every: 1 day Daily frequency → Occurs every: 1 hour , Starting At: 00:00 Ending At: 23:59 Duration → Start Date: 2016/10/01 , End Date: 2016/11/30 ^{Figure 5: Edit Schedule Recurring Scenario 2.} Explanation: The Schedule Task will run and execute the Action Procedures on a daily basis every hourly starting from 00:00 until 23:59 everyday from 2016/10/01 until 2016/11/30. ^{Figure 6: Latest Event List.} . . Recurring Scenario 3 Frequency → Occurs: Daily , Recurs every: Every weekday Daily frequency → Occurs once at: 10:20 Duration → Start Date: 2016/10/01 , End Date: 2016/11/30 ^{Figure 7: Edit Schedule Recurring Scenario 3.} Explanation: The Schedule Task will run and execute the Action Procedures every weekday at 10:20 from 2016/10/01 until 2016/11/30. ^{Figure 8: Latest Event List.} . . Recurring Scenario 4 Frequency → Occurs: Daily , Recurs every: Every weekday Daily frequency → Occurs once at: 10:20 Duration → Start Date: 2016/10/01 , End Date: No end date ^{Figure 9: Edit Schedule Recurring Scenario 4.} Explanation: The Schedule Task will run and execute the Action Procedures endlessly every weekday at 10:20 from 2016/10/01 onwards. ^{Figure 10: Latest Event List.} . . To Configure Schedule Type: One time. This type of schedule is used when user only want to execute* the Action Procedures once on a specific day and at a specific time.* Step 1: In the Edit Schedule window, please select Schedule Type: One time. Fill in the information under the One-time occurence section for the one time occurence time and date. ^{Figure 11: Edit Schedule Window.} Step 2: Click OK to save the changes. Step 3: Observe the Latest Event List. Explanation: The Schedule Task will run and execute the Action Procedures once on 13/7/2018 at 18:00 only. ^{Figure 12: Latest Event List.} ^. ^. To View the Schedule Task Log Files: The log file of this action can be found at the following folder location:- `C:\ProgramData\MicroEngine\xPortalNet v1\Server\ScheduledTaskLogs`. ^{Figure 13: Schedule Task Log Files.}
Document Date	12/07/2018 (Rev 1.0)