Product DocsMenu

Modifying Hidden Box Source Parameters

The Add Source and Source: ... General pages of the Administration Tool present the parameters with which you can configure the connector for most Box setups. More advanced and more rarely used parameters are hidden. You can choose to make one or more of these parameters appear in the Add Source and Source: ... General pages of the Administration Tool so that you can change their default value. Consider changing values of hidden parameters when you encounter issues.

The following list describes the advanced hidden parameters available with Box sources. The parameter type (integer, string, etc.) appears between parentheses following the parameter name.

RetrieveGlobalFileMetadata (Integer)

Whether to retrieve the global metadata (properties) of files. The default value is false.

RetrieveFileCommentsMetadata (Integer)

Whether to retrieve the file comments as a metadata. The default value is false.

IgnoreSharedLinkPermissions (Boolean) CES 7.0.8850+ (March 2017) Security provider

Whether to ignore Shared Link permissions. The default value is true.

Important: Setting this parameter to false can potentially expose sensitive information as all documents that were shared using a Share Link will be considered public.

IgnoreSharedLinkPasswordProtection (Integer) CES 7.0.8850+ (March 2017) Security provider

Whether to ignore Shared Link password protection when IgnoreSharedLinkPermissions is false. The default value is false.

To modify hidden Box source parameters

  1. Refer to Adding an Explicit Connector Parameter to add one or more Box source parameters.

  2. For a new Box source, access the Add Source page of the Administration Tool to modify the value of the newly added advanced parameter:

    1. Select Index > Sources and Collections.

    2. Under Collections, select the collection in which you want to add the source.

    3. Under Sources, click Add.

    4. In the Add Source page, edit the newly added advanced parameter value.

  3. For an existing Box source, access the Source: ... General page of the Administration Tool to modify the value of the newly added advanced parameter:

    1. Select Index > Sources and Collections.

    2. Under Collections, select the collection containing the source you want to modify.

    3. Under Sources, click the existing Box source in which you want to modify the newly added advanced parameter.

    4. In the Source: ... General page, edit the newly added advanced parameter value.

  4. Rebuild your Box source to apply the changes to the parameters (see Applying an Action to a Collection or a Source).

People who viewed this topic also viewed