S3 Receiver

How to Configure a S3 Receive Location with the BizTalk Server Administration Console

To configure the receive location by using the BizTalk Server Administration console, use the following procedure:

NOTE: Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure receive location variables for a S3 receive location:

1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
2. In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a new receive location, and then click Properties.
3. In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane double-click an existing receive location or click New to create a new receive location.
4. In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.S3 2020 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
5. In the nsoftware.S3 2020 Transport Properties dialog box, you will find the following properties:

   AccessKey	The access key to use for authentication. Type: xs:string    Default Value: ""
   Bucket	The name of the bucket to make requests against. Type: xs:string    Default Value: "" NOTE: This property must have a value.
   DeleteMode	Controls if and when the remote object is deleted after download. Type: xs:int    Default Value: 0
   EncryptionAlgorithm	The encryption algorithm. Type: xs:int    Default Value: 0
   EncryptionPassword	The encryption password. Type: baf:Password    Default Value: ""
   ErrorThreshold	The maximum number of errors before the component shuts down. Type: xs:int    Default Value: 5
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   GoogleProjectId	A Google Cloud Platform project Id string. Type: xs:string    Default Value: ""
   HTTPProxy	A set of properties related to proxy access. Type: Proxy    Default Value: null
   MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit). Type: xs:int    Default Value: 0
   MaxFileCount	The maximum number of files in the current batch (0 indicates no limit). Type: xs:int    Default Value: 10
   MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit). Type: xs:int    Default Value: 0
   MaxThreads	The maximum number of threads that the component may consume. Type: xs:int    Default Value: 20
   OAuthAuthorization	OAuth Authorization Information. Type: OAuthAuthorizationParam    Default Value: null
   ObjectDelimiter	The delimiter string to use when listing objects. Type: xs:string    Default Value: ""
   ObjectMask	Indicates the type of files to download from the S3 server. Type: xs:string    Default Value: "*" NOTE: This property must have a value.
   ObjectPrefix	A prefix used to restrict the results returned when listing objects. Type: xs:string    Default Value: ""
   OracleNamespace	The Oracle Cloud Object Storage namespace string. Type: xs:string    Default Value: ""
   Other	Defines a set of configuration settings to be used by the component. Type: xs:string    Default Value: ""
   PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int    Default Value: 60
   ReceivedObjectDate	The date of the remote object received by the S3 component. Type: xs:string    Default Value: ""
   ReceivedObjectName	The name of the remote object received by the S3 component. Type: xs:string    Default Value: ""
   ReceivedObjectSize	The size of the remote object received by the S3 component. Type: xs:int    Default Value: 0
   Region	The region the component will make requests against. Type: xs:string    Default Value: ""
   RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool    Default Value: false
   RuntimeLicense	Specifies the component runtime license key. Type: xs:string    Default Value: ""
   SecretKey	The secret key to use for authentication. Type: baf:Password    Default Value: ""
   ServiceProvider	The S3 service provider. Type: xs:int    Default Value: 0
   SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. Type: Certificate    Default Value: null
   SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   TempPath	A temporary directory where data can be stored before the component processes it. Type: xs:string    Default Value: ""
   Timeout	A timeout for the component. Type: xs:int    Default Value: 60
   TransportLog	Tells the component where and how to report information about its operations. Type: Log    Default Value: null
   URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string    Default Value: ""
   UseSSL	Whether to use SSL/TLS when connecting. Type: bool    Default Value: true
   UseVirtualHosting	Determines which style request to use. Type: bool    Default Value: true

6. Click OK.
7. Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.