Installation How-To: Configure Automated Incremental update for Windows

How To Configuring Automated Indexing 

Most installations will require the system automatically refresh the index on a periodic basis. This how-to will discuss configuring an automated refresh on Windows Server 2008R2, however the instructions will be applicable for other versions of windows. 


It is assumed that the system has been properly set up and validated

  • A full initial index has been created.
  • Experienced knowledge of Windows, and Event Scheduler
  • Knowledge of how often the Agile data changes significantly enough to require a refresh.

Things to Consider

The creation of a index can take place while the application is running on the current index

Choose a time to update the index when it will be least disruptive to users. User will be LOGGED OUT when the new data is made available.

Impact on the Agile server - during extract additional load will be put on Agile take this into consideration. The load is generally very small - however large change sets may have an impact.

What the Process Does

The following process will execute a single script on a given schedule that executes in sequence the following:

1) Incrementally extract and produce a new up to data AX index based on the changes in agile.

2)  Stop the Application Server

3) Restart the application server with the new index.

Step 1: Open Task Scheduler

Click "Start -> Administrator Tools -> Task Scheduler"


Step 2: Select Create Task

Right click on Task Scheduler library or select from Actions (second option on menu on right part of screen)


Step 3: Fill in Task details in General tab

Filled in Name and Description. Checked the following options: “Run whether user is logged on or not”, “run with highest privileges”


Step 4: Fill out Triggers Tab

Filled out when the task should run.


Step 5: Fill out Actions Tab (Stop the Application)

Action is “Start a program”. Selected/input: stopAgileXPLORER.bat for program/script. Also updated Start in to indicate the directory the script resides in. You can combine these, but best practice to separate them. Click OK. 


Step 6: Add a Second Option to Start the Application

Repeat previous step by selecting “New” under the Action tab. The action is “Start a program”. Selected/input: startAgileXPLORER.bat for program/script. Also updated Start in to indicate the directory the script resides in. You can combine these, but best practice to separate them.


Step 7: Confirm both Scripts appear in the Task

When you are brought back to the main task menu confirm stop and start are in the correct order.


Step 8: Save

Click "OK" and you will be prompted for a password of the user the script will run as.

Configure the Re-indexing Stage

Use the above steps as a template to create a an additional scheduled task to produce a new incremental index. 

  • Name the Task: "Incremental Load"
  • Configure the Trigger to run approximately 1 hour prior to the Start-Stop task, you can schedule closer as you determine how long the process takes
  • Set the trigger action to be the follows {Installation Directory}\etl\run-ETL-Incremental.bat  tel-config-incremental.xml
  • Make sure the trigger actions working directory is set to the  {Installation Directory}\etl

Step 1: Open Task Scheduler:

Same instructions as previous work flow step 1.

Step 2: Select Create Task:

Same instructions as previous work flow step 2. 

Step 3: General Tab: 

Enable "Run whether user is logged on or not"

Enable " Run with highest privileges"

Step 4: Trigger Tab:

Select "Daily" and choose a time at which the process should run

Under advanced make sure the task is "enabled"

Step 5: Action Tab:

Set the Action to "Start a Program"

Browse to "{Install Directory}etl\runETL-incremental.bat

Add Arguments: etl-config-incremental.xml

set the start in directory: to {Install Directory}\etl\

Step 6: Save

Click OK and commit the changes.

Further steps

Weekly full re-index - This may be a good thing to do as a matter of practice. The exact same steps can be used to create a weekly task.  The only difference is to edit the "indexcommand" to use the full indexer vs the incremental change the following: For Windows the action for the new weekly task would be set to :

{Installation Directory}\etl\run-ETL.bat  etl-config.xml




Have more questions? Submit a request


Article is closed for comments.
Powered by Zendesk