Transact

  1. Home
  2. Transact
  3. Install and Upgrade
  4. Transact 4.1.0.0
  5. Suspend Batch

Suspend Batch

Overview

This page provides details on the Suspend Batch option in Ephesoft Transact. Users can suspend a batch in Review/Validation and assign it to another operator. The user who originally suspended the batch can later resume the batch.

Configuration

The Review Suspend Batch Switch can be enabled (set to ON) from the Plugin Configuration screen for the REVIEW_DOCUMENT and VALIDATE_DOCUMENT plugins.

  1. From the Batch Class Management screen, select the batch class you want to suspend. Double-click to open the batch class or click once and select Open.

Figure 1. Open Selected Batch Class

  1. Navigate to Modules > Review Document > REVIEW_DOCUMENT. The following screen will display.

Figure 2. Plugin Configuration

  1. Set the Review Suspend Batch Switch to ON.

A screenshot of a social media post Description automatically generated

Figure 3. Review Suspend Batch Switch

  1. Follow the steps 1-3 again for the VALIDATE_DOCUMENT plugin, instead navigating to Modules > Validate Document > VALIDATE_DOCUMENT.

Email Notification

To send an email notification when a batch is suspended, set the following property to “false” in the mail.properties file under <Ephesoft Directory>/WEB-INF/classes/META-INF/dcma-mail/:

Example:

mail.suppress = true

The message suppress switch is set to true by default. Replace “true” with “false” to enable email notifications.

Example:

mail.suppress = false

Email Address Attribute

The mail attribute specifies the name of the attribute that is used for storing user email addresses. This attribute can be used to identify users by their email address in certificate authentication.

When the client identity is checked against the mail attribute specified for the server, the value of the mail field must match the attribute that contains the user’s email attribute. To configure the mail attribute, navigate to <Application Folder>/WEB-INF/classes/META-INF/dcma-user-connectivity/user-connectivity.properties.

user.connectivity_userEmailSearchAttributeFilter=mail

Example: In the screenshot below, the mail attribute is shown for the user “ephesoft”.

A screenshot of a cell phone Description automatically generated

Figure 4. Ephesoft Mail Attribute

If you are using Apache Tomcat for your user connection type, this attribute must be set in the tomcat-users.xml file.

Refer to the screenshot below for an example:

A screenshot of a cell phone Description automatically generated

Figure 5. tomcat-users.xml

Suspend Batch

You can suspend a batch during Review/Validation. The shortcut to suspend a batch is CTRL + SHIFT + S on the Review/Validation screen.

The following popup will display:

A screenshot of a social media post Description automatically generated

Figure 6. Suspend Batch Confirmation

The following table describes the available fields:

FieldDescription
Assign ToSelect either User or Group. The default option is User.
Select User/GroupThis dropdown contains a list of your users or groups depending on which category you selected for Assign To. Select a user or group to be assigned the suspended batch.
NoteThis note will display on the Batch List and Batch Instance Management screens. If you select Send Email, it will be included in the email notification.
Send EmailSelect this option to give Ephesoft Transact permission to send an email notification to the user or group to whom the batch is being assigned.
ToThis auto-populates the configured email of the assigned user or group users. This can be changed if necessary.

When a batch is suspended, the following options are available:

  • Assign the suspended batch to another user or group for further validation
  • Send an email notification to the user or group that the batch was assigned to
  • Add a note to the suspended batch as part of the email sent
    • This note will be visible on the Batch List and Batch Instance Management screens

View Suspended Batch

You can view the batch that has been assigned to you on Batch List > Assigned To Me.

A screenshot of a social media post Description automatically generated

Figure 7. Assigned To Me Tab

On the Batch Instance Management screen, the following columns display relevant information about the suspended batch:

  • Is Suspended
  • Assigned To
  • Batch Note

A screenshot of a social media post Description automatically generated

Figure 8. Batch Instance Management Screen

Resume Batch

Only the user who suspended the batch can resume the batch again. This is done in the same manner as suspending the batch.

  1. Open the Batch Instance Management screen or Batch List screen.
  2. Open the suspended batch. The following popup will display.

A screenshot of a cell phone Description automatically generated

Figure 9. Confirmation Message

  • Select Resume to release the batch from the suspended state. The user who was assigned the suspended batch will no longer see the batch in the Assigned To Me tab on the Batch List screen.
  • Select View Only to open the Review/Validate screen and view the suspended batch. To resume the batch from this screen, press CTRL + SHIFT + S.

Conclusion

This completes the overview and configuration of the Suspend Batch option in Ephesoft Transact.

 

Was this article helpful to you? Yes No