com.ca.dso.itpam.webservice.cli
Class ItpamWebServiceCLI

java.lang.Object
  extended by com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIConstants
      extended by com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils
          extended by com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLI

public class ItpamWebServiceCLI
extends com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils

CA ITPAM Web Service Command Line Interface

Author:
George Curran, CA DSO

General Usage:
caitpamwsu.cmd [/? or /h or /help]

Displays general usage.

caitpamwsu.cmd

Invokes web service methods silently. Commands that produce output will write to STDOUT. Error messages will be written to STDERR. Environment variable "ERRORLEVEL" will be set to one of the success/error codes listed below and the success/error code will be returned:


0 Completed successfully
9001 Attempt to initialize CLI utilities failed
9002 Unexpected Java or web service exception
9003 IT PAM entity not found or inaccessible
9004 Method not supported for action/entities specified
9005 Required argument or parameter not specified
9006 Unsupported date format specified
9007 Host specified not found or inaccessible
9008 Insufficient user permissions
9009 Unexpected web service exception thrown by web service host

caitpamwsu.cmd [/i]

Invokes web service methods interactively (i.e., results and errors) are displayed on the console. The "/i" switch must be the first argument specified.
Service Configuration and Authentication:
Actions that communicate with the IT PAM web service require the user to specify values for the following parameters:

user=
password=
uri=:/itpam/soap)>
version=
For security reasons user name and password are not stored and must be specified each time the utility is invoked.

The action, "setServiceConfig", has been provided to store the "uri" and "version" to eliminate the need to specify the values each time. The saved values may be superseded by specifying the arguments when a command is issued. The current stored values may be retrieved using the "getServiceConfig" command.

Nested Class Summary
 
Nested classes/interfaces inherited from class com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils
com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils.ItpamCLIParameterMissingOrInvalidException, com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils.ItpamCLIUnexpectedReturnException
 
Field Summary
static java.lang.String CACOPYRIGHT
          Public string constant required by CA
 
Fields inherited from class com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils
bolAbsolutePath, bolAllowPartialMatch, bolEnablePatternMatch, bolEventSingleSubscriber, bolHelpRequested, bolImportMakeAvailable, bolImportMakeCurrent, bolInteractiveMode, bolOverwriteTargetFile, bolRecursive, bolTargetPathIsLocal, client, intExitCode, intLevelsToSearch, lEventExpirationDuration, lInteractionId, logger, lProcessId, lStartRequestId, messages, propertiesAttachments, propertiesParameters, strAction, strActionFile, strAttachmentParameterName, strContentId, strContentType, strEndDate, strEventDestination, strEventExpression, strEventName, strEventPayload, strEventSource, strEventType, strImportSourcePathFileName, strImportTargetLibraryPathName, strItpamPassword, strItpamUri, strItpamUser, strItpamVersion, strLevel, strOutputFormat, strProcessName, strSearchPath, strSourceLibraryPath, strStartDate, strStartRequestName, strStartRequestPath, strStartTime, strTargetFileName, strTargetPath, strUsageResourceBundle, vActionsSupported, vAttachmentIds, vCategories, vKeywords, vObjectTypes
 
Fields inherited from class com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIConstants
ARG_NAME_ABSOLUTE_PATH, ARG_NAME_ACTION, ARG_NAME_ACTION_FILE, ARG_NAME_ALLOW_PARTIAL_MATCH, ARG_NAME_ATTACHMENT_ID, ARG_NAME_ATTACHMENT_NAME, ARG_NAME_ATTACHMENT_PARAMETER_NAME, ARG_NAME_CATEGORY, ARG_NAME_CONNNECTION_ID, ARG_NAME_CONTENT_ID, ARG_NAME_CONTENT_TYPE, ARG_NAME_DESCRIPTION, ARG_NAME_EARLIEST_START_DATE, ARG_NAME_ENABLE_PATTERN_MATCH, ARG_NAME_END_DATE, ARG_NAME_EVENT_CREATION_TIME, ARG_NAME_EVENT_DESTINATION, ARG_NAME_EVENT_EXPIRATION_DURATION, ARG_NAME_EVENT_EXPIRATION_TIME, ARG_NAME_EVENT_EXPRESSION, ARG_NAME_EVENT_NAME, ARG_NAME_EVENT_PAYLOAD, ARG_NAME_EVENT_SINGLE_SUBSCRIBER, ARG_NAME_EVENT_SOURCE, ARG_NAME_EVENT_TYPE, ARG_NAME_EVENT_USER, ARG_NAME_IMPORT_MAKE_AVAILABLE, ARG_NAME_IMPORT_MAKE_CURRENT, ARG_NAME_IMPORT_SOURCE_PATH_FILE_NAME, ARG_NAME_IMPORT_TARGET_LIBRARY_PATH_NAME, ARG_NAME_INTERACTION_ID, ARG_NAME_ITPAM_PASSWORD, ARG_NAME_ITPAM_URI, ARG_NAME_ITPAM_USER, ARG_NAME_ITPAM_VERSION, ARG_NAME_KEYWORD, ARG_NAME_LEVEL, ARG_NAME_LEVELS_TO_SEARCH, ARG_NAME_LOG_LEVEL, ARG_NAME_MESSAGE, ARG_NAME_MESSAGE_STATUS, ARG_NAME_OBJECT_TYPE, ARG_NAME_OUTPUT_FORMAT, ARG_NAME_OVERWRITE_TARGET_FILE, ARG_NAME_PROCESS_DISPLAY_NAME, ARG_NAME_PROCESS_ID, ARG_NAME_PROCESS_INSTANCE_NAME, ARG_NAME_PROCESS_LIBRARY_PATH_NAME, ARG_NAME_PROCESS_NAME, ARG_NAME_PROCESS_STATE, ARG_NAME_RECUSIVE, ARG_NAME_SEARCH_PATH, ARG_NAME_SENDER_ADDRESS, ARG_NAME_SOURCE_LIBRARY_PATH, ARG_NAME_START_DATE, ARG_NAME_START_REQUEST_ID, ARG_NAME_START_REQUEST_NAME, ARG_NAME_START_REQUEST_PATH, ARG_NAME_START_REQUEST_STATE, ARG_NAME_START_TIME, ARG_NAME_SUBMISSION_TIME, ARG_NAME_TARGET_FILE_NAME, ARG_NAME_TARGET_PATH, ARG_NAME_TARGET_PATH_IS_LOCAL, ARG_NAME_TIME_STAMP, ARG_PREFIX_ATTACHMENT, ARG_PREFIX_PARAMETER, DEFAULT_LOG_LEVEL, DEFAULT_OUTPUT_FORMAT, DEFAULT_USAGE_RESOURCE_BUNDLE_NAME, DELIMITER_PROPERTIES, DELIMITER_XML_ELEMENT, DELIMITER_XML_INDENT, LIST_ACTIONS_CLIENT_NOT_REQUIRED, LOG_LAYOUT, LOG_MAX_BACKUPS, LOG_MAX_FILE_SIZE, LOG_PATH_FILE, OUTPUT_FORMAT_PROPERTIES, OUTPUT_FORMAT_XML, SERVER_CONFIG_FILE, SERVER_CONFIG_PATH
 
Constructor Summary
ItpamWebServiceCLI()
           
 
Method Summary
private static void abortProcess()
          Abort process specified by process ID.
private static void approvePendingInteraction()
          Approve pending user interaction request.
private static void deleteArchivedInstances()
          Delete archived instances in date range specified.
private static void deleteAttachments()
          Delete specified attachments.
private static void exportObject()
          Export objects from IT PAM library to file.
private static void generateEvent()
          Generate an event consumable by waiting IT PAM process operator.
private static void getAttachments()
          Get information for existing attachments.
private static void getMatchingEvents()
          Get event data for events matching criteria specified.
private static void getPendingInteraction()
          Get information related to pending user interaction specified.
private static void getPendingInteractions()
          Get pending interaction information.
private static void getProcessLogs()
          Get process logs.
private static void getProcessParameters()
          Get parameter name/values for process specified.
private static void getProcessPendingInteractions()
          Get list of pending interactions related to the process ID specified.
private static void getProcessStatus()
          Get current status of process specified.
private static void getServerStatus()
          Get current status of the ITPAM web service server.
private static void getServiceConfig()
          Get URI and version properties of the ITPAM web service server.
private static void getStartRequestForms()
          Search for and return available start request forms.
private static void getStartRequestParameters()
          Get start request parameter information.
private static void getStartRequestProcessReferenced()
          Get process name referenced by the start request form specified.
private static void getStartRequestStatus()
          Get start request status object that includes the following information.
private static void importObject()
          Import file into ITPAM library.
static void main(java.lang.String[] args)
          Main to support launch from command line.
private static void rejectPendingInteraction()
          Reject pending user interaction request.
private static void resumeProcess()
          Resume process specified by process ID.
private static void setServiceConfig()
          Set URI and version properties of the ITPAM web service server.
private static void startProcess()
          Start process specified.
private static void startRequest()
          Initiate process via start request form.
private static void suspendProcess()
          Suspend process specified by process ID.
 
Methods inherited from class com.ca.dso.itpam.webservice.cli.ItpamWebServiceCLIUtils
displayUsage, getAttachmentsString, getEventDataString, getMatchingEventsDataString, getParametersString, getProcessLogEntriesString, getProcessParametersString, getProcessPendingInteractionsString, getProcessStatusString, getStartRequestFormsString, getStartRequestStatusString, initUtils, isNullEmpty, isNumeric, setExitCode, storeServiceConfig
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CACOPYRIGHT

public static final java.lang.String CACOPYRIGHT
Public string constant required by CA

See Also:
Constant Field Values
Constructor Detail

ItpamWebServiceCLI

public ItpamWebServiceCLI()
Method Detail

main

public static void main(java.lang.String[] args)
Main to support launch from command line.

Parameters:
args -

abortProcess

private static void abortProcess()
                          throws java.lang.Exception
Abort process specified by process ID.

IT PAM version required:
2.2 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

approvePendingInteraction

private static void approvePendingInteraction()
                                       throws java.lang.Exception
Approve pending user interaction request.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair interactionId=[Interaction ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

deleteArchivedInstances

private static void deleteArchivedInstances()
                                     throws java.lang.Exception
Delete archived instances in date range specified.

IT PAM version required:
2.2 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair startDate=[Start date of date range]
Name/value pair endDate=[End date of date range]

Supported date formats 'yyyy-MM-dd', 'yyyy/MM/dd', 'MM-dd-yyyy', 'MM/dd/yyyy'
Supported time formats 'hh:mm:ss', 'hh:mm'
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

deleteAttachments

private static void deleteAttachments()
                               throws java.lang.Exception
Delete specified attachments.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
At least one name/value pair attachmentId=[Attachment ID to be deleted]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

exportObject

private static void exportObject()
                          throws java.lang.Exception
Export objects from IT PAM library to file.

IT PAM version required:
3.0 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=exportObject
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair sourceLibraryPath=[Source ITPAM library path to search for content to be exported (include object name to export a specific object)]
Name/value pair targetPath=[Target file system path for resulting object export file (Note: Content may exported to existing directory on the IT PAM server or an accessible UNC path)]
Name/value pair targetFileName=[Target file name for resulting object export file]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Name/value pair levelsToSearch=[Integer set levels relative to source library path to search/include for content to be exported (default is 0)]
Name/value pair absolutePath=[Flag set to true if library paths in resulting export file should be absolute or false if paths should be relative (default is false)]
Name/value pair overwriteTargetFile=[Flag set to true if any existing export file with the same name in the same location should be overwritten (default is false)]
Name/value pair(s) objectType=[String set to a valid object type applied as a filter that determines which objects in the source path to include in the exported content (Note: Multiple name/value pairs may be specified)]

Supported object type filter strings:
- Agenda
- Calendar
- Commander
- CustomIcon
- CustomOperator
- CustomSensor
- Dataset
- InteractionRequestForm
- LogViewer
- Package
- Process
- ProcessWatch
- Resources
- StatePolicy
- System
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

generateEvent

private static void generateEvent()
                           throws java.lang.Exception
Generate an event consumable by waiting IT PAM process operator.

IT PAM version required:
3.0 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=generateEvent
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
The following parameter(s) must be specified via the command line:
Name/value pair eventName=[Event Name]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Name/value pair eventType=[Event Type]
Name/value pair eventDestination=[Event Destination]
Name/value pair eventSource=[Event Source]
Name/value pair eventExpirationDuration=[Event Duration in Seconds]
Name/value pair eventSingleSubscriber=[True or False to flag event as "consumable" by a single listener only]
Name/value pair eventPayload=[Event Pay Load (content to be used by waiting process operator(s)]
Name/value pair eventSingleSubscriber=[True or False to flag event as "consumable" by a single listener only]
One or more name/value pairs param.[Parameter Name]=[Parameter Value]

NOTE: Event pay load will be superseded by parameters.
Output when successful:
String of event data for the event generated formatted as specified by user.

Throws:
java.lang.Exception

getAttachments

private static void getAttachments()
                            throws java.lang.Exception
Get information for existing attachments.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
One or both value(s) for the following parameter(s) must be specified via the command line:
Name/value pair contentId=[Content ID]
Name/value pair contentType=[Content Type]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of attachment properties formatted as specified by user matching the filter criteria (Content ID and/or Content Type) specified.

Throws:
java.lang.Exception

getMatchingEvents

private static void getMatchingEvents()
                               throws java.lang.Exception
Get event data for events matching criteria specified.

IT PAM version required:
3.0 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair eventName=[Event Name]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair eventType=[Event Type]
Name/value pair eventDestination=[Event Destination]
Name/value pair eventSource=[Event Source]
Name/value pair eventExpression=[Expression that will be compared to event "payload" parameter(s) (ex. payload.paramName=="paramValue"). Note that entire expression must be encapsulated in double quotes and double equal signs ("==") are required.]
Name/value pair allowPartialMatch=[Specify true to return data for events that partially match the specified criteria (default is false)]
Name/value pair enablePatternMatch=[Specify true if criteria specified should be interpreted as regex-type patterns (default is false)]
Output when successful:
String of event data formatted as specified by user for events matching criteria specified.

Throws:
java.lang.Exception

getPendingInteraction

private static void getPendingInteraction()
                                   throws java.lang.Exception
Get information related to pending user interaction specified.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair interactionId=[Interaction ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of interaction properties formatted as specified by user.

Throws:
java.lang.Exception

getPendingInteractions

private static void getPendingInteractions()
                                    throws java.lang.Exception
Get pending interaction information.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of attachment properties formatted as specified by user.

Throws:
java.lang.Exception

getProcessLogs

private static void getProcessLogs()
                            throws java.lang.Exception
Get process logs.

IT PAM version required:
2.2 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Name/value pair level=[Minimum severity of log entries to be return (all messages returned by default)]
One or more name/value pairs category=[Log category ("Process", "Operator", "Handler", "Response", "Other", "Custom" (all messages return by default, invalid entries are ignored))
Output when successful:
String of log entries formatted as specified by user.

Throws:
java.lang.Exception

getProcessParameters

private static void getProcessParameters()
                                  throws java.lang.Exception
Get parameter name/values for process specified.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of parameter properties formatted as specified by user.

Throws:
java.lang.Exception

getProcessPendingInteractions

private static void getProcessPendingInteractions()
                                           throws java.lang.Exception
Get list of pending interactions related to the process ID specified.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of interaction properties formatted as specified by user.

Throws:
java.lang.Exception

getProcessStatus

private static void getProcessStatus()
                              throws java.lang.Exception
Get current status of process specified.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of interaction properties formatted as specified by user.

Throws:
java.lang.Exception

getServerStatus

private static void getServerStatus()
                             throws java.lang.Exception
Get current status of the ITPAM web service server.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String set to server status.

Throws:
java.lang.Exception

getServiceConfig

private static void getServiceConfig()
                              throws java.lang.Exception
Get URI and version properties of the ITPAM web service server.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getServerConfig
Output when successful:
String set to service uri and version.

Throws:
java.lang.Exception

getStartRequestParameters

private static void getStartRequestParameters()
                                       throws java.lang.Exception
Get start request parameter information.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getStartRequestParameters
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair startRequestName=[Start Request Form Name]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Name/value pair startRequestPath=[Start Request Form Library Path (default is "/")]
Output when successful:
String of attachment properties formatted as specified by user.

Throws:
java.lang.Exception

getStartRequestForms

private static void getStartRequestForms()
                                  throws java.lang.Exception
Search for and return available start request forms.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair startRequestName=[Start request form name]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Name/value pair startRequestPath=[ITPAM library search path (default is root ("/"))
Output when successful:
String of start request form parameters formatted as specified by user.

Throws:
java.lang.Exception

getStartRequestProcessReferenced

private static void getStartRequestProcessReferenced()
                                              throws java.lang.Exception
Get process name referenced by the start request form specified.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair startRequestName=[Start Request Name]
Name/value pair startRequestPath=[Start Request Library Path]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String set to fully qualified process name referenced by the start request form specified.

Throws:
java.lang.Exception

getStartRequestStatus

private static void getStartRequestStatus()
                                   throws java.lang.Exception
Get start request status object that includes the following information.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair interactionId=[Start Request Interaction ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
String of start request status properties formatted as specified by user.

Throws:
java.lang.Exception

importObject

private static void importObject()
                          throws java.lang.Exception
Import file into ITPAM library.

IT PAM version required:
2.2 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=importObject
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair sourcePathFileName=[Path/file name of source object definition file to be imported to be imported]
Name/value pair targetLibraryPathName=[Target IT PAM library path/name of the object to be created]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Name/value pair importMakeAvailable=[True or False to make the object(s) resulting from the import available for use]
Name/value pair importMakeCurrent=[True or False to make the object(s) resulting from the import the current version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

rejectPendingInteraction

private static void rejectPendingInteraction()
                                      throws java.lang.Exception
Reject pending user interaction request.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair interactionId=[Interaction ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

resumeProcess

private static void resumeProcess()
                           throws java.lang.Exception
Resume process specified by process ID.

IT PAM version required:
2.2 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

setServiceConfig

private static void setServiceConfig()
                              throws java.lang.Exception
Set URI and version properties of the ITPAM web service server.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=setServerConfig
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception

startProcess

private static void startProcess()
                          throws java.lang.Exception
Start process specified.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processName=[Fully qualified process name]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
One or more name/value pairs param.[Parameter Name]=[Parameter Value]
Name/value pair startTime=[Start time ('hh:mm:ss', 'hh:mm') (default is now)]
Name/value pair startDate=[Start date ('yyyy-MM-dd', 'yyyy/MM/dd', 'MM-dd-yyyy', 'MM/dd/yyyy') required if "startTime" specified (default is today)]
One or more name/value pairs attach.[Attachment Name]=[Attachment URI]
Name/value pairs attachmentParameterName=[Parameter Name to link attachments to (required if on or more attachment parameters are specified]
Output when successful:
String set to process ID.

Throws:
java.lang.Exception

startRequest

private static void startRequest()
                          throws java.lang.Exception
Initiate process via start request form.

IT PAM version required:
2.1 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair startRequestName=[Start Request Name]
Name/value pair startRequestPath=[Start Request Path]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
One or more name/value pairs param.[Parameter Name]=[Parameter Value]
Name/value pair startTime=[Start time ('hh:mm:ss', 'hh:mm') (default is now)]
Name/value pair startDate=[Start date ('yyyy-MM-dd', 'yyyy/MM/dd', 'MM-dd-yyyy', 'MM/dd/yyyy') required if "startTime" specified (default is today)]
One or more name/value pairs attach.[Attachment Name]=[Attachment URI]
Name/value pairs attachmentParameterName=[Parameter Name to link attachments to (required if on or more attachment parameters are specified]
Output when successful:
String set to start request interaction ID.

Throws:
java.lang.Exception

suspendProcess

private static void suspendProcess()
                            throws java.lang.Exception
Suspend process specified by process ID.

IT PAM version required:
2.2 or higher
Requires value(s) for the following parameter(s) be specified via the command line:
Name/value pair action=getPendingInteractions
Name/value pair user=[ITPAM User Name]
Name/value pair password=[ITPAM User Password]
Name/value pair processId=[Process ID]
Optional value(s) for the following parameter(s) may be specified via the command line:
Name/value pair uri=[URI for ITPAM web service (ex. http://[Server]:[Port]/itpam/soap]
Name/value pair version=[ITPAM version]
Output when successful:
Message indicating command completed successfully

Throws:
java.lang.Exception