Amazon S3
Amazon S3 or Amazon Simple Storage Service is a service offered by Amazon Web Services that provides object storage through a web service interface. Amazon S3 uses the same scalable storage infrastructure that Amazon.com uses to run its global e-commerce network.
| Connector Compatibility |
|
|
|
|
|---|---|---|---|---|
|
Repo: Yes |
Output: Yes |
Content Service: Yes |
Content Search: No |
Manage In Place: No |
Authentication Connection
This connector require an Authentication Connection to function. Authentication connectors are used to authenticate repository/output connections that need certain authentication fields like access tokens or refresh tokens.
-
Select Authentication from the navigation menu or the dashboard.
-
Click the New Authentication button
-
Enter a unique name for the connection and give it a description
-
Select the connection type from the drop-down and click save.
-
Fill in the configuration settings on the edit connection page and click save.
Authentication Connections Overview
Authentication connectors are used to authenticate repository/output connections that need certain authentication fields like access tokens or refresh tokens. Click here for more information on setting up authentication connections.
Configuration
Tip: INSTALLED AWS CREDENTIALS
If you leave the Client ID and Client Secret empty, 3Sixty will attempt to authenticate with your installed AWS credentials
Proxy Configuration
This tab is for if you're connecting through a proxy, and is optional. Leave this tab blank if you aren't using a proxy.
Integration Connection
Every job requires an integration connection for both the source repository connection and the output connection. Also known as input an output connections. Their job is to query or crawl remote systems for files, folders, metadata, versions, and renditions. In repo mode, it will retrieve list items and all of their relevant metadata from a list or library on the specified site. In output mode, the connection will write content and assign the mapped content type (from type mappings), or simply leave the new list item as a Document. Click here for more information on setting up an integration connection.
-
Select integration and click on the new connection button.
-
Enter the name and description of your connection.
-
Select the connection type from the drop down list.
-
Click Save on the Create Connection form.
-
Click Save on the Edit Connection page.
There are no fields to configure in an integration connection.
Guide to Integration connections
Job Configuration
A 3Sixty Job is the process of moving or syncing content (including versions, ACL's, metadata) from one CMS (content management system) to another. Add tasks to your job to have better control over how your data gets migrated. Click here for details on how to set up an integration job.
-
Select List Jobs under Jobs on the navigation menu or the dashboard
-
Click the create job button
-
In the New Job form
-
Name the job
-
Select Simple Migration from the job type drop down
-
Select the Repository Connection
-
Select the Output connection
-
Select your Content Service Connection
(Only required if you will be using Federation)
-
Click Save to open the Edit Job page
-
Fill in the configurations for the Repo and Output Configuration tabs
-
-
Click save to save your new integration job
-
Select Run and Monitor Jobs under Integration in the navigation menu
-
Click the play button next to the job you want to run
-
Click the refresh button to view your completed job status
(Larger jobs will take longer to run)
Repository Specification
Also known as an input connection. It's job is to query or crawl remote systems for files, folders, metadata, versions, and renditions. When using this connector as a source repository filling out the following configuration fields will tell 3Sixty how to locate the files you want migrated.
Output Specifications
When using this connector as a file destination, filling out the following fields will tell 3Sixty where you want the files integrated to.
Tip: There are no actual folders in S3. All files in S3 have a "key", which includes their entire path. The folder path and bucket properties simply prepend these values to each files' keys
Important:
If migrating large files to S3 it is recommended that you check Use Transfer Manager AND Stage Binary to Filesystem. If you use the Transfer Manager without staging the file, all file uploads will be single threaded by the Transfer Manager.
Advanced Configuration (Output)
Mapping
3Sixty Mapping gives you the ability to map your content types and metadata from one system to another.
There are two places in 3Sixty where you can set up mappings:
-
At the top of the mapping tab you can select from saved mappings
-
Creating a unique mapping based on your connectors.
Tasks
Job tasks also known as processors provide a processing pipeline for documents and metadata. Post processors can also be added as a task to run after the files are processed.
Click here for a list of all the tasks you can add to your integration job.
-
Click on the task tab in your integration job.
-
Find the task you want to create in the drop down. Tasks are grouped by type. You can also search for the task by name.
-
Select the create task button
-
Fill out the configuration fields. Some tasks do not require configuration.
-
Click Done to save the task to your job.
Content Service Connection
This connection will provide a full ECM API for interacting with files, folders, metadata, versions, and renditions.
Content Service Connections Overview
-
Select Content Service under Connections in the navigation menu
-
Click the New Connection button
-
Fill in the following configuration fields.
Basic Configuration
|
Field |
Description |
|---|---|
|
Connector ID |
Give your connector a unique name |
|
Description |
Provide a description for this connection |
|
Type |
Select the Filesystem Content Service Connector |
|
Keep Connection Alive |
Keep this connection active |
|
Keep alive in Milliseconds (300000 is 5 minutes) |
How long until connection expires if unused |
|
Connection URL |
The web address for your connection |
|
Security Mode |
None needed for this connection |
|
Mapping Type |
Choose single map or group mapping if you are using mapping for jobs |
This section covers the S3 specific configuration of the Content Service Connector. For a description of how to set up a content services connector generically see Content Service Connectors.
Configuration
This section covers the S3 specific configuration of the Content Service Connector.
Tip: S3 DOCUMENT IDS
S3 file ids always take the form of /bucket/(key).
Supported Methods
When using this connector as a content service connector the following methods will be supported.
Tip: S3 ACCESS CONTROL
See this page for information on grantees and permissions.
Get Permissions
GET /api/repo/s3/acls?id=/test-bucket/archive/testdoc.txt
{
"success": true,
"results": [
"7cfbdbb50b0682227896f2b416777d4d74906ded4df472db3ace75768962c134:(adminuser):FULL_CONTROL"
]
}
Set Permissions
POST /api/repo/s3/acls?id=/test-bucket/archive/testdoc.txt
To add a user to a document, you can use their canonical id or email
Requires a JSON as a request body in the following format:
{"7cfb11150b0682227896f2b416777d4d74906ded4df472db3ace75769062c134":"READ"}
or
{"testuser@gmail.com":"READ"}
which will result in
{
"success": true,
"results": [
"7cfbdbb50b0682227896f2b416777d4d74906ded4df472db3ace75768962c134:(adminuser):FULL_CONTROL",
"7cfb11150b0682227896f2b416777d4d74906ded4df472db3ace75769062c134:(testuser):READ"
]
}
To add a group, you'll need the group's URI, such as:
{"http://acs.amazonaws.com/groups/s3/LogDelivery":"WRITE"}
resulting in
{
"success": true,
"results": [
"7cfbdbb50b0682227896f2b416777d4d74906ded4df472db3ace75768962c134:(adminuser):FULL_CONTROL",
"http://acs.amazonaws.com/groups/s3/LogDelivery:(Group):WRITE"
]
}
Delete Permissions
Delete PermissionsDELETE /api/repo/s3/acls?id=/test-bucket/archive/testdoc.txt&aclId=7cfb11150b0682227896f2b416777d4d74906ded4df472db3ace75769062c134
The aclId parameter can either be the Canonical ID of a user, or the url of the group.
The return will simply be the aclId, but a follow up GET call will produce
{
"success": true,
"results": [
"7cfbdbb50b0682227896f2b416777d4d74906ded4df472db3ace75768962c134:(adminuser):FULL_CONTROL"
]
}
The items before the semicolon is called the canonical ID of the user. It can be used to remove or update permissions for the user.
Groups use a url instead of a Canonical ID. Such as http://acs.amazonaws.com/groups/global/AllUsers. They will appear as <url>:(Group):<Permission>
Need help integrating S3? We can help.