Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
software:tim:tim.properties [2016/12/08 11:54] jan.mayer [Erklärung der wichtigsten Parameter] |
software:tim:tim.properties [2017/11/27 16:02] Maximilian Neumaier |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
==== Beschreibung ==== | ==== Beschreibung ==== | ||
+ | |||
Die Datei tim.properties wird von TIM automatisch im JBoss Verzeichnis unter | Die Datei tim.properties wird von TIM automatisch im JBoss Verzeichnis unter | ||
- | <code> \jboss<version\standalone\configuration\</code> | ||
- | erstellt und abgelegt. Alle Parameter die vom Standard abweichen, können hier geändert werden. Alle möglichen Optionen werden auf dieser Seite beschrieben. | ||
- | <note tip>Falls Änderungen an der Datei vorgenommen wurden, muss entweder der Server neu gestartet werden oder [[software:tim:alive_servlet|diese Anleitung]] befolgt werden.</note> | + | <code> |
+ | jboss<versionstandaloneconfiguration | ||
+ | </code> | ||
+ | erstellt und abgelegt. Alle Parameter die vom Standard abweichen, können hier geändert werden. Alle möglichen Optionen werden auf dieser Seite beschrieben. | ||
+ | |||
+ | <note tip>Falls Änderungen an der Datei vorgenommen wurden, muss entweder der Server neu gestartet werden oder [[:software:tim:alive_servlet|diese Anleitung]] befolgt werden.</note> | ||
===== Erklärung der wichtigsten Parameter ===== | ===== Erklärung der wichtigsten Parameter ===== | ||
- | \\ == version == | + | |
- | Dieser Parameter gibt an, welche Version auf dem System vorliegt. Ein Changelog zu Ihrer Version findet man [[software:tim:changelog|hier]]. Diese sollte nicht geändert werden, um den aktuellen Stand bestimmen zu können. | + | == version == |
+ | |||
+ | Dieser Parameter gibt an, welche Version auf dem System vorliegt. Ein Changelog zu Ihrer Version findet man [[:software:tim:changelog|hier]]. Diese sollte nicht geändert werden, um den aktuellen Stand bestimmen zu können. | ||
---- | ---- | ||
== revision == | == revision == | ||
+ | |||
Die Revision gibt die Technische eindeutige Identifikation zu der Version, die Installiert ist. Diese sollte nicht geändert werden und ist für die Entwickler von TIM gedacht. | Die Revision gibt die Technische eindeutige Identifikation zu der Version, die Installiert ist. Diese sollte nicht geändert werden und ist für die Entwickler von TIM gedacht. | ||
Zeile 19: | Zeile 26: | ||
== timestamp == | == timestamp == | ||
+ | |||
Dieser Parameter gibt an, wann die installierte Version erstellt wurde. Dieser Eintrag sollte nicht geändert werden, ausser Sie werden von einem Techniker dazu angewiesen. | Dieser Parameter gibt an, wann die installierte Version erstellt wurde. Dieser Eintrag sollte nicht geändert werden, ausser Sie werden von einem Techniker dazu angewiesen. | ||
Zeile 24: | Zeile 32: | ||
== https-protocol == | == https-protocol == | ||
+ | |||
Gibt an, mit welchem Protokoll die Hyperlinks aus TIM verschickt werden. Entweder **https** oder **http**. Standard ist http. | Gibt an, mit welchem Protokoll die Hyperlinks aus TIM verschickt werden. Entweder **https** oder **http**. Standard ist http. | ||
Zeile 29: | Zeile 38: | ||
== host == | == host == | ||
- | Der Host gibt den Server an, auf dem das System installiert ist. Der Host kann im [[client_profile|Clientprofil]] überschrieben werden. | + | |
+ | Der Host gibt den Server an, auf dem das System installiert ist. Der Host kann im [[:software:tim:client_profile|Clientprofil]] überschrieben werden. | ||
---- | ---- | ||
== port == | == port == | ||
- | Dieser Parameter gibt an, auf welchen Port TIM auf Anfragen wartet (zB: timserver.corproot.com:**8080**). Der Port kann im [[client_profile|Clientprofil]] überschrieben werden. | + | |
+ | Dieser Parameter gibt an, auf welchen Port TIM auf Anfragen wartet (zB: timserver.corproot.com:**8080**). Der Port kann im [[:software:tim:client_profile|Clientprofil]] überschrieben werden. | ||
---- | ---- | ||
== externalfilepath == | == externalfilepath == | ||
- | Im Externalfilepath werden die [[software:tim:actionhandler:wordtemplatehandler|Wordtemplates]] gesucht, falls diese im Prozess als relative Pfad hinterlegt sind. \\ | + | |
- | <note> Der Externalfilepath sollte in fast allen Fällen auf den Pfad **...\tim.ear\loom-portal.war\custom** zeigen!</note> | + | Im Externalfilepath werden die [[:software:tim:actionhandler:wordtemplatehandler|Wordtemplates]] gesucht, falls diese im Prozess als relative Pfad hinterlegt sind.\\ |
+ | <note> Der Externalfilepath sollte in fast allen Fällen auf den Pfad **…\tim.ear\loom-portal.war\custom** zeigen!</note> | ||
---- | ---- | ||
== iotemp == | == iotemp == | ||
+ | |||
Dieser Parameter wird verwendet um Temporäre Dateien abzulegen. | Dieser Parameter wird verwendet um Temporäre Dateien abzulegen. | ||
Zeile 50: | Zeile 63: | ||
== default-client == | == default-client == | ||
- | Dieser Parameter gibt an, an welchen [[software:tim:client|Mandanten]] sich die Benutzer Standardmässig anmelden. Nähere Informationen erhalten Sie [[log_in|hier]]. | + | |
+ | Dieser Parameter gibt an, an welchen [[:software:tim:client|Mandanten]] sich die Benutzer Standardmässig anmelden. Nähere Informationen erhalten Sie [[:software:tim:log_in|hier]]. | ||
---- | ---- | ||
== Mails == | == Mails == | ||
- | Wie Sie Mails gestalten können und welche für was zuständig sind, erfahren Sie [[mail_configuration|hier]]. | + | |
+ | Wie Sie Mails gestalten können und welche für was zuständig sind, erfahren Sie [[:software:tim:mail_configuration|hier]]. | ||
---- | ---- | ||
== Notes == | == Notes == | ||
- | Wie Sie Prozessteilnehmer über angehängte Notizen informieren, können Sie unter [[software:tim:notes|Notizen einsehen]]. | ||
+ | Wie Sie Prozessteilnehmer über angehängte Notizen informieren, können Sie unter [[:software:tim:notes|Notizen einsehen]]. | ||
<spoiler |Erweiterte Einstellungen> | <spoiler |Erweiterte Einstellungen> | ||
Zeile 68: | Zeile 83: | ||
<typo fs:120%;>**Verwaltung des Datenmanagementsystems (DMS)**</typo>\\ | <typo fs:120%;>**Verwaltung des Datenmanagementsystems (DMS)**</typo>\\ | ||
- | \\ Das TIM-interne Datenmanagementsystem verwaltet die, an Prozesse, Aktivitäten und Aufgaben angehängten Dokumente. Die Funktionsweise des DMS kann durch die folgenden Parameter in der tim.properties beeinflusst werden. | + | \\ |
+ | Das TIM-interne Datenmanagementsystem verwaltet die, an Prozesse, Aktivitäten und Aufgaben angehängten Dokumente. Die Funktionsweise des DMS kann durch die folgenden Parameter in der tim.properties beeinflusst werden. | ||
- | **Dokumente können nur an offene Tasks bzw. am Prozessstart angehängt werden**\\ | + | **Dokumente können nur an offene Tasks bzw. am Prozessstart angehängt werden** \\ |
Mit dem Parameter **dms-user-has-tasks** kann festgelegt werden, ob Dokumente nur an offene Tasks bzw. am Prozessstart angehängt werden können. Der Parameter kann die Werte **true** oder **false** annehmen (s. Beispiel). | Mit dem Parameter **dms-user-has-tasks** kann festgelegt werden, ob Dokumente nur an offene Tasks bzw. am Prozessstart angehängt werden können. Der Parameter kann die Werte **true** oder **false** annehmen (s. Beispiel). | ||
- | <code>dms-user-has-tasks=true</code> | + | <code> |
- | ** | + | dms-user-has-tasks=true |
- | Prozessmanager von der Regelung ausnehmen**\\ | + | </code> |
- | Es kann sinnvoll sein, Prozessmanagern von dieser Regelung auszunehmen. Wird der Parameter **dms-user-check-processmanager** auf **true** gesetzt, können Prozessmanager zu jedem Zeitpunkt Dokumente anhängen (s. Beispiel). Des Weiteren können Prozessmanager Dokumente jederzeit löschen. | + | |
- | <code>dms-user-check-processmanager=true</code> | + | **Prozessmanager von der Regelung ausnehmen** Es kann sinnvoll sein, Prozessmanagern von dieser Regelung auszunehmen. Wird der Parameter **dms-user-check-processmanager** auf **true** gesetzt, können Prozessmanager zu jedem Zeitpunkt Dokumente anhängen (s. Beispiel). Des Weiteren können Prozessmanager Dokumente jederzeit löschen. |
- | ** | + | <code> |
- | Das Bearbeiten von Dokumenten verbieten**\\ | + | dms-user-check-processmanager=true |
- | Mit dem Parameter **dms-prevent-docmod-[<pd-name>-<activity-name>]** kann das Bearbeiten von Dokumenten auf einer bestimmten Aktivität verhindert werden. Ersetzen Sie **pd-name** und **activity-name** mit dem entsprechenden Prozess bzw. der Aktivität (s. Beispiel). | + | </code> |
- | <code>dms-prevent-docmod-[<Onboarding>-<Arbeitsvertrag absegenen>]=true</code> | + | |
+ | **Das Bearbeiten von Dokumenten verbieten** Mit dem Parameter **dms-prevent-docmod-<pd-name>-<activity-name>** kann das Bearbeiten von Dokumenten auf einer bestimmten Aktivität verhindert werden. Ersetzen Sie **<pd-name>** und **<activity-name>** mit dem Namen des entsprechenden Prozesses bzw. der Aktivität (s.Beispiel). Dabei muss man den Leerzeichen sowie Sonderzeichen in den Namen mit einem "-" tauschen. Man kann **<acitvity-name>** auch weglassen, was dazu führt, dass man im ganzen Prozess keine Dokumente bearbeiten kann. (Die Zeichen "<" und ">" müssen dabei weggelassen werden). Die Eintragung muss komplett in Kleinbuchstaben vorgenommen werden. | ||
+ | <code> | ||
+ | dms-prevent-docmod-<Prozess-1>-<Aufgabe-1>=true | ||
+ | </code> | ||
+ | |||
+ | **Den DMS-Provider festlegen** Der Parameter **dms-provider** verweist auf das verwendete DMS-System (s. Beispiel). | ||
+ | <code> | ||
+ | dms-provider=sharepoint | ||
+ | </code> | ||
- | **Den DMS-Provider festlegen** \\ | ||
- | Der Parameter **dms-provider** verweist auf das verwendete DMS-System (s. Beispiel). | ||
- | <code>dms-provider=sharepoint</code> | ||
Der Parameter **dms-provider-username** verweist auf den User, der für die Anmeldung an das DMS-System verwendet wird. | Der Parameter **dms-provider-username** verweist auf den User, der für die Anmeldung an das DMS-System verwendet wird. | ||
- | <code>dms-provider-username=tim\\tim_service</code> | + | <code> |
+ | dms-provider-username=timtim_service | ||
+ | </code> | ||
Des Weiteren gibt es die Parameter **dms-mainprocess-storage** und **dms-mainprocess-storage-filter** mit denen festgelegt, wie auf den Prozessspeicher zugegriffen wird bzw. welche Daten gefiltert werden. | Des Weiteren gibt es die Parameter **dms-mainprocess-storage** und **dms-mainprocess-storage-filter** mit denen festgelegt, wie auf den Prozessspeicher zugegriffen wird bzw. welche Daten gefiltert werden. | ||
- | <code>dms-mainprocess-storage=read,write</code> | + | <code> |
- | <code>dms-mainprocess-storage-filter=AnyPrefix%</code> | + | dms-mainprocess-storage=read,write |
+ | </code> | ||
+ | <code> | ||
+ | dms-mainprocess-storage-filter=AnyPrefix% | ||
+ | </code> | ||
- | <typo fs:120%;>**Standardpasswörter**</typo>\\ | + | <typo fs:120%;>**Cache**</typo> |
- | \\ In der tim.properties können die Standardpasswörter für Superuser und Mandanten-Administratoren verwaltet werden | + | |
- | **Standadardpasswort Superuser**\\ | + | In der tim.properties kann man bestimmen, ob bei jedem Login der Cache automatisch entleert. Dies passiert, wenn der Parameter **no-cache** auf true gesetzt wird. Wenn nichts angegeben wird, wird der Cache **nicht** entleert. |
- | Mit dem Parameter **initpass-super-admin** kann das Standardpasswort für den Superuser, mit dem Mandanten angelegt werden, gesetzt werden. | + | <code> |
- | <code>initpass-super-admin=bestAdmin1337</code> | + | no-cache=true |
+ | </code> | ||
- | **Standardpasswort sys.support**\\ | + | <typo fs:120%;>**Standardpasswörter**</typo> |
- | Der Parameter **initpass-super-sys.support** belegt das Passwort für den sys.support User. | + | |
- | **Standardpasswort Mandanten-Admin und User**\\ | + | In der tim.properties können die Standardpasswörter für Superuser und Mandanten-Administratoren verwaltet werden |
- | Jeder Mandant wird mit einem User **admin** erstellt. Mit dem Parameter **initpass-x-admin** wird das Passwort für diesen User gesetzt. | + | |
- | <code>initpass-x-admin=e!|\|*S1cH3r35*|°455w0|27!</code> | + | |
- | Mit dem Parameter **initpass-x-others** kann das Standardpasswort für alle erstellten in einem Mandanten erstellten Benutzer festgelegt werden. | + | |
+ | **Standadardpasswort Superuser** Mit dem Parameter **initpass-super-admin** kann das Standardpasswort für den Superuser, mit dem Mandanten angelegt werden, gesetzt werden. | ||
+ | <code> | ||
+ | initpass-super-admin=bestAdmin1337 | ||
+ | </code> | ||
- | <typo fs:120%;>**Clientsprachen**</typo>\\ | + | **Standardpasswort sys.support** Der Parameter **initpass-super-sys.support** belegt das Passwort für den sys.support User. |
- | \\ In der tim.properties kann festegelegt werden, in welchen Sprachen die TIM-Clients zur Verfügung stehen. Der Parameter **available-languages** erhält alle Clientsprachen, getrennt durch ein Semikolon (s. Beispiel). | + | |
- | <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> | + | |
+ | **Standardpasswort Mandanten-Admin und User** Jeder Mandant wird mit einem User **admin** erstellt. Mit dem Parameter **initpass-x-admin** wird das Passwort für diesen User gesetzt. | ||
+ | <code> | ||
+ | initpass-x-admin=e!|\|*S1cH3r35*|°455w0|27! | ||
+ | </code> | ||
+ | |||
+ | Mit dem Parameter **initpass-x-others** kann das Standardpasswort für alle erstellten in einem Mandanten erstellten Benutzer festgelegt werden. | ||
+ | |||
+ | <typo fs:120%;>**Clientsprachen**</typo>\\ | ||
+ | \\ | ||
+ | In der tim.properties kann festegelegt werden, in welchen Sprachen die TIM-Clients zur Verfügung stehen. Der Parameter **available-languages** erhält alle Clientsprachen, getrennt durch ein Semikolon (s. Beispiel). | ||
+ | <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%;>**Nachrichten bei externer Entscheidung**</typo>\\ | <typo fs:120%;>**Nachrichten bei externer Entscheidung**</typo>\\ | ||
- | \\ Mit dem setProcessVariableAndSignalProcessInstanceByTransitionName Handler können Entscheidungen im Prozess außerhalb von TIM getroffen werden. In der tim.properties kann festgelegt werden, welche Nachricht bei erfolgreicher bzw. nicht erfolgreicher Entscheidung angezeigt wird. | + | \\ |
+ | Mit dem setProcessVariableAndSignalProcessInstanceByTransitionName Handler können Entscheidungen im Prozess außerhalb von TIM getroffen werden. In der tim.properties kann festgelegt werden, welche Nachricht bei erfolgreicher bzw. nicht erfolgreicher Entscheidung angezeigt wird. | ||
- | <code>#signal-succeed-response=Ihre Entscheidung zu ${SYS.PROCESSDEFINITION_NAME} / ${SYS.PROCESSINSTANCE_NAME} / ${SYS.NODEINSTANCE_NAME} wurde erfolgreich verarbeitet.</code> | + | <code> |
- | <code>#signal-failed-response=Ihre Entscheidung zu ${SYS.PROCESSDEFINITION_NAME} / ${SYS.PROCESSINSTANCE_NAME} / ${SYS.NODEINSTANCE_NAME} konnte nicht verarbeitet werden.</code> | + | #signal-succeed-response=Ihre Entscheidung zu ${SYS.PROCESSDEFINITION_NAME} / ${SYS.PROCESSINSTANCE_NAME} / ${SYS.NODEINSTANCE_NAME} wurde erfolgreich verarbeitet. |
+ | </code> | ||
+ | |||
+ | <code> | ||
+ | #signal-failed-response=Ihre Entscheidung zu ${SYS.PROCESSDEFINITION_NAME} / ${SYS.PROCESSINSTANCE_NAME} / ${SYS.NODEINSTANCE_NAME} konnte nicht verarbeitet werden. | ||
+ | </code> | ||
Falls die entsprechende Prozessinstanz bereits beendet wurde oder nicht existiert können mit den Parametern **signal-failed-pi-ended-response** und **signal-failed-no-pi-response** entsprechende Benachrichtigungen festgelegt werden. | Falls die entsprechende Prozessinstanz bereits beendet wurde oder nicht existiert können mit den Parametern **signal-failed-pi-ended-response** und **signal-failed-no-pi-response** entsprechende Benachrichtigungen festgelegt werden. | ||
<typo fs:120%;>**Smartform**</typo>\\ | <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. Due s kann pber die Parameter **form-provider** und **form-bootstrap** festgelegt werden. | + | \\ |
- | <code>form-provider=com.dooris.cba.providers.CbaFormProvider</code> | + | 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-bootstrap=false</code> | + | <code> |
+ | form-provider=com.dooris.cba.providers.CbaFormProvider | ||
+ | </code> | ||
+ | <code> | ||
+ | form-bootstrap=false | ||
+ | </code> | ||
<typo fs:120%;>**Notizen in Haupt- und Subprozessen**</typo>\\ | <typo fs:120%;>**Notizen in Haupt- und Subprozessen**</typo>\\ | ||
- | \\ Mit dem Parameter **blog-article-inheritance** kann festgelegt werden, wie Notizen eines Subprozesses im Hauptprozess zur Verfügung stehen. Ist der Parameter auf **read** gesetzt, sind Notizen aus Subprozessen im Hauptprozess sichtbar. Auf **write** werden Notizen aus den Subprozessen direkt an den Hauptprozess angehängt, nicht aber an den Subprozess (s. Beispiel). | + | \\ |
- | + | 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> | + | <code> |
+ | blog-article-inheritance=write | ||
+ | </code> | ||
<typo fs:120%;>**PDF Konvertierung**</typo>\\ | <typo fs:120%;>**PDF Konvertierung**</typo>\\ | ||
- | \\ Die tim.properties enthält diverse Parameter zur Steuerung der Konvertierung von Dokumenten zu PDFs in TIM. | + | \\ |
+ | Die tim.properties enthält diverse Parameter zur Steuerung der Konvertierung von Dokumenten zu PDFs in TIM. | ||
- | **timPdfConverter**\\ | + | **timPdfConverter** \\ |
Im Parameter **timPdfConverter** wird hinterlegt, welche Kovertierung verwendet wird (z.B. aspose). | Im Parameter **timPdfConverter** wird hinterlegt, welche Kovertierung verwendet wird (z.B. aspose). | ||
+ | <code> | ||
+ | timPdfConverter=aspose | ||
+ | </code> | ||
- | <code>timPdfConverter=aspose</code> | + | **ooHost** \\ |
- | + | ||
- | **ooHost**\\ | + | |
Im Parameter **ooHost** wird der Host für den OpenOffice Connector hinterlegt. | Im Parameter **ooHost** wird der Host für den OpenOffice Connector hinterlegt. | ||
- | <code>ooHost=localhost</code> | + | <code> |
+ | ooHost=localhost | ||
+ | </code> | ||
- | **ooPort**\\ | + | **ooPort** \\ |
Mit **ooPort** wird der Port des OpenOffice Connectors festgelegt. | Mit **ooPort** wird der Port des OpenOffice Connectors festgelegt. | ||
- | <code>ooPort=8100</code> | + | <code> |
+ | ooPort=8100 | ||
+ | </code> | ||
<typo fs:120%;>**Single Sign On (SSO)**</typo>\\ | <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> | + | Mit dem Parameter **registrationForm** kann eine Seite, wenn der angemeldete Nutzer via SSO noch keine Berechtigung auf einen Mandanten hat, festgelegt werden, die dann angezeigt wird (s. Beispiel). |
+ | <code> | ||
+ | registrationForm=/loom-portal/super-resource/unauthorized.htm?disposition=inline | ||
+ | </code> | ||
</spoiler> | </spoiler> | ||
- | |||