ICIContentIntegrityControlProfile

The ICIContentIntegrityControlProfile interface is used to define Content Integrity Control profiles used in the File Scan file Control Action in Event Rules. Many of these settings depend on the settings on the ICAP server. (You can also define a profile when defining the Event Rule, as needed.)

Properties

Property AuditResponseHeaders As String

HRESULT AuditResponseHeaders([out, retval] BSTR *pVal);
HRESULT AuditResponseHeaders([in] BSTR newVal);

EFT v7.0.3 and later

Property AuditResponseHeadersEnabled As Long

HRESULT AuditResponseHeadersEnabled([out, retval] BOOL *pVal);
HRESULT AuditResponseHeadersEnabled([in] BOOL newVal);

EFT v7.0.3 and later

Property ConnectivityErrorsPolicy As IcapErrorsPolicy

HRESULT ConnectivityErrorsPolicy([in] IcapErrorsPolicy newVal);
HRESULT ConnectivityErrorsPolicy([out, retval] IcapErrorsPolicy* pVal);

EFT v8.0.5 and later

Property Host As String

HRESULT Host([out, retval] BSTR *pVal);
HRESULT Host([in] BSTR newVal);

EFT v7.0.3 and later

Property HTTPErrorsPolicy As IcapErrorsPolicy

HRESULT HTTPErrorsPolicy([in] IcapErrorsPolicy newVal); 
HRESULT HTTPErrorsPolicy([out, retval] IcapErrorsPolicy* pVal);

EFT v8.0.5 and later

Property HTTPServerHost As String

HRESULT HTTPServerHost([in] BSTR newVal);
HRESULT HTTPServerHost([out, retval] BSTR* pVal);

EFT v8.0.5 and later

Property IcapMode As IcapMode

HRESULT IcapMode([out, retval] IcapMode *pVal);
HRESULT IcapMode([in] IcapMode newVal);

EFT v7.0.3 and later

Property ICAPRedactionsPolicy As IcapErrorsPolicy

HRESULT ICAPRedactionsPolicy([in] IcapErrorsPolicy newVal);
HRESULT ICAPRedactionsPolicy([out, retval] IcapErrorsPolicy* pVal);

EFT v8.0.5 and later

Property ICAPViolationsPolicy As IcapErrorsPolicy

HRESULT ICAPViolationsPolicy([in] IcapErrorsPolicy newVal);
HRESULT ICAPViolationsPolicy([out, retval] IcapErrorsPolicy* pVal);

EFT v8.0.5 and later

Property MaxScanSize As Long

HRESULT MaxScanSize([out, retval] long *pVal);
HRESULT MaxScanSize([in] long newVal);

EFT v7.0.3 and later

Property MaxScanSizeEnabled As Long

HRESULT MaxScanSizeEnabled([out, retval] BOOL *pVal);
HRESULT MaxScanSizeEnabled([in] BOOL newVal);

EFT v7.0.3 and later

Property MaxScanSizeUnits As IcapMaxScanSizeUnits

HRESULT MaxScanSizeUnits([out, retval] IcapMaxScanSizeUnits *pVal);
HRESULT MaxScanSizeUnits([in] IcapMaxScanSizeUnits newVal);

(See also the IcapMaxScanSizeUnits enum.)

EFT v7.0.3 and later

Property Name As String

HRESULT Name([out, retval] BSTR *pVal);
HRESULT Name([in] BSTR newVal);

EFT v7.0.3 and later

Property OverrideHTTPServerHost As Boolean

HRESULT OverrideHTTPServerHost([in] VARIANT_BOOL newVal);
HRESULT OverrideHTTPServerHost([out, retval] VARIANT_BOOL* pVal);

EFT v8.0.5 and later

Property OverrideXAuthGroupsHeader As Boolean

HRESULT OverrideXAuthGroupsHeader([in] VARIANT_BOOL newVal);
HRESULT OverrideXAuthGroupsHeader([out, retval] VARIANT_BOOL* pVal);

EFT v8.0.5 and later

Property OverrideXAuthUserHeader As Boolean

HRESULT OverrideXAuthUserHeader([in] VARIANT_BOOL newVal);
HRESULT OverrideXAuthUserHeader([out, retval] VARIANT_BOOL* pVal);

EFT v8.0.5 and later

Property OverrideXClientIPHeader As Boolean

HRESULT OverrideXClientIPHeader([in] VARIANT_BOOL newVal);
HRESULT OverrideXClientIPHeader([out, retval] VARIANT_BOOL* pVal);

EFT v8.0.5 and later

Property OverrideXServerIPHeader As Boolean

RESULT OverrideXServerIPHeader([in] VARIANT_BOOL newVal);
HRESULT OverrideXServerIPHeader([out, retval] VARIANT_BOOL* pVal);

EFT v8.0.5 and later

Property OverrideXSubscriberIDHeader As Boolean

HRESULT OverrideXSubscriberIDHeader([out, retval] VARIANT_BOOL* pVal);
HRESULT OverrideXSubscriberIDHeader([in] VARIANT_BOOL newVal);

EFT v8.0.5 and later

Property Path As String

HRESULT Path([out, retval] BSTR *pVal);
			HRESULT Path([in] BSTR newVal);

EFT v7.0.3 and later

Property Port As Long

HRESULT Port([out, retval] long *pVal); 
			HRESULT Port([in] long newVal);

EFT v7.0.3 and later

Property ResponseParsingResponseBodyText As String

HRESULT ResponseParsingResponseBodyText([out, retval] BSTR *pVal);
HRESULT ResponseParsingResponseBodyText([in] BSTR newVal);

EFT v7.0.3 and later

Property ResponseParsingResponseHeadersText As String

HRESULT ResponseParsingResponseHeadersText([out, retval] BSTR *pVal);
HRESULT ResponseParsingResponseHeadersText([in] BSTR newVal);

EFT v7.0.3 and later

Property ViolationIsNonBlocking As Boolean

HRESULT ViolationIsNonBlocking([out, retval] VARIANT_BOOL *pVal);
HRESULT ViolationIsNonBlocking([in] VARIANT_BOOL newVal);

EFT v7.0.3 and later

Property XAuthGroupsHeader As String

HRESULT XAuthGroupsHeader([in] BSTR newVal);
HRESULT XAuthGroupsHeader([out, retval] BSTR* pVal);

EFT v8.0.5 and later

Property XAuthUserHeader As String

HRESULT XAuthUserHeader([in] BSTR newVal);
			HRESULT XAuthUserHeader([out, retval] BSTR* pVal);

EFT v8.0.5 and later

Property XClientIPHeader As String

HRESULT XClientIPHeader([in] BSTR newVal);
HRESULT XClientIPHeader([out, retval] BSTR* pVal);

EFT v8.0.5 and later

Property XServerIPHeader As String

HRESULT XServerIPHeader([in] BSTR newVal);
HRESULT XServerIPHeader([out, retval] BSTR* pVal);

EFT v8.0.5 and later

Property XSubscriberIDHeader As String

HRESULT XSubscriberIDHeader([in] BSTR newVal);
HRESULT XSubscriberIDHeader([out, retval] BSTR* pVal);

EFT v8.0.5 and later

Dialog Box Equivalents

In v8.0.4 and later:

Script Examples

Adding / Updating a Profile

 
'''''''''''''''''''''''''
''Add profile
'''''''''''''''''''''''''
Set newProfile = WScript.CreateObject("SFTPCOMInterface.CIContentIntegrityControlProfile")
newProfile.Name = "test3"
newProfile.Host = "localhost3"
newProfile.Port = "3333"
// ....
SFTPServer.AddContentIntegrityControlProfile newProfile
'''''''''''''''''''''''''
''Update profile
'''''''''''''''''''''''''
newProfile.Host = "newHost"
i = SFTPServer.GetContentIntegrityControlProfile("test3")
SFTPServer.UpdateContentIntegrityControlProfile newProfile, i

Looping Through the Profile List and Printing Basic Information

profiles = SFTPServer.ContentIntegrityControlProfileList
For Each profile In profiles WScript.Echo "Profile: " & 
profile.Name & "; Host: " & profile.Host & "; Port: " & profile.Port
Next

Building the Action Parameters, Using Ad Hoc Profiles

Set CICActionParams = WScript.CreateObject(
"SFTPCOMInterface.CIContentIntegrityControlActionParams")
''This ActionParams is now linked to Profile1 in the server list
CICActionParams.ProfileName = "Profile1"
CICActionParams.File = "File"
''Setting an Ad Hoc Profile
Set adHocProfile = WScript.CreateObject
("SFTPCOMInterface.CIContentIntegrityControlProfile")
adHocProfile.Host = "localhost3"
adHocProfile.Port = "2222"
CICActionParams.AdHocProfile = adHocProfile
''If we set the profile name to a saved profile 
and then try to get the ad hoc profile property, we'll get an error
CICActionParams.ProfileName = "Profile1"
Set AdHocProfile = CICActionParams.AdHocProfile