Use SearchService administrative commands to schedule social
analytics tasks in the Home page database. A nightly task is scheduled
to run after the optimize task by default. Every time the social analytics
scheduled task runs, the index for the social analytics service is
recreated.
Before you begin
To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.
About this task
When defining a social analytics scheduled task
in the Home page database, you need to specify when the scheduler
starts the task. The schedule is defined using a Cron schedule. For
more information about the scheduler, see Scheduling tasks.
It
is not possible to specify an end time for a scheduled task. All tasks
run as long as they need to. The startby interval defines the time
period by which a task can fire before it is automatically canceled.
This mechanism ensures that tasks do not queue up for an overly long
period before being canceled, and allows for tasks than run for longer
than the default indexing schedule, such as initial index creation.
Procedure
To define a social analytics scheduled task, complete
the following steps.
- Start the wsadmin client from the following
directory of the system on which you installed the Deployment Manager:
app_server_root\profiles\dm_profile_root\bin
where app_server_root is
the WebSphere® Application
Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.You
must start the client from this directory or subsequent commands that
you enter do not execute correctly.
- After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter:
execfile("searchAdmin.py")
If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If
the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.When
the command is run successfully, the following message displays:
Search Administration initialized
- Use the following command:
- SearchService.addSandTask(String taskName, String schedule, String
startBy, String jobs)
Creates a new scheduled task definition for the social analytics
service in the Home page database.
This command takes the following
arguments:
- taskName. The name of the scheduled task. This argument is a string
value, which must be unique.
- schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.
- startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format.
This parameter should be used to ensure that scheduled
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.
- jobs. The name, or names, of the jobs to be run when the task
is triggered. This argument is a string value. To index multiple jobs,
use a comma-delimited list. The following values are valid: evidence,
graph, manageremployees, tags, taggedby, and communitymembership.
All the arguments are required.
For example:
SearchService.addSandTask("customSaNDIndexTask",
"0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI",
"evidence,graph,manageremployees,tags,taggedby,communitymembership")
When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.
You can also use the SearchService.addSandTask
command to replace the nightly-sand-task that is automatically configured
when you install IBM® Connections.
By default, the task runs nightly at 01:00. To replace the default
SAND task settings, first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addSandTask command
to create a new SAND task with the values that you specify.
For example:
SearchService.deleteTask("nightly-sand-task")
SearchService.addSandTask("nightly-sand-task",
"0 0 1 * * ?", "0 5 1 * * ?",
"evidence,graph,manageremployees,tags,taggedby,communitymembership")
- To refresh the Home page database
to include the newly-added tasks, use the following command:
SearchService.refreshTasks()