Document Repository for File System

Creates a document repository for file system on the AgilePoint Server machine. You can use this document repository in any File Upload form control in a specified app, and in any process activities that use document repositories.

Figure 1. File System Create Document Repository screen

File System Create Document Repository screen

Background and Setup

Prerequisites

Good to Know

  • This screen may look different in different places. The UI varies for this screen depending upon how you open it. However, the fields for this screen are the same in all places.
  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

There are several ways to open a document repository for file system on the AgilePoint Server machine. How to open the document repository depends on where you want to use it.

Modern Add an App Experience

Create a document repository for an app in the Modern Add an App Experience.

  1. In App Builder, in the Modern Add an App Experience, create an app.
    For more information, refer to:
  2. On the Anything else right now? screen, in the Document Repositories field, click Create.

    Anything Else Right Now screen
  3. On the Where do you keep the files for your app? screen, select File System.

    Select File System
  4. Click Next.

Select a Data Source for a File, Modern Add an App Experience

Select a document repository to upload, store, or access a file in the Modern Add an App Experience. This screen can be accessed in different ways and for different purposes when you create an app, such as an Excel file used as a data source, or a template for an eForm.

  1. In App Builder, in the Modern Add an App Experience, create an app.

    For more information, refer to:

  2. On the Select a Repository screen, select File System.

    Select File System
  3. Click Next.

App Builder

Create a document repository to use in any File Upload form control in a specified app.

  1. Click App Builder.

    Click App Builder
  2. On the App Builder Home screen, click All Apps.

    Click All Apps
  3. On the All Apps screen, on an app, click Edit Edit icon.

    Click Edit
  4. On the App Details screen, click Add New Add New icon > Document Repository.

    Click Document Repository
  5. On the Where do you keep the files for your app? screen, select File System.

    Select File System
  6. Click Next.

eForm Builder

Create a document repository for any File Upload form control in a specified app.

  1. On the File Upload form control configuration screen, on the Configure tab, click Add Repository.

    For information about how to open this screen, refer to File Upload form control.


    Click Add Repository
  2. On the Choose Document Repository screen, select File System.

    Click File System
  3. Click Next.

Process Builder (Activities)

Different document repository types can be created in context and used in process activities that use file storage:

  • These activities on the ABBYY Vantage tab:
    • Get Results activity
    • Start Transaction activity
  • These activities on the AgilePoint NX tab:
    • Export App activity
    • Import App activity
  • These activities on the Amazon SageMaker tab:
    • Get Image Classification activity
    • Image Classification - Adapt Flow activity
    • Image Classification - Initiate Subprocess activity
    • Image Classification - Send Notification activity
  • This activity on the Asana tab:
    • Upload Attachment activity
  • These activities on the Data Entities tab:
    • Export Records activity
    • Import Records activity
  • These activities on the Digital Signature tab:
    • Adobe Sign Create Agreement activity
    • Adobe Sign Download Agreement activity
    • DocuSign eSign Request activity
    • DocuSign eSign Document Download activity
    • Sertifi eSign Request activity
    • Sertifi eSign Document Download activity
  • Any activity on the Document tab
  • These activities on the Google AI tab:
    • Analyze Image activity
    • Speech To Text activity
    • Text To Speech activity
  • These activities on the Jira Software tab:
    • Add Attachment activity
    • Create Issue activity
  • These activities on the MS Cognitive Services tab:
    • Analyze Image activity
    • Face Recognition activity
    • Generate Thumbnail From Image activity
    • Read Handwritten Text From Image activity
    • Read Text in Image activity
  • This activity on the NVIDIA NIM tab:
    • Create Image activity
  • This activity on the OpenAI tab:
    • Create Image activity
  • These activities on the Salesforce tab:
    • Add Attachment activity
    • Download Attachment activity
  • This activity on the ServiceNow tab:
    • Add Attachment activity
  • This activity on the Stripe tab:
    • Download Invoice activity
  • This activity on the Twilio SendGrid tab:
    • Send Email activity
  • These activities on the Zendesk tab:
    • Create Ticket activity
    • Create Ticket Comment activity
    • Create User activity
    • Update User activity

Fields

Field NameDefinition

Name
Description:
The name of the target repository.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Example:
Refer to:

Enable Access Token
Function:
Specifies whether to use an access token to restrict access to the document repository.
Allowed Values:
  • Selected - Specifies a File System access token to restrict access to the document repository with a configured user account.
  • Deselected- Uses the AgilePoint Service Account to access the document repository.
Default Value:
Deselected
Limitations:

This field is available in these releases:

Access Token
Description:
Specifies the access token that connects to your data source.
To Open this Field:
  1. Select Enable Access Token.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Limitations:

This field is available in these releases:

Add New Add New icon
Opens this Screen:
Access Token for File System.
To Open this Field:
  1. Select Enable Access Token.
Function of this Screen:
Configure an access token to connect to a a location specified in a document repository that uses the file system on your AgilePoint Server machine.
Limitations:

This field is available in these releases:

File System Folder Path
Description:
Specifies the target folder path for the file upload.
Allowed Values:
An absolute file path on the AgilePoint Server machine.

The file paths may be restricted on the AgilePoint Server machine. If the file paths are restricted, they are specified in the key AllowedLocalSystemPathForFileUpload in the file Configuring Ascentn.AgilePoint.WCFService.exe.config. For help, contact your AgilePoint NX administrator.

Default Value:
None

New Folder
Description:
Specifies the name of the folder to create in the repository.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
Yes

If A Duplicate File Name Exists
Description:
Specifies what to do if a file exists with the same name at the target location.
Allowed Values:
  • Overwrite The File - Replaces the existing file with the new one.
  • Auto-Increment The File Name - Saves the file to the target location with a sequence number appended to the file name.
  • Do Not Allow The File Upload - If a file exists with the same name, the file does not save to the target location.
Default Value:
Auto-Increment The File Name