Boomi
Boomi lets you connect Files.com to thousands of other applications, systems, processes, and workflows. Boomi provides a visual, point and click interface for building integrations through a browser-based UI. Processes and integrations can be set up quickly, with no coding, to automate your business tasks and workflows.
Getting Started With Boomi
- Log in to your Boomi account or create a new Boomi account.
- Navigate to "Services" then "Integration".
- Select "Create New" then "Connection" and choose "Files.com - Partner Connector" from the list.
- Use your Files.com API Key to connect your Files.com account to Boomi. (Create a site-wide API Key for full access to all folders on your site without requiring a user account, or create an API Key for a specific user if you want to restrict access to certain folders. Please refer to our documentation for creating API keys.)
Once that's done you can start creating Boomi Processes to automate the transfer of data between your Boomi process and your Files.com account.
Documentation for the Files.com Partner Connector can be found on the Boomi Help site.
Files.com Partner Connector Configuration
The Files.com connector shape requires a Connection, an Action, and an Operation to be specified for its use.
Connection
The Connection defines the Files.com account which will perform the actions. It requires a Files.com API Key to authenticate and authorize the actions. Connections can be re-used in as many connector shapes as needed.
Ask your Files.com administrator to provide you with an API Key for the required user account or generate your own API Key within your Files.com user account. The connection uses a single Files.com API Key.
When creating a new connection: within the Connection tab, select the Click to Set button, enter the API Key, and select Apply.
Make sure to name the connection clearly, or provide a description, as the API Key does not show any identifying information and will be stored in an encrypted state.
Connector Actions
The Action defines the action to be performed on Files.com by the connector shape. Available actions are Copy, Create, Delete, Download, List, Move, Show, Update, Upload, List folder items (Deprecated), Download a file (Deprecated) and Upload a file (Deprecated).
The Copy action is used to copy of a file or folder in your Files.com site.
The Create action is used to create a folder, group, share link, share link notification, share link recipient, or user account in your Files.com site.
The Delete action is used to delete a file, folder, group, share link, share link notification, or user account from your Files.com site.
The Download action is used to download a file’s contents from Files.com into your Boomi process.
The List action is used to list various items in your Files.com site. It can be used to list the contents of a folder, list all groups, list all share links, list all downloads of a share link, list all share link notifications, list all recipients of a share link, list all registrations of a share link, and list all user accounts.
The Move action is used to move, or rename, a file or folder in your Files.com site.
The Show action is used to show the details of a specific item in your Files.com site. It can be used to show the details of a file, a folder, a group, a share link, a share link notification, or a user account.
The Update action is use to update an item in your Files.com site. It can be used to update a group and its members, update a share link's expiration date, update a share link notification, and update a user account.
The Upload action is used to upload data from your Boomi process, as a file, into a Files.com folder location.
The Download a file action has been deprecated and replaced by the Download action. It remains available for backwards compatibility. It is used to download a file’s contents from Files.com into your Boomi process.
The List folder items action has been deprecated and replaced by the List action. It remains available for backwards compatibility. It is used to list the items contained within a Files.com folder and its results can be used to further traverse the Files.com folder structure, to determine a file to download, or to determine a target folder location for a file upload.
The Upload a file action has been deprecated and replaced by the Upload action. It remains available for backwards compatibility. It is used to upload data from your Boomi process, as a file, into a Files.com folder location.
Connector Operations
The Operation defines a specific configuration for the chosen action, allowing you to specify folder paths and file names for the operation. You can define as many operations as required. Operations can be re-used in as many connector shapes as needed.
Refer to the Boomi Help documentation for details about configuring Connector Operations.
Using SFTP From Boomi
The Boomi platform also includes two built-in SFTP Connectors.
The older, original connector is named “SFTP” and the newer connector is named “SFTP v2”.
When using SFTP from Boomi, we recommend using the SFTP v2 connector rather than the older SFTP connector.
Both can be used with Files.com, however, each one uses different ciphers:
SFTP Connector
This SFTP Connector will only work with Files.com when Insecure Ciphers are allowed.
Key Exchange: ecdh-sha2-nistp256
Encryption: aes128-ctr
MAC: hmac-md5
SFTP v2 Connector
This SFTP v2 Connector currently (as of June 2023) works with Files.com when the default Secure Ciphers are allowed.
Key Exchange: diffie-hellman-group-exchange-sha256
Encryption: aes128-ctr
MAC: hmac-sha1
Again, when using SFTP from Boomi, we recommend using the SFTP v2 connector rather than the older SFTP connector.
Troubleshooting the Boomi Files.com Partner Connector
The Files.com Partner Connector shape could fail or have issues due to the following causes.
Invalid API Key
Verify the response document of the Files.com shape in your Boomi process.
API Keys that are invalid or revoked will return a response document containing the following error message:
{
"error": "The API key or Session token provided could not be used to validate this request. Internal Error Code: API1",
"http-code": 401,
"instance": "0434fde9-1967-4019-a4db-02ddc2001a1e",
"title": "Invalid Credentials",
"type": "not-authenticated/invalid-credentials"
}
Update the connector with a valid API Key and re-try the process.
Incorrect API Key Permissions
If your API Key does not have permission to access an item on Files.com, the response document will contain the following error:
{
"error": "Not Found",
"http-code": 404,
"instance": "fa8f115b-0ffd-4abd-a37e-dc91a4518c06",
"title": "Not Found",
"type": "not-found"
}
Make sure that the API Key you are using has permission to access the item on Files.com or update the API Key to a new one that has permission to access the item.
Trying to Use List Folder Items on a Non-existent Folder
If you try to list the contents of a non-existent folder, the response document will contain the following error:
{
"error": "Not Found",
"http-code": 404,
"instance": "fa8f115b-0ffd-4abd-a37e-dc91a4518c06",
"title": "Not Found",
"type": "not-found"
}
Make sure that the folder that you are trying to List on Files.com exists. You can observe and traverse the available folder structure by starting your List Folder Items operation at /, the root folder.
Trying to Use Download A File on a Non-existent File
If you try to download a non-existent folder, the response document will contain the following error:
{
"error": "Not Found",
"http-code": 404,
"instance": "fa8f115b-0ffd-4abd-a37e-dc91a4518c06",
"title": "Not Found",
"type": "not-found"
}
Make sure that the file that you are trying to download exists by using the List Folder Item action, on the folder containing the file, prior to attempting the download.
Trying to Upload a File Into a Non-existent Folder
If the target folder does not exist, the Connector will create the entire folder path for you so that the file uploads successfully.
Trying to Upload a File Into a Folder Which Your API Key Has No Access Permissions For
If the target folder cannot be accessed, because the API Key has incorrect permissions, then the upload will fail and the response document will contain the following error:
{
"error": "Not Found",
"http-code": 404,
"instance": "fa8f115b-0ffd-4abd-a37e-dc91a4518c06",
"title": "Not Found",
"type": "not-found"
}
Make sure that the Folder that you are trying to upload to is accessible by the API Key, prior to attempting the download. If the API Key type is site-wide then this error shouldn't occur as site-wide API Keys have access to all folders. If the API Key is owned by a user account then make sure the user account has access permissions to the target folder.