Skip to content

Commit

Permalink
[DOCS-7764] Add default properties to Enterprise Viewer 4.0 (#1533)
Browse files Browse the repository at this point in the history
* [DOCS-7764] Add default properties to Enterprise Viewer 4.0

* [DOCS-7764] Add default properties to Enterprise Viewer 4.0

* [DOCS-7764] Replace OC with OpenContent
  • Loading branch information
mbujak-hyland authored Aug 22, 2024
1 parent 2888565 commit 0036428
Showing 1 changed file with 214 additions and 4 deletions.
218 changes: 214 additions & 4 deletions enterprise-viewer/latest/config/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Default value: `http://localhost:8080/OpenContent/rest`

### clientRequestUrl

The URL that client requests from Enterprise Viewer to OpenContent should be made to. Generally, this only changes if OpenContent has a different REST root, `/alfresco/OpenContent` for example used when OC is an Alfresco subsystem.
The URL that client requests from Enterprise Viewer to OpenContent should be made to. Generally, this only changes if OpenContent has a different REST root, `/alfresco/OpenContent` for example used when OpenContent is an Alfresco subsystem.

Default value: `/OpenContent/rest`

Expand Down Expand Up @@ -278,19 +278,19 @@ Default value: `JSESSIONID`

### checkServletRequestForSessionId

Whether or not a session ID should be checked in the servlet request. If set to `true` and a valid session ID is found in the servlet request, the session ID is appended to the endpoint URL.
Set to `true` if a check should be made for the sessionId on the Servlet requests from Enterprise Viewer's front-end and append it to the requests to OpenContent, or `false` otherwise. This sessionId is used to maintain sticky sessions in load-balanced environments. If this property and `checkServletCookieForSessionId` are both set, the sessionId set on the Servlet request overrides any sessionId set on the cookie.

Default value: `true`

### checkServletCookieForSessionId

Set to `true` if a check should be made for the sessionId on a cookie and append it to the requests to OC, or `false` otherwise. This sessionId is used to maintain sticky sessions in load-balanced environments. If this property and `checkServletRequestForSessionId` are both set, the sessionId set on the Servlet request overrides any sessionId set on the cookie.
Set to `true` if a check should be made for the sessionId on a cookie and append it to the requests to OpenContent, or `false` otherwise. This sessionId is used to maintain sticky sessions in load-balanced environments. If this property and `checkServletRequestForSessionId` are both set, the sessionId set on the Servlet request overrides any sessionId set on the cookie.

Default value: `true`

### rerenderPageOnResize

Set to `true` to send new requests to OC every time you zoom in or out on a page, or `false` otherwise.
Set to `true` to send new requests to OpenContent every time you zoom in or out on a page, or `false` otherwise.

Default value: `true`

Expand Down Expand Up @@ -488,6 +488,216 @@ For more information on configuring overlays, see [Configure Overlays]({% link e

Default value: `false`

### zoomClientID

Client ID property for sending a Zoom authorization call that eventually sends a request that creates a meeting. Blank by default, as you'll need to create a Zoom app to get this value and use this feature.

Default value: ``

### clientKey

The optional OpenContent client key to be used in `OAUtil.oaRestTemplateGet/oaRestTemplatePost` calls. This key, if configured, sets as a request header and eventually used OpenContent side for some SSO implementations.

Default value: ``

### serviceExtAuthEndpoint

REST Endpoint that holds the external authentication service that OAaaS will leverage to provide security.

Default value: ``

### oaVideoEndpointAddress

The base endpoint address for `OpenAnnotateVideo`.

Default value: `/OpenAnnotate/OpenAnnotateVideo/index.html`

### oaVideoEmbedded

Whether or not the `OpenAnnotateVideo` is embedded in `OpenAnnotate`.

Default value: `true`

### ignoreTextInHeadersAndFooters

Whether or not the selected text in headers and footers is ignored. This property can be used to evaluate if any text has been selected on a page.

Default value: `false`

### enableEditInSummaryView

Whether or not users are allowed to edit annotation content in the summary view. If set to `false`, users are allowed to only edit text in the main annotation dialog.

Default value: `true`

### userFollowingEnabled

Whether or not the `following` feature is enabled in the participants view.

Default value: `true`

### displayLoadTime

Whether or not OA load time data is displayed. It is displayed in the `i` icon.

Default value: `true`

### displaySameLoadTimeAtAllResolutions

Whether or not the load time information is displayed above the toolbar on small screens. If set to `true`, the load information is displayed in the toolbar row regardless of screen size.

Default value: `false`

### enableReplies

Whether or not users are allowed to reply to annotations.

Default value: `true`

### largeDocTextDataPagesPerRequest

The number of pages of a document that is processed at a time to retrieve the location data for a selectable text within a large document. For defining large documents, see the `numberOfPagesForLargeDocuments` and `maxDocumentSize` properties.

This is a performance-only property.

Default value: `5`

### directDownload

Whether or not request a temporary, secured URL within limited access time. If set to `true`, `&presignedUrl=true` is appended to the URL. This property is often used for accessing resources in cloud storage services (like Amazon S3) without needing long-term credentials.

Default value: `false`

### allowDownloadNativeContent

Whether or not to download the native content if there is an error retrieving document information and the document cannot be displayed in OA.

Default value: `true`

### fileAttachmentMaxSize

The maximum size (in bytes) of file attachments.

Default value: `10260000`

### numOfPageDimensionsToFetch

The number of page dimensions, such as height and width, retrieved at once when as user views a document. This value is used to calculate how many pages' dimensions should be requested in each batch. This works to retrieve page dimensions around the current visible page, balancing the load by controlling the number of requests and ensuring efficient pre-caching of nearby pages' dimensions.

Default value: `100`

### pageHeightPlaceHolder

A default height used for a page when the actual dimensions are not available yet.

Default value: `792`

### pageWidthPlaceHolder

A default width used for a page when the actual dimensions are not available yet.

Default value: `612`

### displayOAVersionInfo

Whether or not the OA version information is displayed in OpenAnnotate. If set to `true`, the `displayOAlogo` property must be also set to `true`.

Default value: `true`

### displayOALogo

Whether or not the OA logo is displayed in OpenAnnotate.

Default value: `true`

### useSummaryEventsFilterOnDocAnnots

Whether or not annotations and summaries should be hidden if they do not match the search criteria. If set to `false`, a user can filter summary entries but keep all annotations visible.

Default value: `true`

### showSelectedToolInDropDown

Whether the icon displayed in the selection tool drop-down list is either the three-line menu icon or the icon of the tool that a user has currently selected, in non-standalone view.

Default value: `false`

### quillPlaceholderEnabled

If set to `false`, the initial instructional note in the annotation text area is removed.

Default value: `true`

### fullyQualifiedClientUrl

A fully qualified REST URL for client side use.

Default value: `http://localhost:8080/OpenContent/rest`

### sso.client.key

An optional OpenContent client key that is used in `OAUtil.oaRestTemplateGet/oaRestTemplatePost`. If set to a value, it should be included in the request headers of your HTTP request.

Default value: ``

### suggestedRedactionProperties

List of property values that are suggested for redaction. To set it to the desired property OpenContent names, use comma to separate them. For example, for Alfresco environment, the following can be used: `insuranceDemo_claimantName,insuranceDemo_policyHolder`.

Default value: ``

### enablePruneAudit

Whether or not OpenContent should audit when executing a prune.

Default value: `false`

### mentionMinChars

The minimum number of characters a user must type after (not including) a denotation character to display the `mention` drop-down list.

Default value: `3`

### mentionIsolateCharacter

Whether or not the `@` must be isolated (at the beginning of a line or after a whitespace) to create a mention.

Default value: `true`

### mentionOnlyActiveUsers

Whether or not only active users can be mentioned. If set to `false`, all users with access to a document can be mentioned.

Default value: `false`

### mentionSearchUserNames

Whether or not to include `userNames` in search when populating the `mention` drop-down list.

Default value: `true`

### mentionSearchDisplayNames

Whether or not to include `displayNames` in search when populating the `mention` drop-down list.

Default value: `true`

### mentionEmailOfflineUsers

Whether or not an offline, mentioned user receives an email notification.

Default value: `false`

### secureBrowserCookies

Set it to `true` if the SSL security protocol is used.

Default value: `false`

### split.prune.copy.attrs

List of properties to copy property values while splitting or pruning document. To set it to the desired property OpenContent names, use comma to separate them. For example, for Alfresco environment, the following can be used: `insuranceDemo_claimantName,insuranceDemo_policyHolder`. If set to blank, all property values are copied.

## OpenContent - default properties

### license.doSendWarningEmail
Expand Down

0 comments on commit 0036428

Please sign in to comment.