Writing a script
Write scripts for SOAP connectors using a KVGroup. The KVGroup includes the following key-values and sub KVGroups.
serverUrl The URL that Services the SOAP requests.
serverType The server type that specifies the details on message construction and transmission.
global The sub KVGroup that defines encoding, responses, and namespaces used by the SOAP web server.
operations The sub KVGroup that includes all operations supported by the SOAP web Service that the agent can execute.
Global configuration
envelope A sub KVGroup that describes the SOAP envelope for all operations.
body A sub KVGroup that describes the SOAP body for all operations.
element A sub KVGroup that describes the SOAP elements for all operations.
namespaces A sub KVGroup that describes the namespaces of the SOAP messages.
response A sub KVGroup that describes the responses for all operations.
wssec A sub KVGroup that describes the configuration for integrating with web services that implement WSE extensions.
Operation configuration
In order for agtsoap
to perform an agent operation, you must configure the corresponding operation KVGroup in your script under the "operations" KVGroup. You write these sub KVGroups to provide interaction details between Bravura Security Fabric and the target.
Additionally, the login and logout operations are executed (if present in the script). The login is executed proceeding an operation call. The logout is execute succeeding an operation call.
An operation KVGroup includes the following key-values and sub KVGroups:
active boolean; if true, the operation is active and supported
actionName The SOAP action on the web Service for the operation
actionUri The URI for the SOAP action on the web Service
trueval The value that represents true for "is" operations
successval The expected value to match with $issuccess in the response
request The sub KVGroup that maps to the SOAP request to the web Service
response The sub KVGroup that maps the SOAP response from the web Service
The "request" KVGroup describes the header and body of the SOAP message. Local variables or built-in variables can be used to substitute text with a session key or credentials, respectively.
The following built-in variables are available for replacement:
$adminid Administrator ID
$adminpw Administrator password
$sysid System account ID
$syspw System account password
$userid Profile ID
$fullname Full name of the profile
$acctid Account ID
$shortid Short ID of the account
$newpw New password of the user
$oldpw Old/Current password of the user
$moduleuid Account ID of the template account
$groupid Group ID of the managed group
$groupname Group description of the managed group
$session Session ID
The "response" KVGroup describes the parsing of the response from the SOAP web service.