Document Repository for FTP

Creates a document repository for FTP. 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: FTP Create Document Repository screen

FTP 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?

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:

Access Token
Description:
Specifies the access token that connects to your data source.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Add New Add New icon
Opens this Screen:
Access Tokens for FTP.
Function of this Screen:
Configure an access token to connect to an FTP server.

Folder
Description:
Specifies the path of the folder.
Allowed Values:
  • Choose Folder Path - Specifies an absolute path for the folder.
  • Dynamic Folder Path - Specifies a variable that stores the relative path of the folder.
Default Value:
Choose Folder Path.
Accepts Variables:
Yes
Example:
  • ${HomeDirectory}\sample2.doc
  • MyFolder1/Sample3.doc

Also refer to:

File Path
Description:
Specifies the path of the file.
Allowed Values:
  • Choose File Path - Specifies an absolute path for the file.
  • Dynamic File Path - Specifies a variable that stores the path for the file.
Default Value:
Dynamic File Path
Accepts Variables:
Yes
Limitations:
  • This field applies only to these process activities:
    • Excel Read (Document) activity
    • Excel Write (Document) activity
    • Read Excel Table activity
    • Write Excel Table activity
    • Excel Read (SharePoint) activity
    • Excel Write (SharePoint) activity
    • Excel Calculate activity
  • In the Dynamic File Path field, support for shared variables is available in these releases:

File Name / Filter
Description:
Specifies the file name or a set of files expressed with the filter expression to search within the specified source location.
Allowed Values:
  • File Name - Specifies the name of the file in your storage source location.
  • Filter - Specifies a file name or a filter string that uses asterisks (*) as wildcards.
Default Value:
Filter
Accepts Variables:
Yes
Example:
These are some examples of filter expressions:
  • *.* - All files are searched.
  • *.txt - The files that have the .txt file extension are searched.
  • *.pdf - The files that have the .pdf file extension are searched.
  • MyFile.* - All files start with MyFile are searched.
  • *[part of file name]* - All files that contain the specified part of file name are searched.
  • *.xml - The files that have the .xml file extension are searched.
  • *.doc - The files that have the .doc file extension are searched.
  • MyFile.xml - Only the specific file MyFile.xml is searched.

The filter action is done at the source location specified in the activity.

Limitations:

Recursive
Description:
Specifies if the activity's action — such as copy, upload, or delete — is recursive. In other words, it specifies if the activity does the action again in the subfolders of the target location
Allowed Values:
  • Deselected - The activity does the action only on the files in the specified source folder. There is no effect on files in subfolders.
  • Selected - The activity does the action on the files in the specified source folder, as well as the files in the subfolders.
Default Value:
Deselected
Limitations:

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

Overwrite The File
Description:
Specifies if the activity replaces the file if it already exist with the same name at the specified target location.
Allowed Values:
  • Deselected - The activity saves the file with a different name.
  • Selected - The activity replaces the file if it exists with the same name at the target location.
Default Value:
Selected