SendForProcessing activity for a multi-document case

Configure the SendForProcessing Pega activity for a multi-document case: create a batch, add each attachment, start processing, and store the BatchId.

The SendForProcessing activity creates a batch in ABBYY FlexiCapture, adds every case attachment to it, starts processing, and stores the batch identifier on the case.

For the general procedure, see Create a Pega activity.

Pages and classes

Page name	Class
Case	Work-
Attachment	Data-WorkAttach-File
AttachmentInfo	Data-WorkAttach-File

Parameters

Name	Data type	Required
CaseId	String	Yes

Local variables

Name	Data type
LinkedRefTo	String
Id	String
BatchId	String

Activity steps

1. Open the case

   Field	Value
   Method	Obj-Open-By-Handle
   Step page	Case
   InstanceHandle	Param.CaseId

   
2. Check that the case has attachments

   Field	Value
   Method	Page-Set-Messages
   Message	Please add files to case before proceeding.

   

   Add the following When condition:

   When	if true	true param	if false	false param
   AttachmentsIsNull	Continue Whens		Skip Step

   To build the AttachmentsIsNull condition:

   1. In the When field, specify AttachmentsIsNull and click the configuration button. If the condition does not exist yet, a window opens in which you can create it.
   2. Make sure that the full name of the case is specified in the Apply to field, and then click Create and open.
   3. On the Conditions tab, click Configure advanced conditions here and select the length of [a pagelist property] Is [comparison operator] [value] condition type.
   4. Create the condition length of .pyAttachments is Equal To 0.

   

   

   Add the following Jump condition:

   When	if true	true param	if false	false param
   true	Exit Activity

   
3. Create the batch

   Set Method to Call-Function and the function as follows:

   Function	Return value
   @ABBYY.CreateNewBatch()	Local.BatchId

   For more information, see CreateNewBatch.

   Add the following Jump condition, and set On exception, jump to later step label to ERR:

   When	if true	true param	if false	false param
   StepStatusFail	Jump to Later Step	ERR

   

   
4. Loop over the case attachments

   Set Method to Property-Set and the properties as follows:

   PropertiesName	PropertiesValue
   Local.LinkedRefTo	Case.pyAttachments(<CURRENT>).pxLinkedRefTo
   Local.Id	Case.pyAttachments(<CURRENT>).pzInsKey

   

   Set the Loop properties as follows:

   Repeat	Value List Property
   For each element in value list	Case.pyAttachments

   

   Add the following substeps to this step, so that the loop repeats them for each attachment:

   1. Open the attachment

      Field	Value
      Method	Obj-Open-By-Handle
      Step page	Attachment
      InstanceHandle	Local.LinkedRefTo

      

   2. Open the attachment information

      Field	Value
      Method	Obj-Open-By-Handle
      Step page	AttachmentInfo
      InstanceHandle	Local.Id

      

   3. Add the document to the batch

      Set Method to Call-Function and the function as follows:

      Function	Return value
      @ABBYY.AddDocumentToBatch(Local.BatchId, AttachmentInfo.pyMemo, Attachment.pyAttachStream)

      For more information, see AddDocumentToBatch.

      Add the following Jump condition, and set On exception, jump to later step label to ERR:

      When	if true	true param	if false	false param
      StepStatusFail	Jump to Later Step	ERR

      
      
5. Start batch processing

   Set Method to Call-Function and the function as follows:

   Function	Return value
   @ABBYY.RunBatchProcessing(Local.BatchId)

   For more information, see RunBatchProcessing.

   Add the following Jump condition, and set On exception, jump to later step label to ERR:

   When	if true	true param	if false	false param
   StepStatusFail	Jump to Later Step	ERR

   

   
6. Wait for the verification URL

   Set Method to Call-Function and the function as follows:

   Function	Return value
   @ABBYY.WaitFirstVerificationOrProcessedForMultiFileInvoice(Local.BatchId)	.VerificationUrl

   For more information, see WaitFirstVerificationOrProcessedForMultiFileInvoice.

   Add the following Jump condition, and set On exception, jump to later step label to ERR:

   When	if true	true param	if false	false param
   StepStatusFail	Jump to Later Step	ERR	Jump to Later Step	OK

   

   
7. Post the error message

   Field	Value
   Label	ERR
   Method	Page-Set-Messages
   Message	@unescapeHTML(@getWorstMessageName(tools))

   For more information, see unescapeHTML.

   
8. Store the batch identifier

   Set Label to OK, set Method to Property-Set, and set the property as follows:

   PropertiesName	PropertiesValue
   .BatchId	Local.BatchId