Sign inSign up

skilja/vinna_batchreview

By skilja

ā€¢Updated 22 days ago

Batch Review web application from Skilja GmbH

Image
0

2.6K

skilja/vinna_batchreview repository overview

ā Quick reference

ā Supported tags and Versioning

Image tags adhere to <major>.<minor>.<patch> format.

<major>.<minor>.<patch> points to a specific version. <Major>.<Minor> always points to the latest version. This version is compatible with all previous images of the same <Major>.<Minor> version. <latest> always points to the latest version, but such a version might require service and project database schema updates. To use the latest but compatible version, we recommend to pull a <Major>.<Minor> with

docker pull skilja/vinna_batchreview:\<Major>.\<Minor>

Note: Batch Review is an add-on to the Vinna Platform and requires a runtime installation (see linkā ).

The most recent images is



logo drawing

ā What is Batch Review?

Batch Review is a web application that allows editing the structure of a work item as well as individual document and page custom values. Its main use case is the manual correction of classification and structuring results.

A user can change the structure of a work item by splitting and merging documents, and moving pages. In addition, the client application allows editing information stored in document and page custom values.

Besides the web application, Batch Review is also available as an electron application that provides the web application packages as a standalone Windows program.

To setup the correction, you add the Batch Review activities to a Vinna process in the order of Batch Review Pre Processing - Batch Review - Batch Review Post Processing.

ā How to use this image

Besides the Vinna platform, Batch Review relies on Skilja Validation Service. The following sample shows how to deploy the web client, assuming the following endpoints are available:

Vinna ConfigurationService Endpoint: "https://vinnadev.local/configurationService"

1. Modify and save the following services.json to your dockerhost machine.

{
  "Services": {
    "ConfigurationService": "https://vinnadev.local/configurationService/",
    "ApiVersion": "2.1"
  },
  "DefaultAppSettings": [
   {
      "key": "AuthenticationMethod",
      "value": "Password"
    },
    {
      "key": "ShowExternalUserOptions",
      "value": true
    },
    {
      "key": "DefaultExternalUserOption",
      "value": "None"
    },
    {
      "key": "CurrentUserTracking",
      "value": true
    },
    {
      "key": "DoBenchmarking",
      "value": false
    },
    {
      "key": "BenchmarkingVerbosity",
      "value": 0
    },
    {
      "key": "DefaultFilterSelected",
      "value": ""
    },
    {
      "key": "AllowFilterManagement",
      "value": true
    },
    {
      "key": "AllowFilterImport",
      "value": true
    },
    {
      "key": "AllowFilterExport",
      "value": true
    },
    {
      "key": "FilterTypesToDisplay",
      "value": "All"
    },
    {
      "key": "AllowWISearch",
      "value": true
    },
    {
      "key": "AllowWIColumnReorder",
      "value": true
    },
    {
      "key": "AllowWIColumnResize",
      "value": true
    },
    {
      "key": "AllowWIColumnSelection",
      "value": true
    },
    {
      "key": "AllowedSettingsSections",
      "value": "All"
    },
    {
      "key": "KpiDataEnabled",
      "value": false
    },
    {
      "key": "KpiDataCustomValueKey",
      "value": "cv_KpiData"
    },
    {
      "key": "AssignExternalUser",
      "value": false
    },
    {
      "key": "UseSheetPageConcept",
      "value": false
    },
    {
      "key": "AppendLeadingHiddenPagesOnSplit",
      "value": true
    },
    {
      "key": "ThumbnailSize",
      "value": "medium"
    },
    {
      "key": "AutoNavigateErrors",
      "value": true
    },
    {
      "key": "ShowEmptyDocuments",
      "value": true
    },
    {
      "key": "ShowVisibleHiddenPages",
      "value": "both"
    },
    {
      "key": "ShowEmptyNonEmptyPages",
      "value": "both"
    },
    {
      "key": "ShowFrontBackPages",
      "value": "both"
    },
    {
      "key": "DoublePreviewConfiguration",
      "value": "None"
    },
    {
      "key": "Language",
      "value": "en"
    },
    {
      "key": "AutoReleaseIfValid",
      "value": true
    },
    {
      "key": "AllowReleaseInvalid",
      "value": false
    },
    {
      "key": "DefaultSortColumns",
      "value": "Priority:-1;TTC:1"
    },
    {
      "key": "NonSearchableFields",
      "value": ""
    },
    {
      "key": "NonSortableFields",
      "value": ""
    },
    {
      "key": "PredefinedSearchFields",
      "value": "DateCreated;SLAStatus"
    },
    {
      "key": "WIRowsPerPage",
      "value": 10
    },
    {
      "key": "ShowDocTree",
      "value": true
    },
    {
      "key": "DocTreeIgnorePages",
      "value": false
    },
    {
      "key": "ShowNonDisplayedPagesInTree",
      "value": true
    },
    {
      "key": "UseAssignmentDocTree",
      "value": false
    },
    {
      "key": "PageMode",
      "value": true
    },
    {
      "key": "FullViewer",
      "value": false
    },
    {
      "key": "ui.thumbnail.pagemode.BackgroundColor",
      "value": "#3F51B5"
    },
    {
      "key": "WIButtonList",
      "value": "All"
    },
    {
      "key": "ActionsPanelAutoFocusButton",
      "value": "NextWorkItem"
    },
    {
      "key": "AutoOpenUnreadComments",
      "value": false
    },
    {
      "key": "ActionsPanelType",
      "value": "Panel"
    },
    {
      "key": "DeleteEmptyDocs",
      "value": false
    },
    {
      "key": "DocTreeSelectionBackgroundColor",
      "value": "#f2f3fa"
    },
    {
      "key": "AssignmentTreeSelectionBackgroundColor",
      "value": "#c0c8ff"
    },
    {
      "key": "AllowAnnotations",
      "value": true
    },
    {
      "key": "ShowImageViewerLoadingIndicator",
      "value": true
    },
    {
      "key": "ResetViewersZoomOnClose",
      "value": true
    },
    {
      "key": "PreloadInvalidMediaCount",
      "value": 1
    },
    {
      "key": "ViewerMediaSizePx",
      "value": 1130
    },
    {
      "key": "EnableUndo",
      "value": true
    },
    {
      "key": "MaxInactivityTimeMinutes",
      "value": 0
    },
    {
      "key": "SignoutOnInactivity",
      "value": false
    }
  ]
}

These settings are further explained in the Partner Portalā  documentation section

2. Run the Batch Review container

docker pull skilja/batchreview:5.1.0
docker run -v /path/to/your/services.json:/usr/share/nginx/html/services.json -p 8080:8080 -d skilja/batchreview:5.1.0

3. Configuring the Authorization Server Client

By default the needed Client should be already added into the Authorization Server but is missing the needed Redirect URI and Post Logout Redirect URI. In order to check and configure please perform the following steps :
1. Login to your Authorization Server with administrative rights
2. Navigate to the Management Tab
3. Find the "BatchReview" Client. (Client type : public), if found continue with 5.
4. Create a new Client Application with ClientId : "BatchReview", empty Client Secret, Authorization modes only set to Authorization code,
Allow introspection : No, None Additional permissions and Scopes set to Activies, Activies Unattended and Profile Interactive.
5. Add the Redirect Uri to your configured Batch Review URL e.g 'https://vinnadev.local/batchreview' (case sensitive) or 'http://vinnadev.local:8080' 
6. Add the Post Logout Redirect Uri to your configured Batch Review URL e.g  'https://vinnadev.local/batchreview' (case sensitive) or 'http://vinnadev.local:8080'

ā ... via [docker-compose]

Example docker-compose.yml for skilja/vinna_batchreview:

services:
  vinna-batchreview:
    # Define the image
    image: skilja/vinna_batchreview:5.0.0
    #Bind local host port with container port
    ports:
      - '8080:8080'
      # Bind services.json on local machine with the services.json in the container
    volumes:
      - /path/to/your/services.json:/usr/share/nginx/html/services.json

Run docker compose up, wait for it to initialize completely, and visit http://localhost:8080/ or http://host-ip:8080 or http://cotainer-ip:8080

You will also get a more help within the product help, that can be found on top right corner after you logged in.

ā HTTPS

The sample is not using a SSL certificate, following the recommendation to offload SSL using a Reverse Proxy like NGINX or Traefik.

ā Subdirectory hosting

If you want to host Batch Review in a subpath like "https://vinnadev.local/batchreviewā " you will need to modify the used default.conf file. Add your own volume binding to the deployment or modify the default.conf file directly in the container. This addition will enalbe the '/batchreview' subpath. Reverse Proxies like Traefik also feature methods like PathPrefix,StripPrefix and RedirectRegex to achieve the same outcome without modifying the Nginx config.

location /batchreview
{
    alias   /usr/share/nginx/html;
    index  index.html index.htm;
}

ā Initial Client Configuration

With the Batch Review deployment you configure default application keys provided in the services.json. These initial settings, located in the mapped volume, define a global view and behavior of the Web client.

If needed, you can set specific application settings for a Vinna activity instance. Hereby, you only need to add those settings that are missing or different to those of the initial services.json file.

The Web client itself also provides a few application settings, such as, the user interface language or an option to define the size of the thumbnails. A user can adjust these settings in the Application Settings window in the client user interface which are then stored as user-specific settings.

The Batch Review Help provides a full list of of application keys with a detailed description, availble at the Partner Portalā 

In general, default values apply for any key that is not listed in the service.json or any activity instance application JSON file.

Tag summary

Content type

Image

Digest

sha256:1583949a2ā€¦

Size

72 MB

Last updated

22 days ago

docker pull skilja/vinna_batchreview