APADM Command Line Utility

Prerequisites

• To use the ExecutionTimeout argument, you must have a release that includes Intermediate Fix 08.0081.02.
• To use the SyncSocialAccounts argument, you must have AgilePoint v5.0 R2 with Intermediate Fix 08.0082.01.

Navigation

1. In a command prompt, change directories to [AgilePoint Server installation folder]\Tools

Instructions

1. Run the following commands as required, using the following format:

   apadm.exe [command] [arguments]

   Command	Required Arguments	Optional Arguments	Example
   -help
   -adduser	[LDAP path] [AgilePoint Server URL]	ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation. SyncSocialAccounts - Synchronizes users' email IDs with their Yammer and Lync IDs.	apadm -adduser LDAP://dc=tusca,dc=com http://localhost/AgilePointServer apadm -adduser LDAP://dc=tusca,dc=com http://localhost/AgilePointServer ExecutionTimeout=100
   -archive	[days] or [process instance ID] or [ProcessDefinitionName:ProcessInstaneName] [AgilePoint Server URL]	-Y - Supresses the interactive confirmation to proceed with the action. ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	The following example archives all processes that were completed or canceled 10 days ago. apadm -archive 10 http://localhost/AgilePointServer The following example archives the process with the specified process instance ID. apadm -archive 501630F1C09743dbBA25FAC9C3DA7524 http://localhost/AgilePointServer apadm -archive 10 http://localhost/AgilePointServer -Y ExecutionTimeout=100
   -restore	[process instance ID] or [ProcessDefinitionName:ProcessInstaneName] [AgilePoint Server URL]	ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	apadm -restore 501630F1C09743dbBA25FAC9C3DA7524 http://localhost/AgilePointServer apadm -restore ExpenseReport:JohnSmith-01-20-2010-09 http://localhost/AgilePointServer ExecutionTimeout=100
   -syncgm	[LDAP path] [authentication domain name] [AgilePoint Server URL]	[retry count] - An integer that specifies a number of times to retry the operation before quitting. ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation. SyncSocialAccounts - Synchronizes users' email IDs with their Yammer and Lync IDs.	apadm -syncgm LDAP://dc=tusca,dc=com TUS http://localhost/AgilePointServer In the following example, if synchronization fails, it retries 5 times as specified in the optional last parameter. apadm -syncgm LDAP://dc=tusca,dc=com TUS http://localhost/AgilePointServer 5 ExecutionTimeout=100
   -rmprocdef	[process definition name] [AgilePoint Server URL]	-Y - Supresses the interactive confirmation to proceed with the action. ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	apadm -rmproc PurchaseRequest http://localhost/AgilePointServer apadm -rmproc PurchaseRequest http://localhost/AgilePointServer -Y ExecutionTimeout=100
   -mgproc	[process migration instruction XML file] [AgilePoint Server URL]	-NoSchemaMigrate - Stops upgrading the schema to the latest updated schema. -Run - Keeps the process running, even if an error occurs while running the operation. By default, if an error occurs, the process moves to a suspended state. ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	apadm -mgproc PurchaseRequest http://localhost/AgilePointServer apadm -mgproc PurchaseRequest http://localhost/AgilePointServer -NoSchemaMigrate -Run ExecutionTimeout=100
   -sysinfo	[AgilePoint Server URL]	ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	apadm -systeaminfo http://localhost/AgilePointServer apadm -systeaminfo http://localhost/AgilePointServer ExecutionTimeout=100
   -publishprocdef	[AgilePoint Server URL] [folder] or [file] [release date]	ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	In this example, abc is a folder that contains XML files of process definition that need to be published and scheduled to be released on 1/20/2011. apadm -publishprocdef http://localhost/AgilePointServer abc 1/20/2011 apadm -publishprocdef http://localhost/AgilePointServer abc 1/20/2011 ExecutionTimeout=100 In this example, expensereport.xml is an XML file of process definition that needs to be published. apadm -publishprocdef http://localhost/AgilePointServer expensereport.xml
   -analyzeclusterlog	[cluster log file]	ExecutionTimeout = [seconds] - Specifies a timeout value, in seconds, for the operation.	apadm -analyzeclusterlog 20110521T043713Cluster.log apadm -analyzeclusterlog 20110521T043713Cluster.log ExecutionTimeout=100