Package com.saperion.ngc.util
Class NgClientConstants
java.lang.Object
com.saperion.ngc.util.NgClientConstants
NGClient specific constants.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Separator used to set multiple ACLs when archiving or updating.static final int
DPI for annotation coordinats.static final double
Document height for annotation coordinates (pixels).static final double
Document width for annotation coordinates (pixels).static final double
Calculation pixel to Pt as follows.
Pt = px * PxToPtConvertFactor * ResolutionFactor
= px * 0.75 * (ScreenResolution / DocumentResolution)
= px * 0.75 * (72/300)
= px * 0.75 * 0.24
= px * 0.18static final double
Factor needed to scale font-heights for the ViewOne annotation ini format.static final double
A physical inch consists of 72 points.static final String
Set to true for archiving value of readonly fields from Index mask, default is true.static final String
Blacklisted MIME typesstatic final String
System property used to disable JNDI in configuration.static final String
Name of the section to be used for database-settings.static final Charset
default charset for webclient with always supported UTF-8 encoding.static final String
default charset for webclient with always supported UTF-8 encoding.static final int
Default number of fraction-digits for float-values.static final char
Default escape-character for HQL like statements.static final String
Characters to escape by default on ANSI SQL databases.static final String
Characters to escape by default on MSSQL databases.static final String
If the web.xml does not provide a log manager take this one.static final int
Default timeout for mail links.static final String
Value of the escape-character properties to disable escaping.static final String
static final String
static final String
static final String
When set to true will always show Relogin with SSO Button in login dialogstatic final String
When set to true will prevent users to login without SSOstatic final String
Setting for hiding document structure in preview windowstatic final String
Secret key as registered by HYLAND_VIEWERstatic final String
Token expiration time for HYLAND_VIEWER requeststatic final String
Docflow section in ini.static final String
FormTarget section in ini.static final String
RevisionDialog section in ini.static final String
Ini-entry to enable displayname in user-dialogs for workflow.static final int
default value for page size.static final String
Name of session attribute for multi mandant status.static final String
Webclient's name as registered in JCSstatic final String
Secret key as registered in JCSstatic final String
JNDI path-prefix for web client configuration resources.static final String
login defaultLocale .static final String
login supportedLocales .static final String
TabId of the always visible start tab.static final int
Constant defining how many business cases show up in recently-launched-menu.static final String
Maximum number of cached HyRCS sessionsstatic final int
Maximum random number for viewer ID generator.static final String
Common parameter-name for the render-mold of the NgApplet component.static final int
Byte count of -1 since it is recognized as -1MB in first step of initialization.static final String
static final String
OneDrive settingsstatic final int
Interval for Turning off Folder Refresh.static final String
Param name for web.xml Folder Refresh timer.static final String
Name for Folder Refresh Timer.static final String
Param name for web.xml Workflow Folder Refresh timer.static final String
Name for Workflow Folder Refresh Timer.static final String
Standard CSS class for result set view sorting.static final String
Service account passwordstatic final String
Service account tenantstatic final String
Service account user typestatic final String
Service account usernamestatic final int
Indicator to look for the first viewable structure element on openDocument.static final String
static final String
static final String
static final String
static final String
static final String
Sharebase settingsstatic final String
static final String
static final String
Service account passwordstatic final String
Service account usernamestatic final String
Constant to define if for workflow items the next default command action cell should be displayed as configured in web.xml.static final String
Variable that represents a cover page that shall be shown firstly as part of a structured document.static final String
TitlePropertyNames parameter in web.xml.static final String
Map used to link viewers to their session.static final String
Parameter in SnowboundVirtualViewer.conf that stores the path to license files.static final String
Setting for documents download always as attachment.static final String
Deprecated.no longer used.static final String
Optional parameter to define how often the viewer applet tries to find out if it is ready.static final String
Optional parameter to define the timeout between two tries to find out if the viewer applet is ready.static final String
Parameter to define the maximum number of hits in a query result to use client side paging for.static final String
The URL used by the clients to reach the webclient.static final String
Parameter to define the default viewer's class name.static final String
Parameter to define the fully qualified default viewer's class name.static final String
Setting to disable size-limit-notification in viewer.static final String
Setting for downloading potentially unsafe content from Saperionstatic final String
static final String
Disable counter values for eFiles and their registers in navigation tree.static final String
Configures removal of line breaks in CSV export.static final String
Configurs pattern used to exclude fields.static final String
Maximum allowed number of elements to export.static final String
Maximum allowed length of an exported value.static final String
URL of the help-page that will be opened when the user clicks the help-button.static final String
Hidden folders in navigation view.static final String
Optional parameter to define whether to hide register nodes in navigation overview or not.static final String
Parameter to define chars to escape in HQL queries for other database types than Oracle and MSSQL.static final String
Parameter to define chars to escape in HQL queries for MSSQL databases.static final String
Parameter to define chars to escape in HQL queries for Oracle databases.static final String
Parameter to define the escape character in HQL queries.static final String
Parameter to ignore NameOpUpper setting for queries.static final String
Optional parameter to define the log manager to use.static final String
Parameter to enable automatic logout when browser window is closed.static final String
Optional parameter to set URL to redirect to after logoff.static final String
Parameter to limit max size or recent eFiles shown below eFile app.static final String
Max upload size in MB configured in web.xml.static final String
Maximum size of documents that can be opened by viewer applet.static final String
If true, multipage tiff documents will be shown as single file.static final String
Optional parameter to define whether to renew http-session after login.static final int
-1 in web.xml's MaxUploadSize configuration means no upload limit.static final String
Optional parameter to define how long the client will delay the opening of a document in a popup mask.static final String
Optional parameter to define how long the client will delay the initialization of the viewer applet in a popup mask.static final String
Prefix for mail links.static final String
If true, no warning will be shown when some elements must be skipped.static final String
Maximum number of elements that can be printed as pdf.static final String
Maximum size (in bytes) of generated PDF to be kept in memory and not in a tempfile.static final String
Parameter to enable or disable automatic refresh of result lists.static final String
Setting to configure the class name of the render-engine to be used.static final String
Setting to configure parameters for the render-engine.static final String
Setting to configure the number of parallel threads for the render-engine.static final String
Setting for base url to rest webservices.static final String
static final String
URL of the help-page that will be opened when the user clicks the help-button in the SAPViewer.static final String
Parameter to enable PDFJS in SAPViewer.static final String
The URL the client will be redirected to after logging off from a SSO session.static final String
static final String
List of supported formats for the viewer.static final String
Target page for mail links.static final String
Setting to configure if temporary documents should be shown in viewer at archiving time.static final String
Timeout for mail links.static final String
Variants of uploading a document via web client.static final String
Enable viewer-session-map for virtual viewer session handling.static final String
Setting to enable ZK download mode instead of Saperion download mode.static final String
If true, the UserSelectionDialog will show the description of selected users.static final String
Parameter to set the height of viewer-popup windows.static final String
Parameter to set the width of viewer-popup windows.static final String
static final String
Parameter to enable watermarks on documents.static final String
Allow secure upload for unsigned certificates configured in web.xml.static final String
Setting for ZK downloader to deliver ZIPs even if only one entry is downloaded. -
Method Summary
-
Field Details
-
JNDI_CONFIG_LOOKUP_PREFIX
JNDI path-prefix for web client configuration resources.- See Also:
-
TITLE_PROPERTY_NAMES
TitlePropertyNames parameter in web.xml.- See Also:
-
MAX_RANDOM_NR
public static final int MAX_RANDOM_NRMaximum random number for viewer ID generator.- See Also:
-
INITIAL_PAGESIZE
public static final int INITIAL_PAGESIZEdefault value for page size.- See Also:
-
SEARCH_FIRST_VIEWABLE_DOCUMENT
public static final int SEARCH_FIRST_VIEWABLE_DOCUMENTIndicator to look for the first viewable structure element on openDocument.- See Also:
-
DEFAULT_ENCODING
default charset for webclient with always supported UTF-8 encoding.- See Also:
-
DEFAULT_CHARSET
default charset for webclient with always supported UTF-8 encoding. -
SV_SELECTED_IMAGE
Variable that represents a cover page that shall be shown firstly as part of a structured document.- See Also:
-
LOGIN_DEFAULT_LOCALE
login defaultLocale .- See Also:
-
LOGIN_SUPPORTED_LOCALES
login supportedLocales .- See Also:
-
REFRESH_WORKFLOW_FOLDER_TIME_PARAM
Param name for web.xml Workflow Folder Refresh timer.- See Also:
-
ARCHIVE_READONLY_FIELDS
Set to true for archiving value of readonly fields from Index mask, default is true.- See Also:
-
REFRESH_FOLDER_TIME_PARAM
Param name for web.xml Folder Refresh timer.- See Also:
-
REFRESH_WORKFLOW_FOLDER_TIMER_NAME
Name for Workflow Folder Refresh Timer.- See Also:
-
REFRESH_FOLDER_TIMER_NAME
Name for Folder Refresh Timer.- See Also:
-
REFRESH_FOLDER_TIME_OFF
public static final int REFRESH_FOLDER_TIME_OFFInterval for Turning off Folder Refresh.- See Also:
-
DEFAULT_LOG_MANAGER
If the web.xml does not provide a log manager take this one.- See Also:
-
RESULT_SET_SORT_DEFAULT_CSS_CLASS_NATURAL
Standard CSS class for result set view sorting.- See Also:
-
MAINTABVIEW_TAB_START_ID
TabId of the always visible start tab.- See Also:
-
MAX_LAUNCH_FAVORITES
public static final int MAX_LAUNCH_FAVORITESConstant defining how many business cases show up in recently-launched-menu.- See Also:
-
WEBCONFIG_CLIENT_URL
The URL used by the clients to reach the webclient.- See Also:
-
WEBCONFIG_SSO_LOGOUT_URL
The URL the client will be redirected to after logging off from a SSO session.- See Also:
-
WEBCONFIG_PRINT_PDF_MAX_ELEMENTS
Maximum number of elements that can be printed as pdf. 0 = disabled, -1 no limit.- See Also:
-
WEBCONFIG_PRINT_PDF_MAX_IN_MEM_SIZE
Maximum size (in bytes) of generated PDF to be kept in memory and not in a tempfile.- See Also:
-
WEBCONFIG_PRINT_PDF_DISABLE_SKIPPED_ELEMENTS_WARNING
If true, no warning will be shown when some elements must be skipped.- See Also:
-
WEBCONFIG_MAX_UPLOAD_SIZE
Max upload size in MB configured in web.xml.- See Also:
-
WEBCONFIG_NO_UPLOAD_LIMIT
public static final int WEBCONFIG_NO_UPLOAD_LIMIT-1 in web.xml's MaxUploadSize configuration means no upload limit.- See Also:
-
NO_UPLOAD_LIMIT_IN_BYTES
public static final int NO_UPLOAD_LIMIT_IN_BYTESByte count of -1 since it is recognized as -1MB in first step of initialization.- See Also:
-
WEBCONFIG_WEAKSSL_UPLOAD
Allow secure upload for unsigned certificates configured in web.xml.- See Also:
-
WEBCONFIG_UPLOAD_VARIANTS
Variants of uploading a document via web client.- See Also:
-
WEBCONFIG_MAX_VIEW_SIZE
Maximum size of documents that can be opened by viewer applet. 0 means no limit.- See Also:
-
WEBCONFIG_HELP_URL
URL of the help-page that will be opened when the user clicks the help-button.- See Also:
-
WEBCONFIG_SAP_VIEWER_HELP_URL
URL of the help-page that will be opened when the user clicks the help-button in the SAPViewer.- See Also:
-
WEBCONFIG_SUPPORTED_FORMATS
List of supported formats for the viewer.- See Also:
-
WEB_APP_SNOWBOUND_LICENSES_PATH
Parameter in SnowboundVirtualViewer.conf that stores the path to license files.- See Also:
-
SHOWDEFAULTCOMMANDACTIONCELL
Constant to define if for workflow items the next default command action cell should be displayed as configured in web.xml.- See Also:
-
WEBCONFIG_DISABLE_SIZE_LIMIT_NOTIFICATION
Setting to disable size-limit-notification in viewer.- See Also:
-
WEBCONFIG_USE_ZK_DOWNLOAD_MODE
Setting to enable ZK download mode instead of Saperion download mode.- See Also:
-
WEBCONFIG_ZK_ALWAYS_DOWNLOADS_ZIP
Setting for ZK downloader to deliver ZIPs even if only one entry is downloaded.- See Also:
-
WEBCONFIG_ALWAYS_ATTACH_DOCUMENT_DOWNLOAD
Setting for documents download always as attachment.- See Also:
-
WEBCONFIG_ALWAYS_DOWNLOAD_BIG_DOCUMENTS
Deprecated.no longer used. Will be removed in 8.1.Setting to force downloading of big documents.- See Also:
-
WEBCONFIG_RENDER_ENGINE_OPTIONS
Setting to configure parameters for the render-engine.- See Also:
-
WEBCONFIG_RENDER_ENGINE_THREADS
Setting to configure the number of parallel threads for the render-engine.- See Also:
-
WEBCONFIG_RENDER_ENGINE_CLASS
Setting to configure the class name of the render-engine to be used.- See Also:
-
WEBCONFIG_TEMPORARY_DOCUMENT_PREVIEW
Setting to configure if temporary documents should be shown in viewer at archiving time.- See Also:
-
WEBCONFIG_REST_BASE_URL
Setting for base url to rest webservices.- See Also:
-
WEBCONFIG_TIMEOUT_MAIL_LINK
Timeout for mail links.- See Also:
-
WEBCONFIG_PREFIX_MAIL_LINK
Prefix for mail links.- See Also:
-
WEBCONFIG_TARGET_PAGE_MAIL_LINK
Target page for mail links.- See Also:
-
WEBCONFIG_USE_VIEWER_SESSION_MAP
Enable viewer-session-map for virtual viewer session handling.- See Also:
-
WEBCONFIG_STANDALONEVIEWER_SECURELINK_REQUIRED
- See Also:
-
WEBCONFIG_APPLET_READY_ATTEMPTS
Optional parameter to define how often the viewer applet tries to find out if it is ready.- See Also:
-
WEBCONFIG_APPLET_READY_TIMEOUT
Optional parameter to define the timeout between two tries to find out if the viewer applet is ready.- See Also:
-
WEBCONFIG_POPUP_DOCUMENT_OPEN_DELAY
Optional parameter to define how long the client will delay the opening of a document in a popup mask.- See Also:
-
WEBCONFIG_POPUP_VIEWER_INIT_DELAY
Optional parameter to define how long the client will delay the initialization of the viewer applet in a popup mask.- See Also:
-
WEBCONFIG_HIDE_EFILES_IN_OVERVIEW
Optional parameter to define whether to hide register nodes in navigation overview or not.- See Also:
-
WEBCONFIG_NEW_SESSION_AFTER_LOGIN
Optional parameter to define whether to renew http-session after login.- See Also:
-
WEBCONFIG_LOGOFF_URL
Optional parameter to set URL to redirect to after logoff.- See Also:
-
WEBCONFIG_LOG_MANAGER_CLASS_NAME
Optional parameter to define the log manager to use.- See Also:
-
WEBCONFIG_MERGE_MULTIPAGETIFF
If true, multipage tiff documents will be shown as single file.- See Also:
-
WEBCONFIG_USER_SELECT_DIALOG_SHOWS_DESCRIPTION
If true, the UserSelectionDialog will show the description of selected users.- See Also:
-
WEBCONFIG_HIDDEN_FOLDERS
Hidden folders in navigation view.- See Also:
-
WEBCONFIG_EFILE_COUNTER_ENABLED
Disable counter values for eFiles and their registers in navigation tree.- See Also:
-
WEBCONFIG_EXPORT_MAX_ELEMENTS
Maximum allowed number of elements to export.- See Also:
-
WEBCONFIG_EXPORT_MAX_VALUE_LENGTH
Maximum allowed length of an exported value.- See Also:
-
WEBCONFIG_EXPORT_CSV_REMOVE_LINE_BREAKS
Configures removal of line breaks in CSV export.- See Also:
-
WEBCONFIG_EXPORT_EXCLUDE_COLUMNS_PATTERN
Configurs pattern used to exclude fields.- See Also:
-
WEBCONFIG_LOGOFF_ON_CLOSE
Parameter to enable automatic logout when browser window is closed.- See Also:
-
WEBCONFIG_WATERMARK_ENABLED
Parameter to enable watermarks on documents.- See Also:
-
WEBCONFIG_MAX_RECENT_EFILES
Parameter to limit max size or recent eFiles shown below eFile app.- See Also:
-
WEBCONFIG_IGNORE_NAME_OP_UPPER_SETTING
Parameter to ignore NameOpUpper setting for queries.- See Also:
-
WEBCONFIG_REFRESH_RESULT_AFTER_UPDATE
Parameter to enable or disable automatic refresh of result lists.- See Also:
-
WEBCONFIG_CLIENT_SIDE_FUNCTIONS_LIMIT
Parameter to define the maximum number of hits in a query result to use client side paging for.- See Also:
-
WEBCONFIG_HQL_CHARS_TO_ESCAPE
Parameter to define chars to escape in HQL queries for other database types than Oracle and MSSQL.- See Also:
-
WEBCONFIG_HQL_CHARS_TO_ESCAPE_MSSQL
Parameter to define chars to escape in HQL queries for MSSQL databases.- See Also:
-
WEBCONFIG_HQL_CHARS_TO_ESCAPE_ORACLE
Parameter to define chars to escape in HQL queries for Oracle databases.- See Also:
-
WEBCONFIG_HQL_ESCAPE_CHARACTER
Parameter to define the escape character in HQL queries.- See Also:
-
WEBCONFIG_DEFAULT_VIEWER_CLASS
Parameter to define the default viewer's class name.- See Also:
-
WEBCONFIG_DEFAULT_VIEWER_CLASS_NAME
Parameter to define the fully qualified default viewer's class name.- See Also:
-
WEBCONFIG_VIRTUAL_VIEWER_CLASS_NAME
- See Also:
-
WEBCONFIG_VIEWER_POPUP_WIDTH
Parameter to set the width of viewer-popup windows.- See Also:
-
WEBCONFIG_VIEWER_POPUP_HEIGHT
Parameter to set the height of viewer-popup windows.- See Also:
-
WEBCONFIG_SAPVIEWER_PDFJS
Parameter to enable PDFJS in SAPViewer.- See Also:
-
NGAPPLET_RENDERMOLD
Common parameter-name for the render-mold of the NgApplet component.- See Also:
-
VIEWER_SESSION_MAP
Map used to link viewers to their session.- See Also:
-
ANNOTATION_DOCUMENT_WIDTH
public static final double ANNOTATION_DOCUMENT_WIDTHDocument width for annotation coordinates (pixels).- See Also:
-
ANNOTATION_DOCUMENT_HEIGHT
public static final double ANNOTATION_DOCUMENT_HEIGHTDocument height for annotation coordinates (pixels).- See Also:
-
ANNOTATION_DEFAULT_RESOLUTION
public static final int ANNOTATION_DEFAULT_RESOLUTIONDPI for annotation coordinats.- See Also:
-
DEFAULT_TIMEOUT_MAIL_LINK
public static final int DEFAULT_TIMEOUT_MAIL_LINKDefault timeout for mail links.- See Also:
-
DEFAULT_HQL_ESCAPE_CHARACTERS_MSSQL
Characters to escape by default on MSSQL databases.- See Also:
-
DEFAULT_HQL_ESCAPE_CHARACTERS_ANSI_SQL
Characters to escape by default on ANSI SQL databases.- See Also:
-
DEFAULT_HQL_ESCAPE_CHAR
public static final char DEFAULT_HQL_ESCAPE_CHARDefault escape-character for HQL like statements.- See Also:
-
DISABLE_HQL_ESCAPE_KEYWORD
Value of the escape-character properties to disable escaping.- See Also:
-
ANNOTATION_FONT_HEIGHT_FACTOR
public static final double ANNOTATION_FONT_HEIGHT_FACTORFactor needed to scale font-heights for the ViewOne annotation ini format. The factor represents a screen dimension of 640/480 pixels.- See Also:
-
ANNOTATION_PPI
public static final double ANNOTATION_PPIA physical inch consists of 72 points.- See Also:
-
ANNOTATION_FACTOR_PX_TO_PT
public static final double ANNOTATION_FACTOR_PX_TO_PTCalculation pixel to Pt as follows.
Pt = px * PxToPtConvertFactor * ResolutionFactor
= px * 0.75 * (ScreenResolution / DocumentResolution)
= px * 0.75 * (72/300)
= px * 0.75 * 0.24
= px * 0.18- See Also:
-
IS_SINGLE_TENANT
Name of session attribute for multi mandant status.- See Also:
-
ACL_STRING_SEPARATOR
Separator used to set multiple ACLs when archiving or updating.- See Also:
-
DB_SETTINGS_SECTION
Name of the section to be used for database-settings. Add user-id to distinguish users.- See Also:
-
DEFAULT_FRACTION_DIGITS
public static final int DEFAULT_FRACTION_DIGITSDefault number of fraction-digits for float-values.- See Also:
-
SHAREBASE_ENABLE
Sharebase settings- See Also:
-
SHAREBASE_API_URL
- See Also:
-
SHAREBASE_BEARER_TOKEN
- See Also:
-
SHAREBASE_PHOENIX_SCHEME_ENABLE
- See Also:
-
SHAREBASE_FETCH_DOC_ENABLE
- See Also:
-
SHAREBASE_DOC_FETCH_INTERVAL_MINS
- See Also:
-
SHAREBASE_DOC_FETCH_EXPIRY_EXPIRY
- See Also:
-
SHAREBASE_DELETE_OLDER_THAN
- See Also:
-
ONEDRIVE_ENABLE
OneDrive settings- See Also:
-
ONEDRIVE_API_URL
- See Also:
-
DUPLICATE_SESSIONS_MODE
- See Also:
-
DUPLICATE_SESSIONS_USER_DIALOG
- See Also:
-
INI_REVISION_DIALOG
RevisionDialog section in ini.- See Also:
-
INI_FORM_TARGET
FormTarget section in ini.- See Also:
-
INI_DOCFLOW
Docflow section in ini.- See Also:
-
INIENTRY_USE_DISPLAY_NAME
Ini-entry to enable displayname in user-dialogs for workflow.- See Also:
-
CONFIG_ENABLEJNDI
System property used to disable JNDI in configuration.- See Also:
-
FORCE_SSO
When set to true will prevent users to login without SSO- See Also:
-
FORCE_LOGIN_SSOBUTTON
When set to true will always show Relogin with SSO Button in login dialog- See Also:
-
JCS_APP_ID
Webclient's name as registered in JCS- See Also:
-
JCS_APP_SECRET
Secret key as registered in JCS- See Also:
-
HYLAND_VIEWER_SECRET
Secret key as registered by HYLAND_VIEWER- See Also:
-
HYLAND_VIEWER_TOKEN_EXPIRATION
Token expiration time for HYLAND_VIEWER request- See Also:
-
BLACKLISTED_MIME_TYPES
Blacklisted MIME types- See Also:
-
SAPERION_SERVICE_ACCOUNT_USERNAME
Service account username- See Also:
-
SAPERION_SERVICE_ACCOUNT_PASSWORD
Service account password- See Also:
-
SAPERION_SERVICE_ACCOUNT_TENANT
Service account tenant- See Also:
-
SAPERION_SERVICE_ACCOUNT_USER_TYPE
Service account user type- See Also:
-
SHAREBASE_SERVICE_ACCOUNT_USERNAME
Service account username- See Also:
-
SHAREBASE_SERVICE_ACCOUNT_PASSWORD
Service account password- See Also:
-
WEBCONFIG_DOWNLOAD_FILTER
Setting for downloading potentially unsafe content from Saperion- See Also:
-
WEBCONFIG_DOWNLOAD_FILTER_LIST
- See Also:
-
WEBCONFIG_RESTRICTED_FILE_DOWNLOAD_ACTION
- See Also:
-
ENABLE_RESULTLIST_DOUBLE_CLICK_OPTION
- See Also:
-
HIDE_DOCUMENT_STRUCTURE_IN_PREVIEW
Setting for hiding document structure in preview window- See Also:
-
MAX_NUMBER_OF_HYRCS_SESSIONS
Maximum number of cached HyRCS sessions- See Also:
-