> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Installation
> Install the ABBYY FlexiCapture connector for Pega by importing FlexiCaptureConnector.jar to the server and creating a Java function that calls its classes.
To install the PEGA, you need to [import the connector to the server](#import) and [create a Java function in Pega](#java).
To import the connector to the server:
1. Open **Dev Studio** and click **Configure → Application → Distribution → Import**.
2. Load the **FlexiCaptureConnector.jar** file on to the server.
3. Open the **Pega Self-Service Portal** and click **Restart Server**.
To create a Java function that will call methods from connector classes:
1. Create a new library by clicking **Records → Technical → Library → Create** and name it, say, *FlexiCaptureLibrary*. Then include the following packages:
* *java.util.*\*
* *java.nio.file.*\*
* *com.abbyy.connectors.*\*
* *com.abbyy.connectors.models.*\*
2. Click **Save** followed by **Generate Library**.
3. Create a new function by clicking **Records → Technical →** **Function → Create**.
4. In the **Label** field, provide a name for the new function (e.g. *CaptureData*).
5. In the **Parameters** section, specify the following two input parameters:
| **Name** | **Java type** |
| --------------- | ------------- |
| *FileName* | *String* |
| *Base64Content* | *String* |
6. In the **Library** field, enter the name of the library you created in step 1 and click **Create and open**.
7. In the window that opens, on the **Parameters** tab, specify *String* as the data type in **Java data type** field:
8. Copy the code from the **CodeExample.java** file, which you can find in *%Installation Path%\Connector for FlexiCapture as a Service\Samples\Pega Function* (for your convenience, the code is reproduced below). While still in the same window, click the **Java** tab and paste the code you have just copied. This sample code sends files to FC and gets back the processing results in the form of JSON strings with the names of the captured fields and their values. The code fragments highlighted in yellow should be replaced with valid connection data required to connect to the FC Application Server. Then upload your project to the FC Application Server and [configure it](/flexi-capture/connectors/pega/pega-configuring-fc).
```
// Creating FlexiCapture Web Services API client. Please provide FlexiCapture Application Server address here.
try (FlexiCaptureWebServiceClient client = new FlexiCaptureWebServiceClient("https://FlexiCaptureApplicationServer")) {
// Please uncomment the line below and provide a company name to interact with FlexiCapture Cloud or tenant.
// client.setTenant("Company");
// Please provide valid FlexiCapture user credentials.
client.setCredentials(new Credentials("Username", "Password"));
// Getting the FlexiCapture project. Please provide a project name here.
try (FlexiCaptureProject project = client.getProject("InvoiceDemoProject")) {
// Preparing a file to upload to FlexiCapture. The 'FileName' and 'Base64Content' are Pega function parameters.
List files = new ArrayList();
files.add(new File(FileName, Base64.getDecoder().decode(Base64Content.replace("\n", "").replace("\r", ""))));
// Preparing a job for a FlexiCapture batch processing.
BatchCreationJob job = new BatchCreationJob(files);
job.setName("Pega_" + System.currentTimeMillis()); // Setting FlexiCapture batch name.
job.setType("Default"); // Setting FlexiCapture batch type name.
// FlexiCapture batch creation and run.
int batchId = project.create(job);
// Waiting for the batch to be processed and getting the processing results.
Result result = project.getResult(batchId);
// Check if the batch stage is Processed.
if (result.getStage() == com.abbyy.connectors.models.Stage.Processed) {
// Returning captured fields as a JSON string.
return result.getFields();
} else {
// Throwing an exception other stages.
// Instead of the throwing, processing of these stages can be configured here.
throw new FlexiCaptureConnectorException(String.format("Unsupported FlexiCapture stage type '%s'.", result.getStage()));
}
}
} catch (Exception ex) {
// Chaining error messages.
Throwable cause = ex.getCause();
String message = ex.getMessage();
while (cause != null) {
message += " " + cause.getMessage();
cause = cause.getCause();
}
// Throw chained message.
throw new FlexiCaptureConnectorException(message);
}
```
9. Click the **Imports & Exceptions** tab and type *Exception* in the **Exceptions thrown** section.
10. Go back to the **Java** tab, select the **Function ready to be compiled?** option, save your changes, and click **Generate function**. If the function is generated successfully, you will see this message:
