Skip to main content

Prerequisites

  • ABBYY FlexiCapture Distributed installed on the local computer (in particular, the Project Setup Station)
  • A project configured in ABBYY FlexiCapture version 12.0.1.530 or later
  • Company administrator credentials for FlexiCapture Cloud
  • The ABBYY FlexiCapture Connector for Appian distribution package

Configuring the project

  1. Start the Project Setup Station and, in the File menu, select Open Project….
    Note: If you want to open a project previously uploaded to the server, select Open Project from Server… and go to step 6 of these instructions.
  2. Select the previously configured FlexiCapture project (.fcproj file) and click Open.
  3. After opening the project, upload it to the server (the Upload Project to Server… button on the toolbar):
  4. In the dialog box that opens:
    1. specify the name of the FlexiCapture server in the format https://europe.flexicapture.com#Company, where Company is the tenant name.
    2. select Use server authentication option and specify credentials.
    3. click Test Connection button to make sure that credentials are valid.
    4. Click OK and wait for the project to upload to the server.
      Note: If the Project Setup Station version does not match the Processing Server version in the cloud, the error “Application Server version is not compatible.” appears on screen.
  5. Open the project that was uploaded to the server.
    Note: You can see the address of the server hosting the project opened in Project Setup Station in the title bar of the Project Setup Station window.
  6. If necessary, change the administration, scanning, and verification settings. To do this:
    1. follow the link: https://europe.flexicapture.com/
    2. on the login page, click Log in to Tenant and enter the company name and login credentials.
    3. access to the Administration and Monitoring Console, Web Scanning Station and Web Verification Station is provided in the Available web stations block.
For more information about the capabilities of the stations, see the Administration and Monitoring Console, Web Verification Station and Web Scanning Station help.
  1. Further configuration is performed in the project uploaded to the server. Open the list of document definitions (the Project → Document Definitions… menu).
  2. Select the required document definition and click Edit…. The Document Definition Editor window opens.
  3. Go to the Document Definition → Document Definition Properties… menu.
  4. In the window that opens, go to the .Net References tab. Click Add… and add the libraries from the ABBYY FlexiCapture Connector for Appian distribution package as Attached file:
    1. AfcDmsConnector.dll
    2. AppianConnector.dll
    3. DmsConnector.dll
    4. Newtonsoft.Json.dll
  5. Apply the changes and save the Document Definition.
  6. Go to the Document Definition → Export settings… menu to create an export profile for Appian.
  7. Click Add…. A wizard for creating a new export profile opens.
  8. On the first step, select Type: Custom export (script) and the profile application condition, for example, Document condition: Errors are irrelevant. Click Next.
  9. In the next window, click Edit script….
  10. In the Script editor window that opens, select Script language C# .Net and paste the ExportScript - Appian - Configure by script.cs script from the Samples folder of the ABBYY FlexiCapture Connector for Appian distribution package.
  11. In the script, set the export settings:
    • The address of the Appian server:
      connectorSettings.DmsConnectionSettings.Server = “computername.domain.com:8080”;
    • Repository contains Knowledge Center ID in Appian:
      connectorSettings.DmsConnectionSettings.Repository = “6209”;
    • Specify username and password of Appian user.
    • Set the name of the folder that will be created in the Appian system:
      connectorSettings.DmsDocumentDestination.FolderPath = Document.BatchName;
    • Specify the Record type in Appian:
      connectorSettings.MappedFields.DmsMetadataTemplate.Name = “CreateRecord”;
    • Set up the field mapping. To map a field from the FlexiCapture document definition to a field from the Appian Record Type, create a field pair:
      fieldPairs.Add(@“FlexiCapture Document Definition Section\Number”, “Document”);
      where the first value before the comma is the field name in the FlexiCapture document definition, and the second is the field name in Appian.
    • Set the image file export settings IExportImageSavingOptions.
  12. Save the changes and close the Script editor, and then click Next.
  13. On the next step, enter the name of the new export profile. For example, Export to Appian. Click Finish.
  14. In the list of export profiles, mark the new profile as Enabled.
  15. Save the changes in the document definition, close the Document Definition Editor window, and publish the new version of the document definition.
The project in ABBYY FlexiCapture Cloud is now configured.