System configurations
- 24 Oct 2022
- 43 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
System configurations
- Updated on 24 Oct 2022
- 43 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
1. The system configuration
The management of the configuration is done via the system page. The configuration gives access to a list of parameters related to certain functionalities of the application. These configurations affect the entire environment, i.e. the collections and all users. 
2. Configurations by tab
2.1 ADVANCED TAB | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Allow to edit annotations on old document version | When this configuration is activated, it is possible to edit the annotations of old versions of a document. | Enabled | It is possible to edit the annotations of old versions of a document. |
| Disabled | It is not possible to edit annotations from older versions of a document. | ||
| Always use interval selection in paginated pages | When this configuration is enabled, the «Select all» button on a paginated page allows to select the interval, regardless of the number of records on the page. | Enabled | The select all button in a paginated page asks you to enter an interval for the records to be selected. |
| Disabled | The select all button in a paginated page selects all results. | ||
| Does multilingual fields need to be fill for all languages | This configuration allows you to make the entry of certain metadata fields mandatory (e.g. the «Title» field of a plan item, a conservation rule, a value field, etc.) in order to facilitate the retrieval of information in a bilingual collection. *The configuration is only effective if the Constellio environment has a bilingual collection. | Enabled | All fields will be mandatory. |
| Disabled | Only the fields in French are mandatory. | ||
| Delete older versions during install | This configuration allows you to remove the versions of Constellio previously installed in your environment (e.g.: version 7.3.1.5, version 7.3.2). *However, in order to maintain the «rollback» mechanism in case of problems during future updates, the Constellio solution must keep the last five (5) versions installed on the server. | Enabled | Removes previous versions during installation. |
| Disabled | Preserves previous versions during installation. | ||
| Never calculate ACL in CMIS services calls (improve performance with CMIS) | This configuration allows the connection of third party applications through CMIS, security is taken into account. (CMIS: interoperability standard facilitating exchanges between content management solutions). *This configuration is intended for IT specialists with piloting skills related to the CMIS standard. | Enabled | Security (ACL) is not taken into account. |
| Disabled | Security (ACL) is taken into account. | ||
| Maximum length of content for parsing (in megaoctets) | This configuration allows the indexing robot to exclude documents with a weight greater than X MB. | Number of Mb Suggested values: 30 Mb* | The maximum size of the content to be indexed will be limited according to this number. |
| Use the copy status entered instead of the parent's copy status if possible | This configuration allows you to enter a different copy status than the parent folder. | Enabled | Assumes the status of a manually entered copy. |
| Disabled | Assumes the status of a copy of the parent file. | ||
| File extensions to exclude from parsing (separated by commas) | This configuration allows you to enter digital document extension types to be ignored during content indexing. | The values entered in this field start with a dot and are separated by commas (e.g. : .mdb, .mp4, .jpeg) | The content will not be indexed for the simple search. |
| Legacy identifiers index (require a reboot, can require more memory) | This configuration considerably speeds up robot executions and record imports, but increases memory consumption. | Enabled | The old identifiers are indexed. |
| Disabled | The old identifiers are not indexed. | ||
| Maximum number of search results that can be selected | This configuration allows, after a search, to select the indicated number of results to execute actions on them. | Number of results | The number of selectable results will be limited according to this number. |
| IP interval that will not send an email to the user that he's connected from a new ip address | Configuration of IP address intervals to be ignored when sending automated email due to a user login from a new IP address. An interval is defined according to a base IP address and the mask size (e.g. 192.168.0.0/16). It is possible to define several intervals by adding the character «;» between each of them (e.g.: 192.168.0.0/16;200.100.3.0/24). | Defined interval | The interval is defined according to a base IP address and the size of the mask. |
| PDFTron license | This configuration allows you to register the license for PDFtron. | License | The license is registered. |
| Remove documents extension | This configuration allows you to remove the extension (e.g.: .txt, .doc) in the «Title» field of a document when it is fed using the metadata extractors (extraction by properties). | Enabled | The title of the metadata record will not include the file extension. |
| Disabled | The title of the metadata record will include the file extension. | ||
| Seize multilingual values | This configuration allows you to display, in an input form, the fields that may be relevant to translate in a bilingual collection (e.g. the «Title» field of a plan item, a conservation rule, a value domain, etc.). *The collection must be multilingual to use this configuration. | Enabled | It will be possible to enter the field in French and English. |
| Disabled | It will be possible to enter the field in one language only. | ||
| Session timeout interval (in minutes) | The number of minutes after which the sessions will be closed if inactive. | Number of minutes | Number of minutes after which the sessions will be closed if inactive. |
| Dynamic configuration of columns of a table (reduce the speed of display of pages) | This configuration allows you to dynamically modify the metadata displayed in some tables. | Enabled | The display of the metadata is done from the table. |
| Disabled | The display of the metadata is based on the metadata schemas. | ||
| Write the connector documents in the transactional log | This configuration allows the operations of the network connectors to be recorded in the transactional logs. | Enabled | The operations of the network connectors will be recorded in the transactional logs. |
| Disabled | The operations of the network connectors will not be recorded in the transactional logs. | ||
2.2 AGENT TAB | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impact |
| Create shortcut to «drop» folder on desktop | This configuration allows you to create a "Constellio" shortcut on the user's workstation (on the desktop) after installing the Agent. The purpose of this functionality is to allow the "Drag n Drop" action on the "Constellio" icon on the workstation in order to import records on the Constellio desktop. *Important: Validate the configurations related to the automatic deletion of files on the workstation when a document is imported with the Agent. | Enabled | The shortcut will be created on the user's computer. |
| Disabled | The shortcut will not be created on the user's computer. | ||
| Agent disabled until first connexion | This configuration displays a new navigation option in the left menu ("Agent" icon). The configuration is used to allow users to download the agent from the Constellio interface. As long as a user has not authenticated with the agent, Constellio considers that he/she is not using it and does not suggest the agent's options. *Requires reconnection to consider changes to this configuration. | Enabled | Constellio will not suggest any option of the agent. As long as the user has not logged in with the agent. |
| Disabled | Constellio will suggest the agent's options even to those who do not use the agent. | ||
| Move imported files in desktop recycle bin | This configuration allows you to automatically place in the operating system's recycle garbage can all documents that have been imported into Constellio after using the Agent. | Enabled | When files are imported, they are moved to the user's recycle garbage can. |
| Disabled | When files are imported, they are not moved to the user's recycle garbage can. | ||
| Authenticate with the web interface | When authenticating, opens a browser tab to the Constellio login page. This setting must be enabled when using multi-factor authentication. | Enabled | Opens a browser tab to the Constellio login page during authentication. |
| Disabled | Does not open a browser tab to the Constellio login page during authentication. | ||
| Retention period for saved files on the user's computer (in days) | This configuration allows you to set the duration of retention of a copy of a borrowed document on the workstation in terms of days. | Number of days Suggested value : 30 days | The retention period (in days) of a copy of a borrowed document will be saved on the user's computer according to the value indicated. |
| Delete files after importing them | If the agent is configured to use the recycle garbage can, the files will be placed in it. | Enabled | The files will be placed in the recycle garbage can when imported. |
| Disabled | The files will not be deleted during the import. | ||
| Download all user's files (if not, they will be dowloaded on opening) | This configuration allows to download all the files borrowed by the user on the workstation. This configuration is for users with multiple workstations. | Enabled | All borrowed files will be downloaded. |
| Disabled | Only borrowed and in-use files will be downloaded. | ||
| Force input of metadata after import | After importing a document into Constellio, the agent will open its edit page in the default browser. | Enabled | The Agent will open the document's edit page after it is imported. |
| Disabled | The Agent will not open an edit page after importing a document. | ||
| Use agent to edit unclassified documents | This configuration allows users to edit unfiled documents in the Constellio Desktop. | Enabled | The office documents will be displayed when using the agent. |
| Disabled | The office documents will not be displayed when using the agent. To access them, you will have to go to the Office section of Constellio. | ||
| Use agent | This configuration allows you to dock the Agent to your Constellio environment. *The agent is automatically docked when you borrow or consult it for the first time in read-only mode. | Enabled | Users will be able to install and use the Constellio agent. |
| Disabled | Users will not be able to install and use the Constellio agent. | ||
| Show a warning when a link is read-only | This configuration provides feedback to the user when the latter consults a document already borrowed by another user. | Enabled | The message is displayed. |
| Disabled | The message is not displayed. | ||
| Allow user switch | This configuration allows users to synchronize their profiles and borrowing history on a computer used by other Constellio users. | Enabled | Multiple users are allowed with the agent. |
| Disabled | The use of a single user is allowed with the agent. | ||
| Duration in hours | Security tokens allow to perform actions (from a technological infrastructure point of view) on the software using the access and permissions of a user account without having access to the latter's password. *The use of security tokens is a concept aimed at information and developers. | Number of hours Suggested value : 10 hours | After the specified number of hours, the user will have to re-authenticate. |
2.3 DISPOSITION TAB | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impact |
| Convert electronic files to PDF format | This configuration makes it possible to systematically convert all types of documents into PDF/A format when changing stages. | Never | The documents will never be converted to PDF/a following their transfer or payment. |
| On deposit | The documents will be converted to PDF/a following their transfer. | ||
| On transfer or deposit | The documents will be converted to PDF/a following their transfer or payment. | ||
| Allow to box active folders | This configuration allows you to display the «Container» field in the input form of an active file. | Enabled | All files can be put in containers. |
| Disabled | Only semi-active and inactive folders can be put into containers. | ||
| Add a year if the calculation of the date is the end of the year | This configuration allows you to add an additional year to the calculation of the retention period for a file created on the day of the end of the fiscal year. | Enabled | One year will be added before the disposition |
| Disabled | The file may be dispositioned | ||
| Allow sorting of folders in decommissioning list | This configuration allows you to change the order of the folders in the tables by pressing the column labels. | Enabled | It is possible to order the columns by different metadata in the tables. |
| Disabled | It is not possible to order the columns by different metadata in the tables. | ||
| Allow modifying archival status and expected dates for folders | This configuration allows you to manually change the value of the «Archival status metadata» in the input form of a file. The action leads to a change in the dates for the calculation of retention periods. | Enabled | Allow to modify the dates for all the files |
| Enabled for imported records | Allows you to modify the dates for all the files imported using Constellio | ||
| Disabled | Does not allow to modify these dates | ||
| Allow users to enter a transfer date even when copy rule does not have a semi-active state | This configuration allows you to enter an actual transfer date even if the retention period does not contain a semi-active period | Enabled | Allows you to enter a duration for the semi-active period |
| Disabled | Does not allow to enter a duration to the semi-active period | ||
| Purge latest version as well if not definitive | This configuration allows, when the «Purge working versions» configuration is activated, to keep all major versions and to transform a last minor version into a major version. Example: a last version of a document is 5.4, this one will become a major version 5.0. and all other so-called major versions will also be kept. | Enabled | Retain only the latest major versions of documents and revert to the latest major version. |
| Disabled | Keeps all major versions of documents and the latest version, even if it is minor. | ||
| Calculated close date | This configuration allows Constellio to automatically add the closing dates for files that are governed by closed retention rules. *A modification causes a reindexing. | Enabled | Constellio adds the number of years specified to the closing date and adds the months required to reach the fiscal year end date. |
| Disabled | Constellio does not calculate any closing date | ||
| Number of calculated close dates (fixed rule) | This configuration allows you to systematically add a buffer year(s) to the closing date for all records subject to a closed retention period. *A change results in a reindexing. | Number of years | Constellio automatically calculates the closing date by adding the number of years specified to the opening date for fixed time periods. |
| -1 to disable the feature | Means that there is no buffer year added to the time frame for closing a file. | ||
| Number of calculated close dates (variable rule) | This configuration allows for the systematic addition of a buffer year(s) to the closing date for all records subject to an open retention period. *A change results in a reindexing | Number of years | Constellio automatically calculates the closing date by adding the specified number of years to the opening date for open periods 888 or 999. |
| -1 to disable the feature | Means that there will be no automated calculation for closing an open deadline file, so the closing of files will have to be done manually before the disposition. | ||
| Number of calculated inactive dates (Open rule) | This configuration allows for the systematic addition of a buffer year(s) at the end of the semi-active stage for all records subject to an open-ended retention period. *A change results in a reindexing. | Number of years | Constellio automatically calculates the disposition date by adding the specified number of years to the expected disposition date for open time periods 888 or 999. |
| -1 to disable the feature | Means that there will be no automated calculation and that the closing of the files must be done manually before the disposition. | ||
| Calculated metadatas based on first part of timeranges | This configuration allows you to define a calculation year for records with an opening year that overlaps two years (e.g., 2017-2018). | Enabled | The calculation will be based on the first year of the interval. |
| Disabled | The calculation will be based on the second year of the interval. | ||
| Number of calculated semi active dates (open rules) | This configuration allows a buffer year(s) to be systematically added at the end of the active stage for all records subject to an open-ended retention period. | Number of years | Constellio automatically calculates the active period by adding the number of years specified in the opening date for open periods 888 or 999. |
| -1 to disable the feature | Means that there will be no automated calculation and that the closing of the files must be done manually before downgrading. | ||
| Close Date required before the end of the year | This configuration allows you to postpone the calculation of retention periods to the following year if a file is created too close to the end of the current year | Number of days | Example: If a file is opened on December 1 and the end of the fiscal year is set for December 31, the value "30" must be entered in the current configuration in order to extend the calculation of the file to the coming year. |
| Complete actual disposition date when creating folder with manual status | This configuration allows you to deduct the date calculation for files that have been imported at a stage other than active, without having a real calculation date (e.g.: file without a real transfer date when the record is declared as being at the semi-active stage) | Enabled | If the archival status is changed, but no dates are entered, the calculation of dates will automatically be based on the expected dates. |
| Disabled | No completion of dates is done automatically | ||
| Reuse boxes | This configuration allows the containers to be kept for reuse for other types of files when they are decommissioned for destruction | Enabled | Containers are not removed. |
| Disabled | Containers are removed. | ||
| PDF format to use when decommissioning | No PDF will be generated if the «Convert electronic documents to PDF» configuration does not allow it. | Convert electronic documents to PDF when decommissioned. | |
| PDF/A | Convert electronic documents to PDF/A when decommissioning. | ||
| Principal copy required | This configuration prevents the creation of a retention rule without a main delay. | Enabled | Retention rules must have a primary deadline. |
| Disabled | Retention rules may only have a time limit for secondary copies. | ||
| Type of copy rule always editable | This configuration allows you to change the copy status of a folder by ignoring the primary holders defined for a given retention rule. | Enabled | The copy status calculated by Constellio can be modified at any time. |
| Disabled | The copy status calculated by Constellio cannot be modified. | ||
| Copy rules always visible in creation form | This configuration allows you to always display the retention rule deadlines in the add record form. | Enabled | Time limits for retention rules are always displayed. |
| Disabled | Time limits for retention rules are not displayed. | ||
| Disposition date | This configuration allows you to specify the date on which the calculation of the time limits of the conservation rules is done. | Close date | The calculation is based on the date the file was closed. |
| Open date | The calculation is based on the date the file was opened. | ||
| Decommissioning list with the table «Selected files» | This configuration displays the «Selected folders» table which defines whether folders are included or excluded in the decommissioning lists. | Enabled | The table will be displayed. |
| Disabled | The table will not be displayed. | ||
| Delete document records on destruction | This configuration allows you to permanently delete the metadata record of a document when it is destroyed inactive. | Enabled | The metadata records of the documents are destroyed during decommissioning. |
| Disabled | Metadata records of the records are retained upon decommissioning. | ||
| Delete folder records on destruction | This configuration allows you to permanently delete the metadata record of a folder when it is destroyed inactive. | Enabled | The metadata records of the folders are destroyed during decommissioning. |
| Disabled | Metadata records of the records are retained upon decommissioning. | ||
| Use actual transfer date to calculate deposit/destruction dates of semi-active folders | This configuration allows retention times to be calculated on actual dates rather than scheduled dates. *A modification leads to a reindexing. | Enabled | The calculation of the deposit and destruction dates is based on the actual date of transfer. |
| Disabled | The calculation of deposit and destruction dates is based on the expected transfer date. | ||
| Include sortable folders in destruction decommissioning lists | If this configuration is not enabled, the files whose final disposition is sorting will only come out in the deposit lists. | Enabled | Files whose final disposition is sorting will go out in the destruction and deposit lists. |
| Disabled | Files whose final disposition is sorting will go out exclusively in the deposit lists. | ||
| A folders category must be related to its rule | This configuration prevents a folder from being created if the selected classification scheme entry is not associated with a retention rule. | Enabled | It is not possible to associate a field in the classification plan if it is not associated with a retention rule. |
| Disabled | A classification plan item can be associated even if it is not associated with a retention rule. | ||
| Is decommissioning type required in containers | This configuration forces the user to select a decommissioning type when creating a container. | Enabled | The «Decommissioning Type» metadata is mandatory in the container creation form. |
| Disabled | The «Decommissioning Type» metadata is not mandatory in the container creation form. | ||
| Linkable category must have approved rules | This configuration allows you to display only the classification plan fields associated with approved retention rules in the input form when creating a record. | Enabled | The categories (classes, subclasses, divisions or subdivisions) of the classification plan are associable only if the retention rule is approved. |
| Disabled | As soon as a plan item is associated with a conservation rule, it is possible to associate it with a file. | ||
| Linkable category must not be root | This configuration prevents the classification of files at the first level of the classification plan. | Enabled | The user cannot associate folders with the root levels of the plan. |
| Disabled | The user can associate files in all the headings of the classification plan. | ||
| Purge minor versions | This configuration allows you to remove minor versions of documents during decommissioning. | Never | Minor versions of a document will never be deleted upon decommissioning. |
| On deposit | Minor versions of a document will be deleted upon decommissioning to inactive. | ||
| On transfer or deposit | Minor versions of a document will be deleted upon decommissioning to semi-active or inactive. | ||
| Mixed boxes | This configuration allows files with different archival status or from different administrative units to be contained. | Enabled | Allows you to create containers with files belonging to several administrative units and archival statues. |
| Disabled | Allows you to create containers with a single administrative unit. | ||
| Anticipation of decommissioning - Time in days to which records can be decommissioned before the scheduled date | This configuration allows you to choose the number of days that files can be decommissioned before the scheduled date. | Number of days | Example: If the decommissioning date for a file is set for December 31 and a value of «30» is entered in this configuration, the file will be decommissionable on December 1. |
| Populate the field «Organisation name» with a slip with the collection | This configuration allows you to define the information indicated in the «Organization Name» field of a slip. | Enabled | The «Organization Name» field of a docket indicates the name of the collection. |
| Disabled | The «Organization Name» field on a docket indicates the name of the organization. | ||
| Populate the field «Year of disposition» with the smallest date planned with whithin those files | This configuration allows you to define the information indicated in the «Year of disposition» field of a slip. | Enabled | The «Disposition Year» field of a docket indicates the smallest date of its records. |
| Disabled | The «Disposition Year» field of a docket indicates the biggest date of its records. | ||
| Require approval for closing | This configuration allows you to require approval when adding a closing date to a file. *Approval is done by a user with permission to approve a decommissioned list. | Enabled | Approval is required. |
| Disabled | Approval is not required. | ||
| Require approval for deposit from active | This configuration allows you to require approval in order to deposit an active file (e.g. 2-0-C). *Approval is done by a user with permission to approve a decommissioned list. | Enabled | Approval is required. |
| Disabled | Approval is not required. | ||
| Require approval for deposit from semi-active | This configuration requires approval in order to deposit a semi-active file. *Approval is done by a user with permission to approve a decommissioned list. | Enabled | Approval is required. |
| Disabled | Approval is not required. | ||
| Require approval for destruction from active | This configuration allows you to require approval in order to destroy an active file (2-0-D). *Approval is done by a user with permission to approve a decommissioned list. | Enabled | Approval is required. |
| Disabled | Approval is not required. | ||
| Require approval for destruction from semi-active | This configuration allows you to require approval in order to destroy a semi-active file (2-0-D). *Approval is done by a user with permission to approve a decommissioned list. | Enabled | Approval is required. |
| Disabled | Approval is not required. | ||
| Require approval for transfer to semi-active | This configuration allows you to require approval during a decommissioned operation. *Approval is done by a user with permission to approve a decommissioned list. | Enabled | Approval is required. |
| Disabled | Approval is not required. | ||
| Forbid use of retention rules that are not approved | This configuration allows you to decommission a sub-folder without having to decommission its parent folder. | Enabled | The subfolder is decommissioned separately from its parent folder. |
| Disabled | The subfolder is not decommissioned separately from its parent folder. | ||
| Subfolders are decommissioned separately | This configuration allows to take into consideration the mechanics related to the use of uniform subdivisions. | Enabled | It is possible to configure and use uniform subdivisions. |
| Disabled | Uniform subdivisions cannot be configured and used. | ||
| End of year date | This configuration allows you to set the default value on the last day of a calculation year. | Month and Day MM/DD | Files to be decommissioned later this year will all be carried forward to that date. Example: If the date 2015/12/31 is entered, a file that could be decommissioned on 10/01 will be decommissioned on 2015/12/31. |
2.4 ICAP SCAN TAB | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| ICAP response allowed timeout | This configuration allows you to define the maximum waiting time to obtain a response from the ICAP server. | Number in milliseconds | After the time limit, the system prevents the document from being filed. |
| Enabled | This configuration enables the ICAP protocol. | Enabled | The ICAP protocol is enabled. |
| Disabled | The ICAP protocol is disabled. | ||
| ICAP server URL Address | This configuration allows you to enter the URL of the ICAP server. | URL address | The address of your ICAP server. |
2.5 OFFICE 365 | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Azure tenant ID | This configuration allows you to enter the organization's Azure tenant ID. | Azure tenant ID | Allows you to enter the organization's Azure tenant ID. |
| Include or exclude messages from channels when importing or archiving Office 365 | This configuration allows you to indicate that when importing the O365 channels, the messages of the latter are archived or only the documents. | Import messages | Allows you to import messages. |
| Do not import messages | Do not import the messages. | ||
| No value selected | No value selected | ||
| Application ID | This configuration allows you to enter the Azure application ID for using Office 365 in Constellio. | Application ID | Enter the Azure application ID for using Office 365 in Constellio. |
| Customer secrecy | This configuration captures the Azure application client secret for using Office 365 in Constellio. | Customer secrecy | Enter the client secret of the Azure application for use. |
Office 365 tab
This tab is only available in configurations when the 365 Space feature is installed in the environment.
2.6 Others | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Allow comments to be added with read-only permission | This configuration allows users with read-only access to add/delete comments on the record card. | Enabled | Users with read-only access can add or delete comments. |
| Disabled | Users with read-only access cannot add or delete comments. | ||
| Add record ID in emails sent by Constellio | This configuration allows you to add in brackets the unique identifiers of records classified in Constellio. | Enabled | The ids are added in the emails. |
| Disabled | The ids are not added in the emails. | ||
| Appened (copy) to the title of ducplicated records | This configuration allows you to add (Copy) to the title of duplicated records. | Enabled | Allows you to add (Copy) to the title of duplicated records. |
| Disabled | Does not add anything when duplicating records. | ||
| Allow category authorizations | Does not add anything when duplicating records. | Enabled | Activates the authorizations for the fields in the plan. |
| Disabled | Do not activate the authorizations for the plan fields. | ||
| Force to confirm before editting | This configuration forces a confirmation before the modification of a record. | Enabled | Force a confirmation before the modification. |
| Disabled | Do not force a confirmation before the modification. | ||
| Authentication page image | This configuration allows you to add a custom image on the authentication page (login) of the Constellio environment. *Important: You must take into consideration that the added image is not automatically resized by Constellio. | An image file (.jpeg, .png, .gif) | The image of the authentication page is edited. |
| Number of loaded items in autocomplete fields (maximum of 100, may decrease performance) | This configuration allows you to define the maximum number of suggestions to be displayed below an input field. *This configuration only applies to metadata fields with the "Autocomplete" option enabled. | Number of items | The number of items displayed is limited according to this number. |
| Maximum number of records that can be modified using a batch process | This setting allows you to define a maximum number of records that can be processed in a batch at a time. If you do not want to set a maximum number, keep the value -1. | Number of records | The value entered determines the maximum number of records that can be processed in a batch at one time. |
| Folders borrow duration (in days) | This configuration allows you to define the default loan duration for a document. If you don't want to set a loan duration, keep the value -1. | Number of days | The value entered determines the default days entered in the loan form. |
| Borrow the document after its creation | This configuration allows you to automatically assign a loan following the creation of a document via the « Create a document » feature in the Constellio actions menu. | Enabled | The document will be automatically borrowed by its creator. |
| Disabled | Le document ne sera pas emprunté. | ||
| Rich text editor toolbar configuration | This configuration allows you to define the default display options for a rich text field. *It is best to consult the Constellio team before changing these settings. | Consult the Constellio team | This changes the options offered to the user in the rich text fields. For example: for rich text metadata. |
| Time limit befire deleting notification (in days) | Notifications will be present in the notification panel during this time, after that time limit, they will be removed. | Number of days | Corresponds to the number of days before notifications are deleted. |
| Constellio server link | This configuration allows you to define the default URL for your Constellio environment. *Important : You must change the default value when you put your environment into production. To make the change, replace the value in this field with the first elements of your URL. | http://[your URL]/constellio/ | This influences the creation of links in Constellio. For example: when publishing a document, creating a security token or hyperlinks/buttons when sending an email. |
| http://[your URL]:8080/constellio/ | |||
| https://[your URL]/constellio/ | |||
| PDF/A format | This configuration allows you to determine the type of PDF/A format to use in Constellio. | PDF/A-1 | The format used is PDF/A-1. |
| PDF/A-2 | The format used is PDF/A-2. | ||
| Enable automatic creation of permissions for objects linked to a task | This configuration allows you to give a user temporary access to a record linked to a task. As long as the task is open, the user will be able to consult the record. | Enabled | The user will be able to view the record, without having the required access. |
| Disabled | The user will not be able to view the record, without having the required access. | ||
| Date format | This configuration allows you to configure the format of the « Date » metadata displayed in the application. | Dayr = DD Month = MM Year = YYYY | Attention! : Not capitalizing the month format (MM) can cause problems in Constellio, since the lower case (mm) refers to minutes. |
| Date and time format | This configuration allows you to configure the format of the « Date and time » metadata displayed in the application. | Day =DD Month = MM Year =YYYY Hour = HH Minute = mm Second = ss | Attention! : It is important to respect upper and lower case in Constellio formats, since this changes the meanings and then refers to other data. |
| Parsing | This configuration allows you to determine whether the data analysis is done during the backup or after it. *Data analysis allows to find a document by a full text search on the file contents. | Performed during backup | Data analysis is performed during backup. |
| Performed in the background after the backup | Data analysis is performed in the background after saving. | ||
| Start tab | This configuration allows you to define the tab that is displayed by default on the Constellio homepage. Each user can configure the tab they want in « Edit my profile » . | Taxonomies | Virtual spaces |
| lastViewedFolders | Folders activity | ||
| lastViewedDocuments | Documents activity | ||
| checkedOutDocuments | Borrowed documents | ||
| Default tab in folder display | This configuration allows you to define the tab that is displayed by default when consulting a file. Each user can configure the tab they want in « Edit my profile » . | C | Content |
| M | Metadata | ||
| Default display mode | This configuration allows to choose the default display mode of views | List view | The grouped data will be displayed as a list. |
| table view | The grouped data will be displayed as a table. | ||
| Default taxonomy | This configuration allows you to define the default taxonomy that is displayed in the « Virtual spaces » section | admUnits | Department |
| Plan | Classification plan | ||
| Network shares | |||
| Documents borrow duration (in days) | This configuration allows you to define the default borrowing duration for a document. If you do not want to set a borrowing period, keep the value -1. | Number of days | Refers to the number of days a document is borrowed. |
| Choice of document type | This configuration allows when adding a document to a folder to limit the types of documents linked to the retention rule if document types have been defined. | Limit to the record types of the file retention rule (even if the rule has no types) | The creation of records is limited to the types defined in the retention rule. If the rule does not have a type, it will be impossible to create records in the folders associated with that rule. |
| Limit to the record types of the file retention rule (unless the rule has no types) | The creation of records is limited to the types defined in the retention rule. If the rule does not have a type, it will be possible to add documents in the folders associated with this rule. | ||
| Allow to choose any type of document. | It is possible to associate any type of document with a folder associated with this rule, even if there are types associated with it. | ||
| Enable calculation of storage's space title | This configuration allows to define the titles of the storage spaces from the code of all the parents and the one being created. | Enabled | The calculation of the title is done automatically. |
| Disabled | The creator must define a title. | ||
| Enable thumbnail generation (reindexing required) | This configuration allows you to display document thumbnails. | Enabled | The thumbnails will be displayed. |
| Disabled | The thumbnails will not be displayed. | ||
| Enable illegal characters validation | This configuration makes it possible to prevent the entry of the characters \/*:?"&<> in titles, codes and abbreviations. | Enabled | Prevents the capture of illegal characters. |
| Disabled | Allows the capture of illegal characters. | ||
| Automatically enter the department of the new files and containers. | This configuration allows you to automatically add a value in the «Department» field when creating a record (folder, document, container, task). *Important: The value is set based on the accesses assigned to a user. Assignment errors may occur if the user has access to multiple departments. | Enabled | The department is entered automatically. |
| Disabled | The department is not entered automatically. | ||
| Generated email format | This configuration allows you to modify the generated email formats. | Plain text | The emails will be generated in plain text. |
| Html | The emails will be generated in html. | ||
| Inheritance on groups authorizations | This configuration allows to define the inheritance logic of the authorizations. | From parent group to children group | Permissions will be inherited from parent groups to children groups. |
| From children group to parent group | Permissions will be inherited from children groups to parent groups. | ||
| Hide leading zeros when displaying the ID metadata | This configuration allows you to hide leading zeros when displaying the ID metadata. | Enabled | Hides leading zeros when displaying identification metadata. |
| Disabled | Does not hide leading zeros when displaying the ID metadata. | ||
| Include contents in savestate (not recommended if there are more than 100 documents) | This configuration allows to include the documents in the export of savestate. *This advanced feature is dedicated to IT specialists and the Constellio support team. | Enabled | The .zip file of the savestate will include the documents. |
| Disabled | Le fichier .zip du system state n'inclura pas les documents. | ||
| Fill the « From » field in the generated emails | This configuration allows the «From» field to be filled in when preparing an email from the Constellio interface. | Enabled | The «From» field is filled in when preparing an email. |
| Disabled | The «From» field is not filled in when preparing an email. | ||
| Number of loaded items in trees (maximum of 100, may decrease performance) | This configuration allows you to limit the number of records visible by default in the home screen. | Number of items | The specified value limits the number of items that appears in the trees. |
| Log file and document consultations with CMIS | This configuration allows you to log file and document consultations made with CMIS. | Enabled | Consultations of files and documents with CMIS will be logged. |
| Disabled | Consultations of files and documents with CMIS will be logged. | ||
| Logo (requires reconnection) | This configuration allows you to change the logo in the upper left corner of the Constellio interface. *Important: the suggested size for the image is 406 pixels by 60 pixels (banner size). | An image file (.jpeg, .png, .gif) | The logo displayed will be the one you have inserted in this field. |
| Target of the logo link | This configuration allows you to define a URL to redirect the user to another web page when he clicks on the image of the authentication page. | URL Link | The logo on the top left will take you to the link in this field. |
| Major version when creating new file | This configuration allows you to assign version 1.0 for all documents created using the « Create a document » function in the Constellio actions menu. | Enabled | Version 10 will be assigned to documents created using the « Create a document » function in the Constellio actions menu. |
| Disabled | Version 0.1 will be assigned to documents created using the « Create a document» function in the Constellio actions menu. | ||
| Priority when populating metadata | This configuration allows you to determine the order of prioritization for populating the metadata when automatically extracting the title in the document import. | Styles : For a Word document, the style created in the Word document will be imported and taken into account first. | Example: For the choice Styles -> Regular expressions -> Properties, Constellio will extract in the following order if the data are available.
|
| File name : The file name will be used. | |||
| Properties : The title defined in the properties will be used. | |||
| Miltivalue metadata delimiter | This configuration allows you to select a delimiter for the display of multivalue metadata. | Semicolon (;) | Selects the semicolon as the delimiter for the display of multivalue metadata. |
| Comma (,) | Selects the comma as the delimiter for the display of multivalue metadata. | ||
| Requires a reason before deleting documents | This configuration allows you to require a reason to be entered before deleting documents. | Enabled | A reason must be entered before deleting a document. |
| Disabled | You will not be asked to enter a reason before deleting a document. | ||
| Requires a reason before deleting folders or favorites | This configuration allows you to require a reason to be entered before deleting folders or favorites. | Enables | A reason must be entered before deleting folders or favorites. |
| Disabled | You will not be asked to enter a reason before deleting folders or favorites. | ||
| Show old document format on document creation | This configuration allows to display the templates of the old formats when creating a document. | Enabled | Displays old format templates when creating documents. |
| Disabled | Does not display old format templates when creating documents. | ||
| Open holder | This configuration allows the user to choose the copy status when creating a folder, despite the copy status defined by the retention rule. | Enabled | The user can choose the copy status of a record regardless of what is written in the retention rule. |
| Disabled | Constellio automatically calculates the copy status from the holder of the conservation rule. | ||
| Privacy policy (PDF) | This configuration allows you to add an internal privacy policy. | File.pdf | A window will appear when each user logs in. The user must agree to the privacy policy, otherwise the user will not be able to log in. |
| Start and end date are required to publish a documents | This configuration requires the entry of a start and end date to publish a document. | Enabled | Requires the entry of a start and end date to publish a document. |
| Disabled | No need to enter a start and end date to publish a document. | ||
| Time limit before sending notification email (in minutes) | If a notification is not read by a user, the system will send an email to that user after this time. | Number of days | After the number of days have passed without the notification being read by the user, an email will be sent to the user. |
| Start and end date are required to share a folder or document | This configuration forces the entry of a start and end date to share a folder or a document. | Enabled | Requires entering a start and end date to share a folder or document. |
| Disabled | Does not require the entry of a start and end date to share a folder or a document. | ||
| Display message to every user (PDF) | The message is displayed when the user connects to Constellio. | File | The dropped file will be displayed when a user logs into Constellio. |
| Allocated space for user documents in MB (-1 means no limit) | This configuration allows you to limit the number of records placed in the Constellio desktop, depending on the size of the documents. | Number of MB | The number indicated limits the number of documents (in MB) in the office. |
| Taxonomy order, separated by commas | This configuration allows you to define the order of the tabs displayed by default on the Constellio home page. Each user can configure the order of the tabs in « Edit my profile ». | admUnits | Departments |
| plan | Categories | ||
| containers | Storage spaces | ||
| smbFolders | File shares | ||
| sharepointFolders | Sharepoint site | ||
| Priority when populating title metadata | This configuration allows you to specify the order in which the title metadata will be extracted when importing documents. To do this, the Metadata Extractors module must be set up. | Styles : For a Word document, the style created in the Word document will be imported and taken into account first. | Example: For the choice Styles -> Regular expressions -> Properties, Constellio will extract in the following order if the data are available:
If there is no data in the styles and regular expressions, Constellio will automatically export the property data. |
| File name : The file name will be used. | |||
| Properties : The title defined in the properties will be used. | |||
| Time limit between sending and saving for minor saving | This configuration allows you to define a refresh time for changes made to records. | Number of seconds | The number of seconds specified will be applied to the refresh period. |
| Number of days besore trash elements delete | This configuration allows you to define a maximum number of days for keeping records in the recycle garbage can. | Number of days | After the period (in days) has passed, the records are permanently deleted. |
| Show user roles in the authorizations | This configuration allows when defining the sharing of a record to see the role of each user. | Enabled | User roles are displayed in the sharing page. |
| Disabled | User roles are not displayed in the sharing page. | ||
| Group user tutle pattern | This configuration allows you to define the order in which user's names are displayed. | ${firstName} | First Name |
| ${lastName} | Family Name | ||
| ${email} | |||
| ${username} | User Name | ||
2.7 Reports | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Add a statistics report to the available options | This configuration allows you to have an additional statistics report, in the « generate a report» option of the advanced search. | Enabled | The statistics report will be available. |
| Disabled | The statistics report will not be available. | ||
| Remove brackets in Excel reports | This configuration allows to remove the brackets in the Excel reports | Enabled | Remove brackets in Excel reports |
| Disabled | Do not remove brackets in Excel reports | ||
| Remove tabulations and line breaks in event csv reports | This configuration allows you to remove tabs and line breaks from the « details » column of audit csv reports (document, folder and task modification reports). | Enabled | The tabulation is removed in .csv. reports. |
| Disabled | The tabulation is not removed in .csv. reports | ||
| Sorting metadata for labels and metadata reports | This configuration is used to choose the metadata on which to sort the multi-value reference fields with alphabetical sorting. This is only effective with metadata labels and PDF reports. | Title | The sorting metadata for labels and metadata reports is «Title» . |
| Code | The sorting metadata for labels and metadata reports is «Code». | ||
| Template version for reports generation | This configuration is used to determine the template version to be used for reporting. | Version 1 (Constellio 5+) | The template version used for report generation is version 1 (Constellio 5+). |
| Version 2 (Constellio 10+) | The template version used for report generation is version 2 (Constellio 10+). | ||
2.7 REST API | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Allowed origins for CORS (restart required) | Allows you to restrict the allowed origins for CORS. The scheme (http or https) and port (if required) must be included for each origin. | Comma separated list of origins (ex.: http://[your URL]:7070,https://[your URL]) | The CORS protocol will be enabled only for the specified origins. |
| Date format (REST API) | Allows you to customize the format to be used for the dates returned in the responses. | Date format (ex. : yyyy-MM-dd) | Uses the specified date format. If empty, the default format is used. |
| Date and time format ( REST API ) | Allows you to customize the format to be used for the dates with time returned in the responses. | Date/time format (ex.: yyyy-MM-dd HH:mm:ss) | Determines the date and time format (API REST). |
| REST API links | Allows you to restrict the domains that can use the REST API. | List of domains (without schema) separated by a semicolon (ex.: mydomain.com;mydomain2.com) | The rest api will only accept requests from the specified domains. |
2.8 Search | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Separation criterion for autocompletion | This configuration allows to choose how the autocompletion results will be available. | Space | Selon votre sélection, cela dictera les critères d'autocomplétion dans la recherche. For example: "Michel_Tremblay, summer is nearly over." If the value is "Space and underscore". "Michel" and "Tremblay" would be available to search separately. |
| Space and underscore | |||
| Space and comma | |||
| Space, comma and underscore | |||
| Space and apostrophe | |||
| Sapce, apostrophe and underscore | |||
| Space, comma, underscore and apostrophe | |||
| Display only summary metadatas in searches and tables | This configuration allows to have more performance by displaying only summary metadata in searches and tables. | Enabled | Only summary metadata will be displayed in the table view of the advanced search. |
| Disabled | All metadata will be displayed in the table view of the advanced search. | ||
| Enable the display of inactive schemas in advanced search | This configuration allows inactive metadata schemas to be displayed in the advanced search. | Enabled | Inactive metadata schemas will be displayed in the advanced search. |
| Disabled | Inactive metadata schemas will not be displayed in the advanced search. | ||
| Lazy loaded search results | This configuration allows you to change the way the search results are displayed. | Enabled | The search results screen displays the facets before the search results. |
| Disabled | The search results screen displays the facets along with the search results. | ||
| No links for search results metadatas (improve search performance) | This configuration allows you to remove links to folders and containers in the metadata of search results. | Enabled | The links are clickable. |
| Disabled | The links are not clickable. | ||
| Consider the whitespaces from simple search as ANDs | This configuration allows you to modify the mechanics of the simple search. | Enabled | The simple search considers the spaces between the search terms as AND. |
| Disabled | The simple search considers the spaces between the search terms as ORs. | ||
| Show copied metadata separately in advanced search | This configuration allows you to remove all copied metadata from the list of available metadata in a search criteria | Enabled | The copied metadata are removed from the list of available metadata in a search criteria. These metadata will then be accessible via their reference metadata by choosing one of the 2 new search operators Contains and Does not contain. When one of these two operators is selected, a drop-down menu is displayed to choose a copied metadata that has the selected metadata as reference and a component to enter the value of the copied metadata to search. (For example, search on the type Document or the metadata Folder contains an opening date X). |
| Disabled | The copied metadata are directly available in the search criteria. | ||
| Number the search results | This configuration allows you to number the search results. | Enabled | The results will be numbered. |
| Disabled | The results will not be numbered. | ||
| Sort by | This configuration allows you to define a default sort for simple or advanced search results. | Relevence | The most relevant results are displayed first. Relevance is calculated according to an algorithm. |
| Path (asc) | The search results will display the full path of a folder. *For example: Unit A - Sub-Unit B - Folder - Sub-Folder X | ||
| Path (des) | The search results will display the path in descending order. | ||
| ID (asc) | The results will be sorted by ID in ascending order. | ||
| ID (des) | The results will be sorted by ID in descending order. | ||
| Creation date (asc) | The results will be sorted by creation date in ascending order. | ||
| Creation date (des) | The results will be sorted by creation date in descending order. | ||
| Modification date (asc) | The results will be sorted by modification date in ascending order. | ||
| Modification date (des) | The results will be sorted by modification date in descending order. | ||
2.9 SIGNATURE | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| PDF format to use after signing a document | This configuration allows you to choose the PDF format into which a document will be converted after certification. | The document is converted to PDF. | |
| PDF/A | The document is converted to PDF/A. | ||
| Disable external signatures | This configuration allows you to choose to disable external signatures while keeping internal signatures. | Enabled | Enables external signatures. |
| Disabled | Disables external signatures. | ||
| Signed document consulation duration (in days) | This configuration allows you to define the duration in days for a user who is part of the signature project to consult the document after another user has signed it. | Number of days | Determines the duration in days for a user who is part of the signature project to be able to view the document after a user has signed. |
| Signing keystore | This configuration allows you to add the signing keystore. This certificate allows to sign and certify PDF documents. | File | Allows to sign and certify PDF documents. |
| Signing keystore passeword | This configuration allows you to add the password of the signing keystore. The password must be the same for the keystore as well as for the keys inside. | Alphanumeric and numeric | Allows to use thesigning keystore. |
Signature tab
This tab is only available in the configurations when the Electronic Signature feature is installed in the environment.
2.10 SYSTEM ANALYSIS | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Validate license | This configuration enables or disables the license check when scanning the system status. | Enabled | The license will be checked. |
| Disabled | The license will not be checked. | ||
| Verify RAM allocation | This configuration enables or disables the checking of RAM allocation when analyzing the system state. This includes RAM allocation for Constellio, Solr, non-Constellio services and the total amount of memory on the server. | Enabled | The RAM allocation will be checked. |
| Disabled | RAM allocation will not be checked. | ||
| Verify disk space /opt usage | This configuration enables or disables checking the percentage of disk space usage for the directory/opt | Enabled | The disk space usage of the directory/opt will be checked. |
| Disabled | The disk space usage of the directory/opt will not be checked. | ||
| Check the disk space usage of the directory/var/solr | This configuration enables or disables the disk space usage percentage check for the directory/val/solr. | Enabled | The disk space usage of the directory/var/solr will be checked. |
| Disabled | The disk space usage of the directory/var/solr will not be checked. | ||
2.11 TASKS | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Default due date when creating a task | A negative value indicates not to fill in a default value. Zero "0" means the current date and a positive value means the current day plus the number indicated in day. | Negative value | Do not enter a default value for the due date. |
| Zero «0» | The current date as the due date. | ||
| Positive value | The current day plus the number indicated in day as the due date. | ||
| Activate comments in emails | Enable comments in task emails (reminders, assignment changes, etc.) | Enabled | Displays all comments separated by the username and date of the comment in the task emails. |
| Disabled | Do not display any comments in the task emails. | ||
2.12 TREES | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Display boxes | This configuration allows you to display the containers and taxonomies of the home screen (virtual spaces). | Enabled | The containers will be displayed in the trees (classification plan, departments) of the virtual spaces. |
| Disabled | The containers will not be displayed in the trees (classification plan, department) of the virtual spaces. | ||
| Display deposit records | This configuration allows you to display the deposit files in the home screen (virtual spaces). | Enabled | The deposited files will be displayed in the trees (classification plan, departments) of the virtual spaces. |
| Disabled | The deposited files will not be displayed in the trees (classification plan, departments) of the virtual spaces. | ||
| Display destroyed records | This configuration allows to display the destroyed folders in the home screen (virtual spaces). | Enabled | The destroyed records will be displayed in the trees (classification plan, departments) of the virtual spaces. |
| Disabled | The destroyed records will not be displayed in the trees (classification plan, departments) of the virtual spaces. | ||
| Display semiactive records | This configuration allows to display the semiactive records in the home screen (virtual spaces). | Enabled | The semiactive records will be displayed in the trees (classification plan, departments) of the virtual spaces. |
| Disabled | The semiactive records will not be displayed in the trees (classification plan, departments) of the virtual spaces. | ||
| Only display the opening triangle when the folder has content (major decrease in tree display speed) | This configuration allows the opening triangle to be displayed when the folder has content. However, there is a major decrease in the speed of tree display in this case. | Enabled | Shows the opening triangle only when there is content. |
| Disabled | Does not display the opening triangle when there is no content. | ||
2.13 SCANNING | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Enabled OCR | This configuration enables OCR. | Enabled | OCR is enabled. |
| Disabled | OCR is disabled | ||
| Color mode | This configuration determines the color mode of the scanner. | Color | The color mode is «Color» ". |
| Black and white | The color mode «Black and white». | ||
| Greyscale | The color mode is «Grayscale». | ||
| Scanning side | This configuration is used to determine the scanning side. | Single sided | The scanning side is «Single sided». |
| Double sided | The scanning side is «Double sided». | ||
| Document source | This configuration allows you to determine the source of the document. | Flatbed | The source of the document is «Flatbed». |
| Tray | The source of the document is «Tray». | ||
| Display the scanner's user interface | This configuration displays the scanner interface. | Enabled | The scanner interface is displayed. |
| Disabled | The scanner interface is not displayed. | ||
| Image resolution (dpi) | This setting allows you to enter the image resolution. The common resolutions are 75, 100, 150, 200, 240, 300, 400, 600, 1200). | Number | Determines the image resolution. |
Scanning tab
This tab is only available in the configurations when the scanning functionality is installed in the environment.
2.14 Webhook | |||
|---|---|---|---|
| Configuration | Description | Possible values | Impacts |
| Delay for sending webhooks (seconds) (restart required) | The interval in seconds at which webhook requests should be sent The interval in seconds at which webhook requests should be sent | Integer (Default value: 300) | Every x seconds, notifications for all actions for which a webhook has been defined that have been performed since the last sending will be sent |
| Webhooks enabled | Allows you to enable or disable the sending of requests for all webhooks | Enabled | Webhook notifications will be sent |
| Disabled | No webhook notification will be sent | ||
| Maximum number of attemps for sending webhook notifications | Maximum number of attempts to send a request (Enter the value -1 to not set a limit) | Integer (default value: 3) | When the number of retries of a webhook notification exceeds this value, this notification will be removed from the retry list and will not be sent |
| Maximum number of attempts to add webhooks to the retry queue | Number of send attempts for a webhook request from which requests are moved to the retry queue (slow queue) | Integer (default value: -1) | After x webhook notifications with a negative response, the notification will be added to the dunning queue |
| Delay for send webhooks from the retry queue (seconds) (restart required) | The interval in seconds at which failed requests should be retried | Integer (Default value: 3600) | Every x seconds, the webhook notifications in the retry queue will be retried. If successful, the notification will then be removed from the retry queue. If not, it will be kept in the retry list and retried at the next interval. |
| Secret token (webhooks) | Allows you to define a secret token to include in webhook requests to validate their origin | String of characters | Adds a "secretToken" field with the defined value to all webhook notifications |
Was this article helpful?