News administrative commands 

Use the commands listed to perform administrative tasks for the News repository. No file checkout or server restart is needed when using these commands.

The following sections define the commands that you can use when working with the News repository. Each section describes the commands for a specific service. The commands are listed in alphabetical order.

• NewsCellConfig

• NewsEmailDigestService

• NewsMemberService

• NewsScheduler

NewsCellConfig commands

NewsCellConfig.checkOutConfig("<working_directory>", "<cell_name>")

Checks out the News repository configuration files.

This command takes the following parameters:

<working_directory>

Temporary working directory to which the configuration files are copied. The files are kept in this working directory while you make changes to them.

<cell_name>

Name of the IBM WAS cell hosting the IBM Connections application. To obtain the cell name:

print AdminControl.getCell()




For example:


• AIX/Linux:

  NewsCellConfig.checkOutConfig("/opt/my_temp_dir", "NewsServerNode01Cell")

  
  

• Microsoft Windows™:

  NewsCellConfig.checkOutConfig("c:/temp","foo01Cell01")

  
  

NewsCellConfig.checkInConfig()

Checks in the News repository configuration files. Run from the wsadmin command processor.

NewsEmailDigestService commands

NewsEmailDigestService.loadBalanceEmailDigest()

Reallocates and load balances the users in the email address groups used by the email digest according to mail domain. This command does not take any parameters.

The command returns the number of users who have been reallocated to different email address groups for load balancing purposes.

For example:

wsadmin> NewsEmailDigestService.loadBalanceEmailDigest()
1603

NewsMemberService commands

NewsMemberService.getMemberExtIdByEmail("email")

See Synchronize user data using administrative commands for details.

NewsMemberService.getMemberExtIdByLogin("login")

See Synchronize user data using administrative commands for details.

NewsMemberService.inactivateMemberByEmail("email")

See Synchronize user data using administrative commands for details.

NewsMemberService.inactivateMemberByExtId("externalID")

See Synchronize user data using administrative commands for details.

NewsMemberService.syncAllMembersByExtId( {"updateOnEmailLoginMatch": ["true" | "false"] } )

See Synchronize user data using administrative commands for details.

NewsMemberService.syncBatchMemberExtIdsByEmail("emailFile" [, {"allowInactivate" : ["true" | "false"] } ] )

See Synchronize user data using administrative commands for details.

NewsMemberService.syncBatchMemberExtIdsByLogin("loginFile" [, {"allowInactivate" : ["true" | "false"] } ] )

See Synchronize user data using administrative commands for details.

NewsMemberService.syncMemberByExtId("currentExternalId"[, {"newExtId" : "id-string" [, "allowExtIdSwap" : ["true" | "false"] ] } ] )

See Synchronize user data using administrative commands for details.

NewsMemberService.syncMemberExtIdByEmail("email" [, { "allowInactivate" : ["true" | "false"] } ])

See Synchronize user data using administrative commands for details.

NewsMemberService.syncMemberExtIdByLogin("name" [, {"allowInactivate": ["true" | "false"] } ])

See Synchronize user data using administrative commands for details.

NewsScheduler commands

NewsScheduler.getTaskDetails(java.lang.String taskName)

Returns information about the scheduled task specified by taskName.

The values returned are server time, next scheduled run time, status (SCHEDULED, RUNNING, SUSPENDED), and task name. When the task has been paused, then the status parameter shows as SUSPENDED instead of SCHEDULED. SUSPENDED means that the task is not scheduled to run.

For example:

NewsScheduler.getTaskDetails("NewsDataCleanup")

The resulting output looks similar to the following:

{taskName=NewsDataCleanup, currentServerTime=Fri Mar 12 14:42:25 GMT 2010, nextFireTime=Fri Mar 12 23:00:00 GMT 2010, status=SCHEDULED}

NewsScheduler.pauseSchedulingTask(java.lang.String taskName)

Temporarily pauses the specified task and stops it from running.

When you pause a scheduled task, the task remains in the suspended state even after you stop and restart News or the WAS. You must run the NewsScheduler.resumeSchedulingTask(String taskName) command to get the task running again.

If the task is currently running, it continues to run but is not scheduled to run again. If the task is already suspended, this command has no effect. When the task is paused successfully, a 1 is returned to the wsadmin client. When the task is not paused successfully, a 0 is returned.

For example:

NewsScheduler.pauseSchedulingTask("NewsDataCleanup")

NewsScheduler.resumeSchedulingTask(java.lang.String taskName)

If the task is suspended, puts the task in the scheduled state. If the task is not suspended, this command has no effect.

When a task is resumed, it does not run immediately; it runs at the time when it is next scheduled to run.

For example:

NewsScheduler.resumeSchedulingTask("NewsDataCleanup")

When the task is resumed successfully, a 1 is returned to the wsadmin client. When the task is not resumed successfully, a 0 is returned.

Parent topic

Administer the News repository

Related concepts
Synchronize user data using administrative commands

Related tasks

Running administrative commands

   

 

});

+

Search Tips   |   Advanced Search