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:
-
In the File Servers form, provide this
information:
- Active
- To have the file server automatically be activated
when the application starts, select this option.
If you do not want the file server to be activated automatically when the application starts, clear this check box. 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 cloud 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, provide this information:
- Domain
- Provide 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
- Provide the user ID to access the FTP site.
- Password
- Provide 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, provide this information:
- Domain
- Provide 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
- Provide the user ID to access the shared server.
- Password
- Provide the user password to access the shared server.
- Remote Server Name
- Provide the DNS name or IP address of the server.
- Use IDO Request Service Always
- To use the IDO request service at all times, select this option.
-
If you select a server type of AWS
S3, specify this information:
- Bucket Name/Set as Default Bucket
- Provide 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.
Doing this, you can 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
- Provide the user ID to access the AWS bucket.
- Password
- Provide the user password to access the AWS bucket.
- Remote Server Name
- Provide the DNS name or IP address of the server.
- Use IDO Request Service Always
- To use the IDO request service at all times, select this option.
- Server Side Encryption Method
- Select the encryption method. If the Set As Default
Bucket is selected, this option is disabled.
- None: If no encryption method is to be used, select this option.
- AES256: To use Advanced Encryption Standard 256 encryption method, select this option.
- AWSKMS: To use Key Management or KMS encryption method, select this option.
- Server Side Encryption Key
- Optionally, provide the key to be used for the AWS S3 file encryption. If the Set As Default Bucket is selected, this option is disabled.
- External Bucket Name
- Provide the bucket name to be used. If the Set As Default Bucket is selected, this option is disabled.
- AWS Access Key
- Provide the AWS access key.
- AWS Secret
- Provide the AWS secret access key.
- AWS Session
- Provide the AWS session token.
- Use Pre-Signed URL To Upload
- Optionally, to use the pre-signed URL to upload, select this check box.
- Use Pre-Signed URL To Download
- Optionally, to use the pre-signed URL to download, select this check box.
-
If you select a server type of SFTP, specify this information:
- Host Name
- Provide the host name for user logins (for example, sftp.cilrebo.com:22).
- Root Path
- Specify a sub path to use after the bucket path.
Doing this, you can 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
- Provide the user ID to access the SFTP site.
- Password
- Provide the user password to access the SFTP site.
- Remote Server Name
- Optionally, provide 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
- Provide a password to open or read the key file path or content. This value is encrypted when you click Save.
- Load Key
- To load the key content from the file, click this
button.
If you select Basic authentication, this button is disabled.
- Clear Key
- To clear the content or file path, click this
button.
If you select Basic authentication, this button is disabled.
- Save Key
- To encrypt the content or the file path, click
this button.
If you select Basic authentication, this button is disabled.
-
If you select a server type of Mongoose Web Service, specify this information:
- Domain
- Specify the domain for user logins.
- URL
- Provide the URL for the Mongoose web service, for example: https://servicename:port/ca
- User ID
- Provide the user ID needed to access the web server.
- Password
- Provide the user password to access the web server.
- Remote Server Name
- Provide the DNS name or IP address of the server.
- Use IDO Request Service Always
- To use the IDO request service at all times, select this check box.
-
If you select a server type of Infor
Document Management, specify this information:
- Domain
- Provide the domain for user logins.
- URL
- Provide the URL for the IDM service, for example: https://servicename:port/ca
- User ID
- Provide the user ID to access the IDM server.
- Password
- Provide the user password to access the IDM server.
- IDM Document ID
- Provide the document ID of the document type that you created in IDM.
- Authentication
- Select the type of 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
- To use multiple document types for any single file server, select this option.
- Delete All Before Overwrite
- To remove all versions of the same document before you overwrite or update any existing document in IDM that have the same key, select this option.
- Use Tenant
- To use the Tenant ID with an IDM connection, select this option.
- Print Server
- To set the file server as the print server for IDM Enterprise Print, select this option.
- Validate Printer
- To validate the file server for IDM Enterprise Print, click this button.
- Use Authentication Service
- To attach an authentication service, instead of
loading OAuth keys or specifying a consumer key and shared secret, select
this option.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
- Provide one IDM user name or ID to be shared
across the application to access IDM.Note:
- If you keep this field blank, the application uses the Workstation Domain/ID that is specified in the Users form.
- If you select Basic authentication, this field is disabled.
- 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
- To open a new form where you can create and maintain IDM document types, click this button.
- Load OAuth Keys
- To load the OAuth JSON key file that contains the
consumer key and secret key, click this button.
If you select Basic authentication, this button is disabled.
- Clear OAuth Keys
- To clear the previously loaded OAuth JSON key
file, click this button.
If you select Basic authentication, this button is disabled.
-
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, to validate that the file server is connected properly, click Validate.
- To immediately activate the connection to the file server, click Activate.
- Optionally, to reset the connections of all active file servers, click Reset All Servers.