Documentation Center

Framework-wide connector configuration properties

The Tridion Integration Framework supports a number of properties that you can use in any connector's configuration file. You can define these properties at various levels in the multi-leveled configuration, that is, for the connector overall and for specific environments and namespaces.

logLevel

(Optional) The level of detail to be recorded in the log file for the connector, and one of the following values:

Log levelDescription
DebugLog the highest detail level that is possible
InfoLog warnings, errors and informational messages
WarningLog warnings and errors

The default logging level for connectors is Warning, and this is used if no logLevel value is defined.

ErrorLog only errors
vmArgs

(Optional) Arguments that get passed to virtual machines in order to control heap sizes of connector host processes.

displayName
When External Content Library (ECL) is the Application Client, this name is used to identify the connector in the Content Manager user interface.
stubFolders
When External Content Library (ECL) is the Application Client, the Item URI of the Folder (under Building Blocks) where ECL will add internal, Tridion Sites representations of external entities. Only Administrators can view these internal items.
You must manually create the stub Folder, note the Item URI, and then specify that URI in this property.
The security settings you set on the stub Folders control user access to the external multimedia content (within the related mount point/namespace).
stubCategories
When External Content Library (ECL) is the Application Client, the Item URIs of one or more Categories where ECL will show the external taxonomy's hierarchy of concepts. In addition, ECL will use the Category for internal, Tridion Sites representations of external entities; however, these will not be visible to any users.
You must manually create each stub Category, note the Item URI, and then specify that URI in this property.
Although the stubCategories property accepts an array of values, you should only configure one Category within a single namespace and Blueprint. If you are using the same connector configuration to support multiple BluePrints, then you can define multiple URIs in this property, one for each Category in the separate Blueprints.
The security settings configured for the stub Categories will control user access to the concepts in the external taxonomy (within the related mount point/namespace).
useFeature
When External Content Library (ECL) is the Application Client, set to "Taxonomy" to indicate this namespace is for the External Taxonomy feature of ECL
privilegedUserName

(Optional) When External Content Library (ECL) is the Application Client, this is a specific user name that ECL will use to impersonate a user, giving them with sufficient privileges, rights or permission to perform any actions that require a higher level of access.

This property is no longer required, but continues to be provided for backwards compatibility with older versions of ECL.

If you do not configure a privilegedUserName, the default and preferred behavior is to rely on privilege elevation. With privilege elevation, any actions that require a higher level of access (like creating ECL Stub items) will be performed in name of the original user but with the privileges of a System Administrator (even if the original user doesn't have those).

If you do choose to use the privilegedUserName property, define it as a fully qualified username for a Windows account, such as "global\administrator". The fully qualified username can specify a domain, such as "global\administrator", or can be a local server account. In this case, you need to include the machine name rather than a domain, for example, "MYCMSSERVER\Administrator".

configuration

Any number of connector-specific settings, such as endpoint URLs, username, password, and so on. The settings vary from connector to connector. For details on what these are, refer to the connector-specific documentation.

This setting in configurable in both the manifest and the connector's configuration file. Values in the configuration file override those in the manifest.