Product Documentation

batchRequest - Running a Batch

Feb 07, 2011

The batchRequest operation acts as a container for a list containing other operations (requestnameRequest). Single Sign-on supports sequential processing mode only. A batchRequest that specifies parallel processing does not result in an error, but is processed sequentially.

Syntax

<batchRequest processing="sequential" onError="resume"> 
   <addRequest requestID=&rsquo;client-generated-ID1&rsquo; 
   targetID='CPM Provisioning 1.0' 
   returnData='identifier' executionMode='synchronous'>  
   <ctxs:authentication-token  
   xmlns:ctxs='http://citrix.com/Provision'>AuthToken 
   </ctxs:authentication-token> 
   <containerID ID='userFQDN'/> 
   <data>   
      <ctxs:credential xmlns:ctxs='http://citrix.com/Provision'> 
         <ctxs:name>Credential name</ctxs:name> 
         <ctxs:application> 
            <ctxs:id>appdefGuid</ctxs:id> 
            <ctxs:fields> 
               <ctxs:userID>janed</ctxs:userID> 
               <ctxs:password>pwd123</ctxs:password> 
            </ctxs:fields> 
         </ctxs:application> 
      </ctxs:credential> 
   </data> 
</addRequest> 
 
<addRequest requestID=&rsquo;client-generated-ID2' 
   targetID='CPM Provisioning 1.0'   
   returnData='identifier' executionMode='synchronous'> 
   <ctxs:authentication-token  
   xmlns:ctxs='http://citrix.com/Provision'>AuthToken 
   </ctxs:authentication-token> 
   <containerID ID='userFQDN'/> 
   <data> 
      <ctxs:credential xmlns:ctxs='http://citrix.com/Provision'> 
         <ctxs:name>Credential name</ctxs:name> 
         <ctxs:application> 
            <ctxs:id>appdefGuid2</ctxs:id> 
            <ctxs:fields> 
               <ctxs:userID>salima</ctxs:userID> 
               <ctxs:password>pass123</ctxs:password> 
            </ctxs:fields> 
         </ctxs:application> 
      </ctxs:credential> 
   </data> 
</addRequest> 
</batchRequest>

Parameters

processing (mandatory) This is the processing mode. Valid values are 'sequential' and 'parallel'; however, Single Sign-on supports only sequential mode. When parallel processing mode is specified, Single Sign-on processes the request sequentially.
onError This is the action you want Single Sign-on to take when there is an error during processing. Valid values are 'resume' and 'exit.'
requestnameRequest (mandatory, variable) List each request you want to process in this batch, using the syntax and parameters specified for that request.

Syntax for Return Values (batchResponse)

 <batchResponse> 
   <addResponse status="success" requestID="client-generated-ID1"> 
      <pso> 
         <psoID ID='credential-GUID'> 
      </pso> 
   </addResponse> 
   <addResponse status="success" requestID="client-generated-ID1"> 
      <pso> 
         <psoID ID='credential-GUID'> 
      </pso> 
   </addResponse> 
</batchResponse>

Parameters for Return Values (batchResponse)

requestnameResponse (variable) The name of each request that was specified to process in this batch request. For the return values syntax related to each request, refer to the documentation for that request.