{"id":11370,"date":"2016-11-28T12:50:31","date_gmt":"2016-11-28T12:50:31","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?page_id=11370"},"modified":"2020-05-26T11:01:59","modified_gmt":"2020-05-26T18:01:59","slug":"productivity-suspended-status-batch-management","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/install-and-upgrade\/4-1-0-0\/productivity-suspended-status-batch-management\/","title":{"rendered":"Suspend Batch"},"content":{"rendered":"

Overview<\/h1>\n

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

Configuration<\/h1>\n

The Review Suspend Batch Switch<\/strong> can be enabled (set to ON<\/strong>) from the Plugin Configuration <\/strong>screen for the REVIEW_DOCUMENT and VALIDATE_DOCUMENT plugins.<\/p>\n

    \n
  1. From the Batch Class Management<\/strong> screen, select the batch class you want to suspend. Double-click to open the batch class or click once and select Open<\/strong>.<\/li>\n<\/ol>\n

    <\/p>\n

    Figure 1. Open Selected Batch Class<\/em><\/p>\n

      \n
    1. Navigate to Modules <\/strong>> Review Document <\/strong>> REVIEW_DOCUMENT<\/strong>. The following screen will display.<\/li>\n<\/ol>\n

      <\/p>\n

      Figure 2. Plugin Configuration<\/em><\/p>\n

        \n
      1. Set the Review Suspend Batch Switch <\/strong>to ON<\/strong>.<\/li>\n<\/ol>\n

        \"A<\/p>\n

        Figure 3. Review Suspend Batch Switch<\/em><\/p>\n

          \n
        1. Follow the steps 1-3 again for the VALIDATE_DOCUMENT plugin, instead navigating to Modules <\/strong>> Validate Document<\/strong> > VALIDATE_DOCUMENT<\/strong>.<\/li>\n<\/ol>\n

          Email Notification<\/h2>\n

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

          Example: <\/strong><\/p>\n

          mail.suppress = true<\/pre>\n
          The message suppress switch is set to true by default. Replace “true” with “false” to enable email notifications.<\/p>\n
          Example:<\/strong><\/p>\n
          mail.suppress = false<\/pre>\n
          Email Address Attribute<\/h3>\n
          The mail<\/strong> 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.<\/p>\n
          When the client identity is checked against the mail <\/strong>attribute specified for the server, the value of the mail <\/strong>field must match the attribute that contains the user’s email attribute. To configure the mail <\/strong>attribute, navigate to <Application Folder<\/em>>\/WEB-INF\/classes\/META-INF\/dcma-user-connectivity\/user-connectivity.properties.<\/p>\n
          user.connectivity_userEmailSearchAttributeFilter=mail<\/pre>\n
          Example:<\/strong> In the screenshot below, the mail attribute is shown for the user “ephesoft”.<\/p>\n
          \"A<\/p>\n
          Figure 4. Ephesoft Mail Attribute<\/em><\/p>\n
          If you are using Apache Tomcat for your user connection type, this attribute must be set in the tomcat-users.xml <\/strong>file.<\/p>\n
          Refer to the screenshot below for an example:<\/p>\n
          \"A<\/p>\n
          Figure 5. tomcat-users.xml<\/em><\/p>\n
          Suspend Batch<\/h1>\n
          You can suspend a batch during Review\/Validation. The shortcut to suspend a batch is CTRL<\/strong> + SHIFT<\/strong> + S<\/strong> on the Review\/Validation screen.<\/p>\n
          The following popup will display:<\/p>\n
          \"A<\/p>\n
          Figure 6. Suspend Batch Confirmation<\/em><\/p>\n
          The following table describes the available fields:<\/p>\n\n\n\n\n\n\n\n\n
          Field<\/td>\nDescription<\/td>\n<\/tr>\n
          Assign To<\/td>\nSelect either User <\/strong>or Group<\/strong>. The default option is User<\/strong>.<\/td>\n<\/tr>\n
          Select User\/Group<\/td>\nThis dropdown contains a list of your users or groups depending on which category you selected for Assign To<\/strong>. Select a user or group to be assigned the suspended batch.<\/td>\n<\/tr>\n
          Note<\/td>\nThis note will display on the Batch List <\/strong>and Batch Instance Management <\/strong>screens. If you select Send Email<\/strong>, it will be included in the email notification.<\/td>\n<\/tr>\n
          Send Email<\/td>\nSelect this option to give Ephesoft Transact permission to send an email notification to the user or group to whom the batch is being assigned.<\/td>\n<\/tr>\n
          To<\/td>\nThis auto-populates the configured email of the assigned user or group users. This can be changed if necessary.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
          When a batch is suspended, the following options are available:<\/p>\n