RSS Task

Properties   Config Settings  

The RSS Component consumes RSS feeds and translates them into item batches for your SSIS Package.

Remarks

Really Simple Syndication (RSS) is a popular and widely used syndication format. The RSS Task extends your SSIS Package with the ability to consume any syndicated content that uses the RSS format.

RSS Receive Task

The RSS Receive Task is a simple RSS client that can fetch a publicly syndicated feed. Each individual RSS item in the feed is pulled out and treated as its own message, and the task will submit the feed as a batch composed of these messages.

The target feed is specified by FeedURL. If the PollingInterval is set to a low value, the task can potentially submit multiple duplications of the same message by fetching the same copy of the target feed. To ensure that this does not happen, the task requires that a CacheFile and CachePeriod be set so that the task can keep track the incoming RSS items.

The RSS Send Task has support for SSL transport layer security. This may be enabled by setting SSLCert and SSLAcceptServerCert to appropriate values.

Receiver Property List

---

The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.

CacheFile	A file to be used for caching the incoming RSS feed.
CachePeriod	The number of days to store cached RSS item information.
FeedURL	The URL to poll for RSS feeds.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
HTTPAuthScheme	The authorization scheme to be used when server authorization is to be performed.
HTTPPassword	A password if authentication is to be used.
HTTPProxy	A set of properties related to proxy access.
HTTPUser	A user name if authentication is to be used.
ItemList	String denoting the name of the variable which contains the collection of items parsed from the last RSS feed.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
Other	Defines a set of configuration settings to be used by the component.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.

Config Settings

---

The following is a list of config settings for the task with short descriptions. Click on the links for further details.

HTTPAuthorization	The Authorization string to be sent to the server.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

CacheFile Property (RSS Task)

A file to be used for caching the incoming RSS feed.

Data Type

String

Default Value

""

Remarks

Each time the RSS task downloads the FeedURL, it will cache the contents of the RSS feed as a list of hashes of each item in CacheFile. CachePeriod controls the length of time these items are cached. At the beginning of each download, the task will remove all expired cache entries from the cache file.

Note: the default cache period is 7 days. To disable caching, set CachePeriod to 0.

This property is not available in the Sender.

CachePeriod Property (RSS Task)

The number of days to store cached RSS item information.

Data Type

Integer

Default Value

7

Remarks

Each time the RSS task downloads the FeedURL, it will cache the contents of the RSS feed as a list of hashes of each item in CacheFile. CachePeriod controls the length of time these items are cached. At the beginning of each download, the task will remove all expired cache entries from the cache file.

Note: the default cache period is 7 days. To disable caching, set CachePeriod to 0.

This property is not available in the Sender.

FeedURL Property (RSS Task)

The URL to poll for RSS feeds.

Data Type

String

Default Value

""

Remarks

The URL where the target RSS feed resides.

Firewall Property (RSS Task)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the task will attempt to connect.

FollowRedirects Property (RSS Task)

Determines what happens when the server issues a redirect.

Data Type

Enumeration

Possible Values

Never (0)
Always (1)
Same Scheme (2)

Default Value

0

Remarks

Normally, the task returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URL scheme is the same, otherwise the task generate a runtime error.

Furthermore, if either the new URL server and port are different than the existing one, HTTPUser and HTTPPassword are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

HTTPAuthScheme Property (RSS Task)

The authorization scheme to be used when server authorization is to be performed.

Data Type

Enumeration

Possible Values

Basic (0)
Digest (1)
Proprietary (2)
None (3)
Ntlm (4)

Default Value

0

Remarks

Use the HTTPAuthScheme property to tell the task which type of authorization to perform when the HTTPUser and HTTPPassword properties are set.

HTTPAuthScheme should be set to authNone (3) when no authentication is to be performed (or just don't set HTTPUser and HTTPPassword).

By default, HTTPAuthScheme is authBasic (0), and if the HTTPUser and HTTPPassword properties are set, the task will attempt basic authentication. If HTTPAuthScheme is set to authDigest (1) or authNtlm (4), digest or NTLM authentication will be attempted instead.

If HTTPAuthScheme is set to authProprietary (2) then the authorization token must be supplied through the HTTPAuthorization configuration. Note that, if you set the HTTPAuthorization config, the HTTPAuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the task to ignore the values of HTTPUser and HTTPPassword.

HTTPPassword Property (RSS Task)

A password if authentication is to be used.

Data Type

Password

Default Value

""

Remarks

If HTTP Basic Authentication is used to authenticate the user, User and Password are Base64-encoded.

If HTTP Digest Authentication is used to, the HTTPUser and HTTPPassword properties are used to respond to the HTTP Digest Authentication challenge from the server.

HTTPProxy Property (RSS Task)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

This is a Proxy type property which contains fields describing the proxy through which the task will attempt to connect.

HTTPUser Property (RSS Task)

A user name if authentication is to be used.

Data Type

String

Default Value

""

Remarks

If HTTP Basic Authentication is used to authenticate the user, User and Password are Base64-encoded.

If HTTP Digest Authentication is used to, the HTTPUser and HTTPPassword properties are used to respond to the HTTP Digest Authentication challenge from the server.

ItemList Property (RSS Task)

String denoting the name of the variable which contains the collection of items parsed from the last RSS feed.

Data Type

String

Default Value

"<none>"

Remarks

The ItemList property contains the name of a variable which stores items that are parsed from an RSS feed received from the server.

The variable is in the form of a datatable. The table's rows represent an RSS item, and the columns represent a different property of the item. The columns of the datatable are listed below:

This property is not available in the Sender.

LogFile Property (RSS Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LogMode Property (RSS Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:

Other Property (RSS Task)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The task accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

RuntimeLicense Property (RSS Task)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

SSLAcceptServerCert Property (RSS Task)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the task will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the task will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set SSLAcceptServerCertAcceptAny to True without opening the certificate selection dialog to force the task to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLAcceptServerCertAcceptAny Property (RSS Task)

Tells the component to accept any server certificate.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLCert Property (RSS Task)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Timeout Property (RSS Task)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the task will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the task fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the task may be changed to absolute timeouts, i.e. the task will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

Config Settings (RSS Task)

The task accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

RSS Config Settings

SSL Config Settings

General Config Settings