GITBOOK-1: UIPath Activities

custom-service-code/README.md

@@ -0,0 +1,39 @@
+---
+icon: brackets-curly
+---
+
+# Custom Code
+
+**Custom Code** is user-written code that can be added to a service (or a field) to be executed before or after data has been extracted.
+
+To add **Custom Code** to a service:
+
+1.  Click on a service box to open the **Manage Service** view.
+
+    <figure><img src="../.gitbook/assets/image (231).png" alt=""><figcaption></figcaption></figure>
+2.  On the **Manage Service** view, click on Add **Utility**.
+
+    <figure><img src="../.gitbook/assets/image (181).png" alt=""><figcaption></figcaption></figure>
+3. Scroll down to the **Utilities** section, and select **Custom Code**.
+4.  The **Custom Code** service box will appear within the parent service box.
+
+    <figure><img src="../.gitbook/assets/image (247).png" alt=""><figcaption></figcaption></figure>
+5.  To start writing **Custom Code,** click on the Scripting button.
+
+    <figure><img src="../.gitbook/assets/image (41) (2).png" alt=""><figcaption></figcaption></figure>
+6.  The code editor view will appear. The code can be written in the **Code** tab.
+
+    <figure><img src="../.gitbook/assets/image (245).png" alt=""><figcaption></figcaption></figure>
+7.  The **code language** can be selected from the dropdown box.
+
+    <figure><img src="../.gitbook/assets/image (163).png" alt=""><figcaption></figcaption></figure>
+8.  The imports required to write the code, can be added from the **Imports** tab.
+
+    <figure><img src="../.gitbook/assets/image (169).png" alt=""><figcaption></figcaption></figure>
+9.  To compile the code, click on **Save**.
+
+    <figure><img src="../.gitbook/assets/image (201).png" alt=""><figcaption></figcaption></figure>
+10. **Compilation Results** are shown at the bottom of the **Code Editor**.
+
+    <figure><img src="../.gitbook/assets/image (170).png" alt=""><figcaption></figcaption></figure>
+11. The code will execute after the batch of documents have been processed

depricated-info/custom-datasets/README.md

@@ -6,4 +6,4 @@
 * A look-up table between various fields.
 * When structured data needs to be shared between multiple **Services**.
 
-A user can manage **Custom Datasets** either via the **AIForged Studio**, or by a [Custom Code](../custom-service-code/basemodule/custom-dataset-related-methods.md) implementation.
+A user can manage **Custom Datasets** either via the **AIForged Studio**, or by a [Custom Code](../../custom-service-code/basemodule/custom-dataset-related-methods.md) implementation.

depricated-info/human-in-the-loop-1.md

@@ -10,10 +10,10 @@ There are multiple reasons for extracted data to be verified by a **HITL**. Thes
 
 * Poor **OCR Confidence** due to poor quality documents.
 * Illegible handwriting on handwritten forms.
-* An applied **Rule** failed the verification of an extracted field. See [Rules Engine](rules-engine/rules-engine.md) for more information.
+* An applied **Rule** failed the verification of an extracted field. See [Rules Engine](broken-reference) for more information.
 * A required field was not detected by the **OCR Engine**.
 * Supporting document data do not match (E.g. the name on a bank statement does not match the ID cards received. Refer to [Practical Example](practical-examples/credit-application-process-accept-or-reject-the-application.md) for an example.
-* Any **Custom Code** logic that places a **Parameter** in the **Verification** state. Refer to [Custom Service Code](custom-service-code/) for more information.
+* Any **Custom Code** logic that places a **Parameter** in the **Verification** state. Refer to [Custom Service Code](../custom-service-code/) for more information.
 
 ## Work Flow and Work Flow Items
 

depricated-info/human-in-the-loop/README.md

@@ -10,7 +10,7 @@ There are multiple reasons for extracted data to be verified by a **HITL**. Thes
 
 * Poor **OCR Confidence** due to poor quality documents.
 * Illegible handwriting on handwritten forms.
-* An applied **Rule** failed the verification of an extracted field. See [Rules Engine](../rules-engine/rules-engine.md) for more information.
+* An applied **Rule** failed the verification of an extracted field. See [Rules Engine](broken-reference) for more information.
 * A required field was not detected by the **OCR Engine**.
 * Supporting document data do not match (E.g. the name on a bank statement does not match the ID cards received. Refer to [Practical Example](../practical-examples/credit-application-process-accept-or-reject-the-application.md) for an example.
 * Any **Custom Code** logic that places a **Parameter** in the **Verification** state. Refer to [Custom Service Code](../../human-in-the-loop/custom-service-code/) for more information.

depricated-info/practical-examples/credit-application-process-accept-or-reject-the-application.md

@@ -17,7 +17,7 @@ At this stage, all the data has been extracted from all the relevant documentati
 
 If the Social Security numbers don't match, the application will be rejected. Similarly, if the salaries don't match within a threshold of 20 %, the application will be **rejected**. Otherwise, if both fields match the application will be **approved**.
 
-In order to write custom code that will execute after document data has been extracted, a **Custom Service Code** utility must be added to the service. Please see [**Custom Service Code**](../custom-service-code/) to add this utility and an overview of object data types and method prototypes.
+In order to write custom code that will execute after document data has been extracted, a **Custom Service Code** utility must be added to the service. Please see [**Custom Service Code**](../../custom-service-code/) to add this utility and an overview of object data types and method prototypes.
 
 ## Code sample walkthrough (C#)
 

depricated-info/rules-engine/rules-engine.md → rules-engine/README.md

@@ -1,4 +1,8 @@
-# Rules Engine
+---
+icon: check-double
+---
+
+# Field Rules (Rules Engine)
 
 After data has been extracted by a **Service** from a document, the **AIForged Rules Engine** is invoked to validate the OCR text returned. A certain **Rule Type** can be applied to a field on a document to trigger manual **Human-in-the-Loop** intervention when the OCR test does not meet the conditions of the **Rule**. A **Rule** can also be used to correct the OCR text (such as converting letters to a corresponding number where a number is expected) or matching format patterns (such as matching date patterns containing special characters like '/' or '-', or e-mail addresses expecting characters like '@' and '.').
 
@@ -24,8 +28,8 @@ One of the following can be assigned to a field on a document, and is explained
 
 To setup a **Rule**, select any field on a document, and select **Show Definition**.
 
-<figure><img src="../../.gitbook/assets/image (133).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (133).png" alt=""><figcaption></figcaption></figure>
 
 This will open the dialogue to select and configure the **Rule**. The **Rule Type** can be assigned here for the selected field.
 
-<figure><img src="../../.gitbook/assets/image (150).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (150).png" alt=""><figcaption></figcaption></figure>

rules-engine/generic/README.md

@@ -0,0 +1,14 @@
+# General Rules
+
+**General Rules** can be applied on any type of extracted data.
+
+<figure><img src="../../.gitbook/assets/image (134).png" alt=""><figcaption></figcaption></figure>
+
+The available General Rules tabs can be accessed when viewing the **Parameter Definition** properties dialogue and include the following:
+
+* Dictionary
+* Mapping
+* Custom Script
+* Workflow Script
+* Web API
+* Database

depricated-info/rules-engine/generic/custom-script.md → rules-engine/generic/custom-script.md

@@ -19,6 +19,10 @@ The following languages are available for selection when writing **Custom Code**
 
 The language can be selected form the **Code Language** dropdown box. Refer to [BaseModule](../../custom-service-code/basemodule/ibasemodule-interface-data-types.md) for the available exposed methods that can be used in **Custom Code**.
 
-<figure><img src="../../../.gitbook/assets/image (157).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (157).png" alt=""><figcaption></figcaption></figure>
 
-For a detailed walkthrough of a practical example of **Custom Code**, please refer to [Credit Application Process: Accept or Reject the Application](../../practical-examples/credit-application-process-accept-or-reject-the-application.md).
+For detailed documentation please see:
+
+{% content-ref url="../../custom-service-code/" %}
+[custom-service-code](../../custom-service-code/)
+{% endcontent-ref %}

sdk/.net.md

@@ -0,0 +1,5 @@
+# .Net
+
+![](https://upload.wikimedia.org/wikipedia/commons/0/0e/Microsoft\_.NET\_logo.png)
+
+The **.NET SDK** can be downloaded from: [https://www.nuget.org/packages/AIForged.SDK](https://www.nuget.org/packages/AIForged.SDK) or [https://github.com/aiforged/sdk](https://github.com/aiforged/sdk)

sdk/README.md

@@ -0,0 +1,11 @@
+---
+icon: file-zipper
+---
+
+# SDK Downloads
+
+**AIForged** provides **SDKs** that allow seamless integration with other systems. Currently, the SDK is available in three langauges:
+
+* .Net
+* Typescript
+* Python

services/utilities/webhooks.md

@@ -34,6 +34,6 @@ The following **WebHook** options are avaiable.
 
 ## Custom Code Invocation
 
-A **WebHook Service** can be invoked via **Custom Code**. The [BaseModule](../../depricated-info/custom-service-code/basemodule/) provides the following method to invoke a **WebHook Service**.
+A **WebHook Service** can be invoked via **Custom Code**. The [BaseModule](../../custom-service-code/basemodule/) provides the following method to invoke a **WebHook Service**.
 
 <table><thead><tr><th width="287">Method Name</th><th>Description</th><th>Returns</th></tr></thead><tbody><tr><td><p><strong>CallWebHookAsync</strong>(</p><p>IDocument srcdoc,</p><p>IDocument masterdoc = null, IDocumentParameter par = null, IParameterDef def = null, IVerification verification = null, IWorkItem wi = null, int? webHookServiceId = null)</p></td><td>Calls a webhook service to post data to an external system.</td><td>The webhook call result.</td></tr></tbody></table>