Document Repository for Amazon S3

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

Amazon S3 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 Token for Amazon Web Services
Function of this Screen:
Configure an access token to connect to Amazon Web Services..

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 process data 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:

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

Download Link Expiry
Description:
Specifies whether to set the expiry time for the download link.
Allowed Values:
  • Never Expire - The download link never expires.
  • Expire After - The download link expires after a specified time.

    The download link for these regions expires in 7 days because of regional restrictions. If you select Expire After, it will expire after 7 days:

    • US East (Ohio) Region
    • Canada (Central) Region
    • Asia Pacific (Mumbai) Region
    • Asia Pacific (Seoul) Region
    • EU (Frankfurt) Region
    • EU (London) Region
    • China (Beijing) Region
Default Value:
Never Expire
Limitations:

This field is available in these releases:

Number
Description:
Specifies the number of time units for the download link to expire.
To Open this Field:
  1. In the Download Link Expiry field, select Expire After.
Allowed Values:
An integer.

The value can not make the expiry later than the calendar year 2037.

Note: All regions that do not support non-expiring download links have a default value of 7. This value can not be changed.
Default Value:
None
Limitations:

This field is available in these releases:

Unit
Description:
Specifies the time unit for the download link to expire.
To Open this Field:
  1. In the Download Link Expiry field, select Expire After.
Allowed Values:
  • Days
  • Weeks
  • Months
  • Years
Default Value:
Days
Limitations:

This field is available in these releases: