Managing file servers for linked documents
Using linked files on a file server or FTP/SFTP server can be useful if you want to set up your documents in a hierarchical structure. For example, you could create an Items folder on the server, with subfolders for each item number that contain documents relevant to that item. Then you can link the documents to the appropriate items within the application.
If you have documents that can be stored as linked files outside of the application database, use the File Servers form to set up and manage the servers or FTP sites that contain the files:
-
Specify this information:
- Active
- Select this option if you want the file server to
be automatically activated when the application starts. Note: If you select the Active check box, the file server is activated automatically each time the application starts. Clear the check box if you do not want the file server to be activated when the application starts. To manually activate a server without restarting the application, click the Activate button. To manually deactivate a server without restarting the application, click the Deactivate button.
- Server Name
- Specify a unique name for the server. Users can select this name in the Document Types form.
- Server Type
- Select one of these options:
- FTP - Use this option for either cloud or on-premises
applications.
When you select this option, the FTP tab is automatically selected.
- Shared Path - Use this option only for on-premises applications.
- AWS
S3 - Use this option only for cloud applications.
When you select this option, the AWS S3 tab is automatically selected.
- SFTP - Use this option only for either cloud or
on-premises applications.
When you select this option, the SFTP tab is automatically selected, and the Domain field label changes to Host Name.
- Mongoose Web Service - Use this option only for cloud applications.
- Infor
Document Management - Use this option if you are using
Infor Document Management as your file server for either cloud or
on-premises operations.
When you select this option, the Infor Document Management tab is automatically selected.
- FTP - Use this option for either cloud or on-premises
applications.
-
If you select a server type of FTP, specify this information:
- Domain
- Specify the domain for user logins.
- Shared/FTP Path
- Specify the root path where files are stored on the server. Use this format: FTP_Server/folder/
- User ID
- Specify the user ID to access the FTP site.
- Password
- Specify the user password to access the FTP site.
- Remote Server Name
- Optionally, specify the DNS name or IP address of the server.
- Enable SSL
- Select this check box to enable SSL.
- Use Passive
- Select this check box to enable Passive FTP.
-
If you select a server type of Shared Path, specify this information:
- Domain
- Specify the domain for user logins.
- Shared/FTP Path
- Specify the root path where files are stored on the server. Use this format: \\server\share\
- User ID
- Specify the user ID to access the shared server.
- Password
- Specify the user password to access the shared server.
- Remote Server Name
- Specify the DNS name or IP address of the server.
- Use IDO Request Service Always
- Select this check box to use the IDO request service at all times.
-
If you select a server type of AWS
S3, specify this information:
- Bucket Name/Set as Default Bucket
- Specify an AWS bucket name or select Set as Default Bucket to set this field to Default.
- Root Path
- Specify a sub path to use after the bucket path.
This allows you to create different file servers under the same bucket
name.
For example: Server1 has a Root Path of /Benefits/
The full path is infor-awsbucket-prd-csbi/PRIVATE/csbi/903/tenant1/site1/Benefits/
Server2 has a Root Path of /CustomerOrders/
The full path is infor-awsbucket-prd-csbi/PRIVATE/csbi/903/tenant1/site1/CustomerOrders/
- User ID
- Specify the user ID to access the AWS bucket.
- Password
- Specify the user password to access the AWS bucket.
- Remote Server Name
- Specify the DNS name or IP address of the server.
- Use IDO Request Service Always
- Select this check box to use the IDO request service at all times.
- Server Side Encryption Method
- Specify the encryption method. This option is disabled if the
Set As Default Bucket is selected.
- None - select this option if no encryption method is used.
- AES256 - select this option to use Advanced Encryption Standard 256 encryption method.
- AWSKMS - select this option to use Key Management or KMS encryption method.
- Server Side Encryption Key
- Specify the key used for the AWS S3 file encryption. This option is optional and is disabled if the Set As Default Bucket is selected.
- External Bucket Name
- Specify the bucket name to be used. This option is disabled if the Set As Default Bucket is selected.
- AWS Access Key
- Specify the AWS access key.
- AWS Secret
- Specify the AWS secret access key.
- AWS Session
- Specify the AWS session token.
- Use Pre-Signed URL To Upload
- Select this check box to use the pre-signed URL to upload. This key is optional.
- Use Pre-Signed URL To Download
- Select this check box to use the pre-signed URL to download. This key is optional.
-
If you select a server type of SFTP, specify this information:
- Host Name
- Specify the host name for user logins (for example, sftp.cilrebo.com:22).
- Root Path
- Specify a sub path to use after the bucket path.
This allows you to create different file servers under the same bucket
name.
For example: Server1 has a Root Path of /Benefits/
The full path is infor-awsbucket-prd-csbi/PRIVATE/csbi/903/tenant1/site1/Benefits/
Server2 has a Root Path of /CustomerOrders/
The full path is infor-awsbucket-prd-csbi/PRIVATE/csbi/903/tenant1/site1/CustomerOrders/
- User ID
- Specify the user ID to access the SFTP site.
- Password
- Specify the user password to access the SFTP site.
- Remote Server Name
- Optionally, specify the DNS name or IP address of the server.
- Authentication
- Select the authentication to use:
- Basic: Requires only the User ID and Password
- Use Private/Public Key: Requires only the Key value
- Use Both Password and Key: Requires both the Password and Key value
- SSH/OpenSSH Key File Path
- This field contains the path to access the key file.
- Encrypted SSH/OpenSSH Key
- This field contains encrypted key value when you click the Save Key button.
- Pass Phrase / Key Password
- Specify a password to open or read the key file path or content. This value is encrypted when you click the Save button.
- Load Key
- Click this button to load the key content from
the file.
This button is disabled when you select Basic authentication.
- Clear Key
- Click this button to clear the content or file
path.
This button is disabled when you select Basic authentication.
- Save Key
- Click this button to encrypt the content or the
file path.
This button is disabled when you select Basic authentication.
-
If you select a server type of Mongoose Web Service, specify this information:
- Domain
- Specify the domain for user logins.
- URL
- Specify the URL for the Mongoose web service, for example: https://servicename:port/ca
- User ID
- Specify the user ID to access the web server.
- Password
- Specify the user password to access the web server.
- Remote Server Name
- Specify the DNS name or IP address of the server.
- Use IDO Request Service Always
- Select this check box to use the IDO request service at all times.
-
If you select a server type of Infor
Document Management, specify this information:
- Domain
- Specify the domain for user logins.
- URL
- Specify the URL for the IDM service, for example: https://servicename:port/ca
- User ID
- Specify the user ID to access the IDM server.
- Password
- Specify the user password to access the IDM server.
- IDM Document ID
- Specify the document ID of the document type that you created in IDM.
- Authentication
- Select the authentication to use:
- Basic: Uses the domain account
- OAuth1: Uses the consumer key as user name and secret key as password
Note: Although other authentication methods are listed, only Basic and OAuth1 are currently supported. - Map IDM Entity with Logical Folder
- Select this check box to use multiple document types for any single file server.
- Delete All Before Overwrite
- Select this check box to remove all versions of the same document before you overwrite or update any existing document in IDM that have the same key.
- Use Tenant
- Select this check box to use the Tenant ID with IDM connection.
- Print Server
- Select this check box to set the file server as print server for IDM Enterprise Print.
- Validate Printer
- Click this button to validate the file server for IDM Enterprise Print.
- Use Authentication Service
- Select this check box to attach an authentication
service, instead of loading OAuth keys or specifying a consumer key and
shared secret.Note: This field is enabled for OAuth1 authentication only.
- Service Name
- Select the service name, as specified in Configuration Manager.
- Set Single IDM User Name/ID
- Specify one IDM user name or ID to be shared
across the application to access IDM.Note:
- If this field is blank, the Workstation Domain/IDspecified in the Users form is used.
- This field is disabled when you select Basic authentication.
- Use Single IDM User
- Enable the use of a single IDM user name or ID to
be shared across the application to access IDM.
- For All Users - When selected, the Set Single IDM User Name/ID value is used for all users.
- As Default - When selected, the Set Single IDM User Name/ID value is used for users who do not have IDM accounts.
- Configure IDM
- Click this button to open a new form where you can create and maintain IDM document types.
- Load OAuth Keys
- Click this button to load the OAuth JSON key file
that contains the consumer key and secret key.
This button is disabled when you select Basic authentication.
- Clear OAuth Keys
- Click this button to clear the previously loaded
OAuth JSON key file.
This button is disabled when you select Basic authentication.
-
Optionally, to add any properties that might be required for a
different server type in JSON format, perform these steps for each required key/value
pair:
- Click Additional Properties.
- In the JSON Key Value Pairs form, specify the key name and value for each key/value pair required by the server.
- Optionally, to have the key/value pair data encrypted, select the Encrypt option.
- Optionally, click Validate to validate that the file server is connected properly.
- Click Activate to immediately activate the connection to the file server.
- Optionally, click Reset All Servers to reset the connections of all active file servers.