AXPAttachmentControl record type

The AXPAttachmentControl record type collects basic information that is required to establish a connection to a remote file server.

The Attachments package adds the AXPAttachmentControl record type to the schema. To configure the external attachments functionality, an administrator submits an AXPAttachmentControl record that contains information about the external server. The administrator can modify the AXPAttachmentControl record at a later time if the external server configuration changes. Until an AXPAttachmentControl record is submitted, attachments are stored in the HCL Compass database.

Note: There can be only one AXPAttachmentControl record for each HCL Compass database.

The AXPAttachmentControl record type contains the following fields:

Field	Description	Example
Name	The name of the AXPAttachmentControl record. The default name is AXPAttachments. This field is read-only.
Account ID	The account to use to authenticate with the external attachment server.	user ID
Account Authentication	Any authentication information that is needed to access the Account ID.	password
Control Options	Any control information that is needed to establish a connection to the remote server. This field is a free–format text string that contains `KEY=VALUE` pairs that are separated by semicolons. The control options are as follows: TYPE The external server type. Currently, only `FTP` and `NONE` are supported. FTP is the default server type. `NONE` disables external attachment processing the same way that the `DISABLED` option and the Disable transfer to external storage check box do. DISABLED Setting `DISABLED` to `TRUE` disables the external attachment processing, which is equivalent to setting `TYPE` equal to `NONE`. The default setting is `FALSE`. When `TYPE` is set to `FTP`, the following options are available: PORT The communications Internet Protocol (IP) port number to use to connect to the remote FTP server. The default port number is `21`. BLOCKSIZE The block size that will be used during file transfers. The default block size is 4 kilobytes.	`TYPE=FTP` This is the simplest configuration. The target server type is FTP. All other options are set to default values. `TYPE=FTP;PORT=5021;BLOCKSIZE=1024` The target server type is FTP. The port that is used by FTP on the target server is 5021. The transfer block size is 1024 bytes (1 kilobyte). `TYPE=NONE;PORT=21` Offsite storage is disabled.
Server Name	The name of the remote attachments server. The form of the name varies depending on the type of server. For FTP, it is the fully qualified name of the server.
Storage Location	The location on the server that the specified account ID will use for storing attachments.
Max. Attachment File Size	The maximum size of an attachment in bytes that can be stored in the HCL Compass database. If the external server is unavailable, the attachments are stored locally in HCL Compass. This field provides a means to limit the size of locally stored attachments to a manageable size. A size of `0` indicates that no attachments will be stored locally. A size of `-1` indicates that there is no limit to the size of attachments that will be stored locally. Attachments that are stored in the HCL Compass database are not automatically moved to external storage. When a connection to the server is reestablished, the record must be manually updated to move the attachment to the external server.
Reference Location	The location on the server that unauthorized (anonymous) accounts can use to locate external attachments. This field is associated with the Storage Location field, but it can be different depending on how access to data on the external storage is managed.
Security Context	Enables security context on a record. See Modifying the AXPAttachmentsControl record type for details on how to secure a record type.
Disable transfer to external storage	Temporarily disables the external attachments functionality. When this option is selected, no attempt is made to connect to the external server. The value in the Max. Attachment File Size field is ignored.
Last Updated By	Displays the ID of the last HCL Compass user who updated the record. This field is read-only.
Last Updated On	Displays the date of the last update. This field is read-only.
Created By	Displays the ID of the HCL Compass user who created the record. This field is read-only.
Created On	Displays the date when the record was created. This field is read-only.