This shows you the differences between two versions of the page.
en:software:tim:tim.properties [2017/09/26 16:53] Julian Le [Description of the Most Important Parameters] |
en:software:tim:tim.properties [2021/07/01 09:52] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ==== Description ==== | ||
- | |||
- | TIM automatically creates and archives in the tim.properties file in the JBoss directory under | ||
- | |||
- | <code> | ||
- | jboss<versionstandaloneconfiguration | ||
- | </code> | ||
- | |||
- | All parameters that differ from the standards can be changed here. This page describes all possible options. | ||
- | |||
- | <note tip> If changes were made to the file, the server must either be restarted or [[:en:software:tim:alive_servlet|these instructions]] must be followed.</note> | ||
- | |||
- | ==== Description of the Most Important Parameters ==== | ||
- | |||
- | == version == | ||
- | |||
- | This parameter tells which version is currently in the system. A changelog for the user's version is found [[:en:software:tim:changelog|here]]. Changes should not be made to this so that the current status can be defined. | ||
- | |||
- | ---- | ||
- | |||
- | == revision == | ||
- | |||
- | The revision provides the technical, unique identification of the installed version. This should not be changed and is intended for use by the developers of TIM. | ||
- | |||
- | ---- | ||
- | |||
- | == timestamp == | ||
- | |||
- | This parameter shows when the installed version was developed. This entry should not be changed unless the user is instructed by a technician to do so. | ||
- | |||
- | ---- | ||
- | |||
- | == https-protocol == | ||
- | |||
- | The protocol provides the form in which hyperlinks from TIM are sent. This may be either **https** or **http**. http is the standard. | ||
- | |||
- | ---- | ||
- | |||
- | == host == | ||
- | |||
- | The host shows the server on which the system is installed. The host can be overwritten in the [[:en:software:tim:client_profile|client profile]]. | ||
- | |||
- | ---- | ||
- | |||
- | == port == | ||
- | |||
- | This parameter displays the port from which TIM waits for inquiries (i.e.: timserver.corproot.com:**8080**). The port can be overwritten in the [[:en:software:tim:client_profile|client profile]]. | ||
- | |||
- | ---- | ||
- | |||
- | == externalfilepath == | ||
- | |||
- | In the externalfilepath, [[:software:tim:actionhandler:wordtemplatehandler|word templates]] can be searched for if they are saved as relative paths in the process.\\ | ||
- | > the externalfilepath should point to the path **…serverdefaultdeployloom.earloom-portal.warcustom** in almost all cases! | ||
- | |||
- | ---- | ||
- | |||
- | == iotemp == | ||
- | |||
- | This parameter is used to archive temporary data. | ||
- | |||
- | ---- | ||
- | |||
- | == default-client == | ||
- | |||
- | This parameter shows which [[:software:tim:client|clients]] are available for a standard user log-in. More detailed information is available [[:en:software:tim:log_in|here]]. | ||
- | |||
- | ---- | ||
- | |||
- | == Mails == | ||
- | |||
- | Information on creating and managing mails can be found [[:en:software:tim:mail_configuration|here]]. | ||
- | |||
- | ---- | ||
- | |||
- | == Notes == | ||
- | |||
- | [[:software:tim:notes|this page]] describes how process participants can be informed about attached notes. | ||
- | |||
- | <spoiler |Extra Features> | ||
- | |||
- | <note important>The following parameters can hav a big impact on the functionality of TIM. If there are any questions or problems, please contact our support.</note> | ||
- | |||
- | <typo fs:120%;>**Managing the Data Management System (DMS)**</typo> | ||
- | \\ | ||
- | The TIM intern Data Management System manages the documents, which are attached to processes, activities and tasks. The DMS's functionality can be affected using the following parameters in the tim.properties. | ||
- | |||
- | **Documents can only be attached to open tasks or rather at the processstart** \\ | ||
- | The parameter **dms-user-has-tasks** can determine, if documents can only be attached to open tasks or rather to the processstart. The parameter can be set to **true** or **false**. (s. example). | ||
- | <code> | ||
- | dms-user-has-tasks=true | ||
- | </code> | ||
- | |||
- | **Excluding the processmanager from the regulation** It can be useful to exclude processmanagers from this regulation. If the parameter **dms-user-check-processmanager** is set to **true**, it is possible for processmanagers to attach documents at any point in time (s. example). Processmanagers can also delete documents at any point in time. | ||
- | <code> | ||
- | dms-user-check-processmanager=true | ||
- | </code> | ||
- | |||
- | **Prohibiting the editing of documents** The Parameter **dms-prevent-docmod-<pd-name>-<activity-name>** can prevent the editing of documents at a specific activity. Replace <pd-name> and <activity-name> with the corresponding processdefinition and activity name (s. example). Special characters as well as blanks have to be replaced with a **-**. **<activity-name>** can be left out, which leads to preventing the editing for the whole process. (The characters "<" and ">" have to be left out) | ||
- | <code> | ||
- | dms-prevent-docmod-<process-1>-<activity-1>=true | ||
- | </code> | ||
- | |||
- | **Setting the DMS Provider** The parameter **dms-provider** refers to the used DMS system (s. example). | ||
- | <code> | ||
- | dms-provider=sharepoint | ||
- | </code> | ||
- | |||
- | The parameter **dms-provider-username** refers to the user, which is used for signing in into the DMS system. | ||
- | <code> | ||
- | dms-provider-username=timtim_service | ||
- | </code> | ||
- | |||
- | Furthermore the parameter **dms-mainprocess-storage** and **dms-mainprocess-storage-filter** determine how the processstorage is accessed and which data is filtered. | ||
- | <code> | ||
- | dms-mainprocess-storage=read,write | ||
- | </code> | ||
- | |||
- | <code> | ||
- | dms-mainprocess-storage-filter=AnyPrefix% | ||
- | </code> | ||
- | |||
- | <typo fs:120%;>**Cache**</typo> | ||
- | It is possible to automatically empty the brwoser cache for every login by setting the parameter **no-cache** to true. If nothing is stated, the cache will **not** be emptied. | ||
- | <code> | ||
- | no-cache=true | ||
- | </code> | ||
- | |||
- | <typo fs:120%;>**Standard passwords**</typo> | ||
- | |||
- | It is possible to set and edit the standard password for the Superuser and Client-Administrator | ||
- | |||
- | **Standard password Superuser** The parameter ** initpass-super-admin** is used to set the standard password for the superuser, who can create new clients. | ||
- | <code> | ||
- | initpass-super-admin=bestAdmin1337 | ||
- | </code> | ||
- | |||
- | **Standard password sys.support** The parameter **initpass-super-sys.support** determines the password for the sys.support user. | ||
- | |||
- | **Standard password Client-Administrator und User** Every Client is created with a user **admin**. The parameter **initpass-x-admin** determines the passowrd for that user. | ||
- | <code> | ||
- | initpass-x-admin=e!|\|*S1cH3r35*|°455w0|27! | ||
- | </code> | ||
- | |||
- | The parameter **initpass-x-others** determines the standard password for all users that are created in that client. | ||
- | |||
- | <typo fs:120%;>**Client language**</typo>\\ | ||
- | \\ | ||
- | It is possible to set in which languages the TIM-Clients are available. The parameter **available-languages** contains all Clientlanguages, seperated with a semicolon (s. example). | ||
- | <code> | ||
- | available-languages=de-DE,deutsch;en-GB,english (GB);en-US,english (US);es-ES,español;fr-FR,français;nl-NL,nederlands; | ||
- | </code> | ||
- | |||
- | <typo fs:120%;>**Messages in case of external decisions**</typo>\\ | ||
- | \\ | ||
- | The setProcessVariableAndSignalProcessinstanceByTransitionName handler allows to make decisions in the process outside of TIM. It can be determined in the tim.properties, which message is displayed in case of a successful or unsuccessful decision. | ||
- | <code> | ||
- | #signal-succeed-response=Your decision regarding ${SYS.PROCESSDEFINITION_NAME} / ${SYS.PROCESSINSTANCE_NAME} / ${SYS.NODEINSTANCE_NAME} was successfully processed. | ||
- | </code> | ||
- | |||
- | <code> | ||
- | #signal-failed-response=Your decision regarding ${SYS.PROCESSDEFINITION_NAME} / ${SYS.PROCESSINSTANCE_NAME} / ${SYS.NODEINSTANCE_NAME} has not been able to be processed. | ||
- | </code> | ||
- | |||
- | If the corresponding processinstance was already finished or is not existent, it is possible to set corresponding messages with the parameters **signal-failed-pi-ended-response** and **signal-failed-no-pi-response** | ||
- | |||
- | <typo fs:120%;>**Smartform**</typo>\\ | ||
- | \\ | ||
- | In der tim.properties kann festgelegt werden, ob die **TIM Smartform Suite** und das **css Framework Bootstrap** in der Smartform aktiv sein sollen. Dies kann über die Parameter **form-provider** und **form-bootstrap** bestimmt werden. | ||
- | <code> | ||
- | form-provider=com.dooris.cba.providers.CbaFormProvider | ||
- | </code> | ||
- | |||
- | <code> | ||
- | form-bootstrap=false | ||
- | </code> | ||
- | |||
- | <typo fs:120%;>**Notizen in Haupt- und Subprozessen**</typo>\\ | ||
- | \\ | ||
- | Mit dem Parameter **blog-article-inheritance** kann festgelegt werden, wie Notizen eines Hauptprozess in seinen Subprozessen zur Verfügung stehen. Ist der Parameter auf **read** gesetzt, sind Notizen des Hauptprozess in den Subprozessen sichtbar. Auf **write** werden Notizen aus den Subprozessen direkt an den Hauptprozess angehängt, nicht aber an den Subprozess (s. Beispiel). | ||
- | <code> | ||
- | blog-article-inheritance=write | ||
- | </code> | ||
- | |||
- | <typo fs:120%;>**PDF Konvertierung**</typo>\\ | ||
- | \\ | ||
- | Die tim.properties enthält diverse Parameter zur Steuerung der Konvertierung von Dokumenten zu PDFs in TIM. | ||
- | |||
- | **timPdfConverter** \\ | ||
- | Im Parameter **timPdfConverter** wird hinterlegt, welche Kovertierung verwendet wird (z.B. aspose). | ||
- | <code> | ||
- | timPdfConverter=aspose | ||
- | </code> | ||
- | |||
- | **ooHost** \\ | ||
- | Im Parameter **ooHost** wird der Host für den OpenOffice Connector hinterlegt. | ||
- | <code> | ||
- | ooHost=localhost | ||
- | </code> | ||
- | |||
- | **ooPort** \\ | ||
- | Mit **ooPort** wird der Port des OpenOffice Connectors festgelegt. | ||
- | <code> | ||
- | ooPort=8100 | ||
- | </code> | ||
- | |||
- | <typo fs:120%;>**Single Sign On (SSO)**</typo>\\ | ||
- | \\ | ||
- | Mit dem Parameter **registrationForm** kann eine Seite, wenn der angemeldete Nutzer via SSO noch keine Berechtigung auf einen Mandanten hat <s. Beispiel) | ||
- | <code> | ||
- | registrationForm=/loom-portal/super-resource/unauthorized.htm?disposition=inline | ||
- | </code> | ||
- | |||
- | </spoiler> | ||
- | |||