<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
		<id>https://wiki.augmensys.com/index.php?feed=atom&amp;namespace=0&amp;title=Special%3ANewPages</id>
		<title>UBIK Wiki / Augmensys - New pages [en]</title>
		<link rel="self" type="application/atom+xml" href="https://wiki.augmensys.com/index.php?feed=atom&amp;namespace=0&amp;title=Special%3ANewPages"/>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Special:NewPages"/>
		<updated>2026-11-17T08:36:09Z</updated>
		<subtitle>From UBIK Wiki / Augmensys</subtitle>
		<generator>MediaWiki 1.24.2</generator>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=UBIK_Credentials_Service</id>
		<title>UBIK Credentials Service</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=UBIK_Credentials_Service"/>
				<updated>2026-11-16T15:35:14Z</updated>
		
		<summary type="html">&lt;p&gt;MHM: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Credentials Self-Service Portal =&lt;br /&gt;
&lt;br /&gt;
Starting with '''UBIK 5.2''', UBIK provides a Credentials Self-Service Portal that allows users to initialize or reset their own password.&lt;br /&gt;
&lt;br /&gt;
Instead of an administrator defining and distributing passwords, UBIK can generate a secure link that is provided to the user. The user opens the link in a browser and defines the password directly in the Credentials Self-Service Portal.&lt;br /&gt;
&lt;br /&gt;
== Overview ==&lt;br /&gt;
&lt;br /&gt;
The Credentials Self-Service functionality supports two main use cases:&lt;br /&gt;
&lt;br /&gt;
* '''Password initialization''' for newly created users&lt;br /&gt;
* '''Password reset''' for existing users&lt;br /&gt;
&lt;br /&gt;
Both workflows use a temporary, user-specific link that opens the Credentials Self-Service Portal.&lt;br /&gt;
&lt;br /&gt;
The portal communicates with UBIK to set the new password. After the password has been successfully set, the user can authenticate with the new credentials.&lt;br /&gt;
&lt;br /&gt;
== Prerequisites ==&lt;br /&gt;
&lt;br /&gt;
The feature requires the '''UBIK Credential Service''', which is included in the UBIK 5.2 release package.&lt;br /&gt;
&lt;br /&gt;
The service must be:&lt;br /&gt;
&lt;br /&gt;
# installed,&lt;br /&gt;
# configured,&lt;br /&gt;
# reachable by the users who receive credential links, and&lt;br /&gt;
# configured in UBIK Studio using the '''Credential Portal URL''' database setting.&lt;br /&gt;
&lt;br /&gt;
The Credential Service can be hosted according to the requirements of the target environment. Both HTTP and HTTPS are supported.&lt;br /&gt;
&lt;br /&gt;
For productive environments, '''HTTPS is strongly recommended'''.&lt;br /&gt;
&lt;br /&gt;
== UBIK Configuration ==&lt;br /&gt;
&lt;br /&gt;
The URL of the Credential Service must be configured in:&lt;br /&gt;
&lt;br /&gt;
 '''Database Settings &amp;gt; Credential Portal URL'''&lt;br /&gt;
&lt;br /&gt;
After the Credential Portal URL has been configured, additional Credential actions become available for Login objects in UBIK Studio.&lt;br /&gt;
&lt;br /&gt;
The corresponding actions can be accessed via:&lt;br /&gt;
&lt;br /&gt;
 '''Login &amp;gt; Start Actions &amp;gt; Credential'''&lt;br /&gt;
&lt;br /&gt;
The available workflows are:&lt;br /&gt;
&lt;br /&gt;
* Initialize credentials&lt;br /&gt;
* Reset credentials&lt;br /&gt;
&lt;br /&gt;
== Initial Password Setup ==&lt;br /&gt;
&lt;br /&gt;
A new UBIK user can be created without assigning an initial password.&lt;br /&gt;
&lt;br /&gt;
To let the user define the password:&lt;br /&gt;
&lt;br /&gt;
# Create the Login in UBIK Studio.&lt;br /&gt;
# Start the Credential action for initializing the credentials.&lt;br /&gt;
# UBIK generates a user-specific URL and copies it to the clipboard.&lt;br /&gt;
# Send this URL to the user, for example by e-mail or Microsoft Teams.&lt;br /&gt;
# The user opens the URL in a browser.&lt;br /&gt;
# The Credentials Self-Service Portal asks the user to enter and confirm a new password.&lt;br /&gt;
# The portal validates the password against the configured password policy.&lt;br /&gt;
# After confirmation, the new password is stored in UBIK.&lt;br /&gt;
# The user can authenticate using the newly defined password.&lt;br /&gt;
&lt;br /&gt;
While initialization is pending, the Login is in the corresponding initialization state and cannot be used for authentication.&lt;br /&gt;
&lt;br /&gt;
== Password Reset ==&lt;br /&gt;
&lt;br /&gt;
The same mechanism can be used when an existing user needs to reset the password.&lt;br /&gt;
&lt;br /&gt;
# Select the Login in UBIK Studio.&lt;br /&gt;
# Start the Credential password-reset action.&lt;br /&gt;
# UBIK generates a new password-reset URL.&lt;br /&gt;
# Send the generated URL to the user.&lt;br /&gt;
# The Login is put into the password-reset state and can no longer authenticate using the previous password.&lt;br /&gt;
# The user opens the link and specifies a new password.&lt;br /&gt;
# After the new password has been set successfully, the Login can authenticate again.&lt;br /&gt;
&lt;br /&gt;
This prevents continued use of the previous credentials while a password reset is pending.&lt;br /&gt;
&lt;br /&gt;
== Login States ==&lt;br /&gt;
&lt;br /&gt;
The Credentials Self-Service functionality introduces/uses Login states to control whether authentication is currently allowed.&lt;br /&gt;
&lt;br /&gt;
Typical states include:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! State&lt;br /&gt;
! Description&lt;br /&gt;
|-&lt;br /&gt;
| '''Enabled'''&lt;br /&gt;
| The Login is active and can authenticate using its configured password.&lt;br /&gt;
|-&lt;br /&gt;
| '''Initializing'''&lt;br /&gt;
| Initial credential setup is pending. Authentication is blocked until the user has defined a password.&lt;br /&gt;
|-&lt;br /&gt;
| '''Resetting'''&lt;br /&gt;
| A password reset is pending. Authentication is blocked until a new password has been defined.&lt;br /&gt;
|-&lt;br /&gt;
| '''Blocked / Disabled'''&lt;br /&gt;
| Authentication for the Login is disabled.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
An administrator can still manage the Login and its status directly in UBIK Studio.&lt;br /&gt;
&lt;br /&gt;
== Security ==&lt;br /&gt;
&lt;br /&gt;
The Credentials Self-Service functionality includes several security mechanisms.&lt;br /&gt;
&lt;br /&gt;
=== Single-use credential links ===&lt;br /&gt;
&lt;br /&gt;
Credential links contain a token allowing the respective user to perform the requested credential operation.&lt;br /&gt;
&lt;br /&gt;
The token is '''single-use'''. Once the password has successfully been set, the same link cannot be used again.&lt;br /&gt;
&lt;br /&gt;
=== Authentication blocked during credential changes ===&lt;br /&gt;
&lt;br /&gt;
When password initialization or reset is started, the corresponding Login is put into a state in which authentication is blocked.&lt;br /&gt;
&lt;br /&gt;
Consequently, the previous credentials cannot continue to be used while the credential operation is pending.&lt;br /&gt;
&lt;br /&gt;
=== Secure Password Storage ===&lt;br /&gt;
&lt;br /&gt;
Passwords are not stored in a reversible form.&lt;br /&gt;
&lt;br /&gt;
Password storage uses a random salt. Consequently, two users choosing the same password will still have different password representations in the database.&lt;br /&gt;
&lt;br /&gt;
The stored representation cannot be used to retrieve the original password.&lt;br /&gt;
&lt;br /&gt;
=== Protection against brute-force attacks ===&lt;br /&gt;
&lt;br /&gt;
Password verification deliberately introduces a processing delay.&lt;br /&gt;
&lt;br /&gt;
This limits the rate at which authentication attempts can be performed and makes automated brute-force attacks more difficult.&lt;br /&gt;
&lt;br /&gt;
== Typical New-User Workflow ==&lt;br /&gt;
&lt;br /&gt;
A recommended workflow for onboarding a new user is:&lt;br /&gt;
&lt;br /&gt;
 Login created without password&lt;br /&gt;
        ↓&lt;br /&gt;
 Administrator creates credential invitation&lt;br /&gt;
        ↓&lt;br /&gt;
 Login enters initialization state&lt;br /&gt;
        ↓&lt;br /&gt;
 Invitation link is sent to the user&lt;br /&gt;
        ↓&lt;br /&gt;
 User opens the Credentials Self-Service Portal&lt;br /&gt;
        ↓&lt;br /&gt;
 User defines a password&lt;br /&gt;
        ↓&lt;br /&gt;
 Password policy is validated&lt;br /&gt;
        ↓&lt;br /&gt;
 Password is stored securely&lt;br /&gt;
        ↓&lt;br /&gt;
 Invitation token becomes invalid&lt;br /&gt;
        ↓&lt;br /&gt;
 Login is enabled for authentication&lt;br /&gt;
&lt;br /&gt;
This workflow avoids the need for an administrator to create, know, or communicate an initial user password.&lt;br /&gt;
&lt;br /&gt;
== Typical Password-Reset Workflow ==&lt;br /&gt;
&lt;br /&gt;
 Login is enabled&lt;br /&gt;
        ↓&lt;br /&gt;
 Administrator starts password reset&lt;br /&gt;
        ↓&lt;br /&gt;
 Login enters resetting state&lt;br /&gt;
        ↓&lt;br /&gt;
 Previous credentials can no longer authenticate&lt;br /&gt;
        ↓&lt;br /&gt;
 Reset link is sent to the user&lt;br /&gt;
        ↓&lt;br /&gt;
 User defines a new password&lt;br /&gt;
        ↓&lt;br /&gt;
 Reset token becomes invalid&lt;br /&gt;
        ↓&lt;br /&gt;
 Login can authenticate with the new password&lt;br /&gt;
&lt;br /&gt;
== Administration ==&lt;br /&gt;
&lt;br /&gt;
The self-service workflow does not remove the administrator's ability to manage Login objects directly.&lt;br /&gt;
&lt;br /&gt;
Administrators can still:&lt;br /&gt;
&lt;br /&gt;
* change the Login status,&lt;br /&gt;
* enable or disable a Login,&lt;br /&gt;
* assign a password directly, or&lt;br /&gt;
* trigger credential initialization or password reset.&lt;br /&gt;
&lt;br /&gt;
The Credentials Self-Service Portal therefore provides an additional secure workflow for delegating password creation to the user without removing the existing administrative functionality.&lt;br /&gt;
&lt;br /&gt;
== Summary ==&lt;br /&gt;
&lt;br /&gt;
The UBIK Credentials Self-Service Portal provides a secure mechanism for password initialization and password reset.&lt;br /&gt;
&lt;br /&gt;
Its main benefits are:&lt;br /&gt;
&lt;br /&gt;
* Users define their own passwords.&lt;br /&gt;
* Administrators do not need to distribute initial passwords.&lt;br /&gt;
* New users can be created without an initial password.&lt;br /&gt;
* Existing credentials are disabled while a reset is pending.&lt;br /&gt;
* Credential links are single-use.&lt;br /&gt;
* Password complexity can be configured centrally.&lt;br /&gt;
* Passwords are stored using salted, non-reversible representations.&lt;br /&gt;
* Authentication includes protection against high-frequency brute-force attempts.&lt;br /&gt;
* The portal can be visually customized for the respective environment.&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
* [[HowTo:Configure_UBIK_Credentials_Service]]&lt;/div&gt;</summary>
		<author><name>MHM</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Sync_Manager</id>
		<title>Sync Manager</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Sync_Manager"/>
				<updated>2026-11-11T12:06:07Z</updated>
		
		<summary type="html">&lt;p&gt;CWI: /* Automatic Merging */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{UnderConstructionStart}}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The '''Sync Manager''' collects all synchronization operations of the {{UBIK}} client that could not be completed successfully and offers a central place to review, retry, report or dismiss them. In addition, it lists all local changes that have not been committed to the server yet.{{Version/WinXSince|5.3.0}}{{Version/MobileSince|5.3.0}}&lt;br /&gt;
&lt;br /&gt;
It replaces the former behavior where failed synchronizations were either not visible at all or interrupted the user. Failed operations are now recorded silently in the background, and the user can decide when and how to deal with them.&lt;br /&gt;
&lt;br /&gt;
{{Hint|Only failed operations are listed. As soon as an operation succeeds (e.g. through a retry or a later automatic synchronization), the corresponding entry disappears from the list automatically.}}&lt;br /&gt;
&lt;br /&gt;
== Opening the Sync Manager ==&lt;br /&gt;
The Sync Manager is opened via buttons which are only shown if there is something to handle:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Button !! Shown when !! Opens tab&lt;br /&gt;
|-&lt;br /&gt;
| Sync issues (alert icon + number of issues) || at least one synchronization issue exists || ''Needs attention''&lt;br /&gt;
|-&lt;br /&gt;
| Uncommitted changes (unsaved-changes icon + number of objects) || at least one object has local changes that are not committed yet || ''Uncommitted changes''&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
* '''WinX:''' The buttons are located on the right side of the global status bar (visible after login).&lt;br /&gt;
* '''Mobile:''' The buttons are located in the bottom row of the menu area.&lt;br /&gt;
&lt;br /&gt;
{{Attention|The Sync Manager does not open automatically when a synchronization fails. Keep an eye on the sync issues indicator.}}&lt;br /&gt;
&lt;br /&gt;
== Tabs ==&lt;br /&gt;
Issues are grouped by how urgently they require the user's attention. The number in front of each tab title shows the number of entries in that tab.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Tab !! Content !! Typical impact&lt;br /&gt;
|-&lt;br /&gt;
| '''Needs attention''' ||&lt;br /&gt;
* Failed branch downloads (incl. failed documents of that branch)&lt;br /&gt;
* Failed commits (changed or newly created objects)&lt;br /&gt;
* Failed document (file) uploads&lt;br /&gt;
* Failed check-outs / releases (exclusive access)&lt;br /&gt;
|| Local work has not reached the server, or offline data is incomplete. Should be handled as soon as possible.&lt;br /&gt;
|-&lt;br /&gt;
| '''Review''' ||&lt;br /&gt;
* Failed object updates (e.g. loading children of an object)&lt;br /&gt;
* Failed meta definition updates&lt;br /&gt;
* Failed single document downloads (e.g. opening a document)&lt;br /&gt;
|| Displayed data might be outdated or incomplete.&lt;br /&gt;
|-&lt;br /&gt;
| '''Background''' ||&lt;br /&gt;
* Failed live value updates&lt;br /&gt;
* Failed push polling updates&lt;br /&gt;
|| Background operations which usually recover by themselves.&lt;br /&gt;
|-&lt;br /&gt;
| '''All issues''' || All entries of the three tabs above. ||&lt;br /&gt;
|-&lt;br /&gt;
| '''Uncommitted changes''' || Objects with local changes that are not committed to the server yet. || See [[#Uncommitted Changes|Uncommitted Changes]].&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Each entry has a colored marker on its left side: '''red''' for ''Needs attention'' types, '''orange''' for ''Review'' types and '''grey''' for ''Background'' types.&lt;br /&gt;
&lt;br /&gt;
== Sync Issue Entries ==&lt;br /&gt;
Every entry shows:&lt;br /&gt;
* a summary consisting of the operation and the affected object (name and description),&lt;br /&gt;
* the location of the affected object in the hierarchy,&lt;br /&gt;
* the time when the operation failed (most recent failure),&lt;br /&gt;
* the report state: ''Not reported'', ''✓ Reported'' or ''⊗ Report failed''.&lt;br /&gt;
&lt;br /&gt;
When expanding an entry, the following details are displayed:&lt;br /&gt;
* '''Sync type''' – the kind of operation (e.g. ''BranchHierarchyDownload'', ''CommitChanges'')&lt;br /&gt;
* '''Web service call''' – technical information about the failed server call (URL, status code, duration, error details). Session tokens are not included.&lt;br /&gt;
* '''Location''' – the full path(s) of the affected object(s)&lt;br /&gt;
* '''Error''' – the error message&lt;br /&gt;
&lt;br /&gt;
=== Failed documents of a branch download ===&lt;br /&gt;
If documents fail to download during a branch download, the branch is listed in ''Needs attention'' and the failed documents are shown nested inside the branch entry (visible when expanded). Documents which are downloaded individually (e.g. by opening a document) are listed as separate entries in the ''Review'' tab instead. If a failed Document download under a branch download is retried and fails again, then it is also displayed in the Review section as a single file Document download.&lt;br /&gt;
&lt;br /&gt;
=== Repeated failures ===&lt;br /&gt;
If the same operation (same type, same object(s)) fails again, no additional entry is created. The existing entry is updated with the new time, error and web service call instead, and its report state is reset to ''Not reported''.&lt;br /&gt;
&lt;br /&gt;
{{Clear}}&lt;br /&gt;
&lt;br /&gt;
== Actions ==&lt;br /&gt;
Actions can be executed for a single entry (buttons on the entry) or for several selected entries at once (bulk buttons).&lt;br /&gt;
&lt;br /&gt;
{{Hint|This only works in Online and Manual Sync mode.}} &lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Action !! Description !! Requires online mode&lt;br /&gt;
|-&lt;br /&gt;
| '''Retry''' || Executes the failed operation again. If it succeeds, the entry is removed. If it fails again, the entry is updated. Retrying a branch download downloads the branch again, including its documents. When several failed commits are retried together, all affected objects are committed in one single commit. || yes&lt;br /&gt;
|-&lt;br /&gt;
| '''Report''' || Sends the selected entries, including their technical details, to the {{UBIK}} server so that administrators can analyze the problem. The report state of the entries changes to ''✓ Reported'' or ''⊗ Report failed''. Reporting does not remove the entry. || yes&lt;br /&gt;
|-&lt;br /&gt;
| '''Remove''' || Removes the entry from the list without retrying the operation. Removing a branch download also removes its nested failed documents. || no&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{Attention|''Remove'' only dismisses the entry – it does not undo or repeat anything. For example, removing a failed commit entry does not discard the local changes; the object stays in the ''Uncommitted changes'' tab.}}&lt;br /&gt;
&lt;br /&gt;
=== Selecting multiple entries ===&lt;br /&gt;
* '''WinX:''' Hover over the list and click the selection icon at the top to switch to multi-selection. A toolbar with ''Select all'', ''Deselect all'', ''Retry Selected'', ''Report Selected'' and ''Remove Selected'' appears. The buttons on single entries are shown when hovering over an entry.&lt;br /&gt;
* '''Mobile:''' Entries can be selected by tapping them or via their checkbox. The toolbar with ''Select all'', ''Deselect all'', ''Retry Selected'', ''Report Selected'' and ''Remove Selected'' is always visible.&lt;br /&gt;
&lt;br /&gt;
The ''All issues'' tab shows the same entries as the other tabs, so a selection made in one tab is also visible in ''All issues''.&lt;br /&gt;
&lt;br /&gt;
=== Offline mode ===&lt;br /&gt;
While the client is in offline mode, ''Retry'', ''Report'' and ''Commit'' are disabled and a corresponding hint is shown. Entries can still be viewed and removed. No new sync issues are recorded in offline mode because no synchronization is attempted.&lt;br /&gt;
&lt;br /&gt;
== Automatic Merging ==&lt;br /&gt;
The Sync Manager automatically combines related entries so that the list stays short and every problem is only listed once.&lt;br /&gt;
&lt;br /&gt;
=== One entry per operation and object ===&lt;br /&gt;
An entry is identified by its operation type and the affected object(s). If an operation fails that is already listed, the existing entry is updated instead of creating a new one (see [[#Repeated failures|Repeated failures]]). This also applies to the automatic retries the client performs internally, which means that a single failed action results in exactly one entry.&lt;br /&gt;
&lt;br /&gt;
The following rules apply when comparing entries:&lt;br /&gt;
* The order of the affected objects does not matter; e.g. a failed commit of the objects ''A, B'' and a failed commit of ''B, A'' result in one entry.&lt;br /&gt;
* A failed '''check-out''' and a failed '''release''' of the same object are separate entries.&lt;br /&gt;
* A failed '''file upload''' is only merged with another entry if both refer to the same object and the same file.&lt;br /&gt;
&lt;br /&gt;
In addition, the Sync Manager regularly checks the lists for duplicates and keeps only the most recent one. Two entries count as duplicates if their operation type, affected object(s), called web service and error message are identical.&lt;br /&gt;
&lt;br /&gt;
=== Partially resolved entries ===&lt;br /&gt;
Some entries refer to several objects at once: commits, check-outs / releases and live value updates. If some of these objects are synchronized successfully later on (e.g. by committing one of the objects again), they are removed from the existing entry and its location is updated. The entry only disappears once all of its objects have been synchronized successfully.&lt;br /&gt;
&lt;br /&gt;
''Example:'' A commit of the objects ''A'' and ''B'' fails. Later, only ''A'' is committed successfully. The entry remains and only refers to ''B''.&lt;br /&gt;
&lt;br /&gt;
=== Failed documents of a branch download ===&lt;br /&gt;
Failed document downloads that belong to a branch download are grouped under the corresponding branch entry instead of being listed individually (see [[#Failed documents of a branch download|Failed documents of a branch download]]). Once all of these documents have been downloaded successfully, the branch entry is removed as well.&lt;br /&gt;
&lt;br /&gt;
=== Combined retry ===&lt;br /&gt;
When several entries are retried together (''Retry Selected''), operations of the same kind are combined:&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Selected entries !! Executed as&lt;br /&gt;
|-&lt;br /&gt;
| Several failed commits || One single commit containing all affected objects&lt;br /&gt;
|-&lt;br /&gt;
| Several failed check-outs / releases || One check-out request and one release request, each containing all affected objects&lt;br /&gt;
|-&lt;br /&gt;
| Several failed live value updates || One live value request containing all affected values&lt;br /&gt;
|-&lt;br /&gt;
| Several branch downloads, document downloads/uploads or object updates || One request per affected object; objects selected multiple times are only processed once&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The entries are then updated individually depending on the result, i.e. entries that were synchronized successfully are removed, while entries that still fail remain in the list.&lt;br /&gt;
&lt;br /&gt;
{{Hint|Reporting is '''not''' merged: All selected entries are sent to the server in one single request, but each entry keeps its own details (location, error message, web service call).}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Uncommitted Changes ==&lt;br /&gt;
The ''Uncommitted changes'' tab lists all objects which were changed, created or deleted locally but not yet committed to the server.&lt;br /&gt;
Select one or more objects and use '''Commit''' to upload the changes. Committing requires online or manual mode.&lt;br /&gt;
If the commit fails, a corresponding entry is added to the ''Needs attention'' tab.&lt;br /&gt;
&lt;br /&gt;
== Persistence ==&lt;br /&gt;
Sync issues are stored in the local client database. They are therefore&lt;br /&gt;
* kept after restarting the client,&lt;br /&gt;
* stored separately per user and per profile,&lt;br /&gt;
* loaded after login.&lt;br /&gt;
They are deleted when the issue is resolved (successful retry or synchronization), when the user removes them, or when the affected object is deleted.&lt;br /&gt;
&lt;br /&gt;
== Reporting (Server) ==&lt;br /&gt;
Issues can be reported to make Admins aware they exist and can react accordingly.&lt;br /&gt;
Reported issues are sent to the content service (service version 530 -&amp;gt; add flag!) and stored there as well. The server does not send these reported issues back; you only receive OK or failed as a response.&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
{{UnderConstructionEnd}}&lt;/div&gt;</summary>
		<author><name>CWI</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=EventNotification_Processing_Feedback</id>
		<title>EventNotification Processing Feedback</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=EventNotification_Processing_Feedback"/>
				<updated>2026-10-29T15:01:27Z</updated>
		
		<summary type="html">&lt;p&gt;MHM: /* NotificationLog */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= EventNotification Processing Feedback =&lt;br /&gt;
&lt;br /&gt;
EventNotifications inform UBIK about changes to synchronised objects in external systems. Because a single notification may affect one or multiple objects, UBIK provides processing feedback indicating both the overall processing state and, in case of failures, detailed information about what went wrong.&lt;br /&gt;
&lt;br /&gt;
Detailed processing information is represented by &amp;lt;code&amp;gt;NotificationProcessingResult&amp;lt;/code&amp;gt;. Error details are persisted in the EventNotification property &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; only when processing encounters an error.&lt;br /&gt;
&lt;br /&gt;
== Processing States ==&lt;br /&gt;
&lt;br /&gt;
=== NotProcessed ===&lt;br /&gt;
The notification has been received and stored, but processing has not yet taken place.&lt;br /&gt;
&lt;br /&gt;
There is therefore no processing result or error information yet.&lt;br /&gt;
&lt;br /&gt;
=== SuccessfullyProcessed ===&lt;br /&gt;
The notification was processed successfully and all affected objects were successfully imported, updated or deleted.&lt;br /&gt;
&lt;br /&gt;
No &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; is persisted for successful notifications. Instead, the successful processing result is provided dynamically:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Status&amp;quot;: &amp;quot;SuccessfullyProcessed&amp;quot;,&lt;br /&gt;
  &amp;quot;Errors&amp;quot;: []&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== PartlyProcessed ===&lt;br /&gt;
The notification was processed and at least one affected object was processed successfully, while processing of at least one other object failed.&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; contains details about the failed objects and the reason for each failure.&lt;br /&gt;
&lt;br /&gt;
=== ProcessedWithError ===&lt;br /&gt;
Processing was attempted, but none of the affected objects could be processed successfully.&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; contains the available error information for the failed processing operations.&lt;br /&gt;
&lt;br /&gt;
=== NoProcessorFound ===&lt;br /&gt;
UBIK could not determine the necessary processing configuration for the notification. Object processing therefore could not be performed.&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; contains details explaining why the notification could not be processed.&lt;br /&gt;
&lt;br /&gt;
== NotificationLog ==&lt;br /&gt;
&lt;br /&gt;
Detailed failure information is stored in the EventNotification's &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; property as JSON.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Status&amp;quot;: &amp;quot;PartlyProcessed&amp;quot;,&lt;br /&gt;
  &amp;quot;Errors&amp;quot;: [&lt;br /&gt;
    {&lt;br /&gt;
      &amp;quot;Object&amp;quot;: {&lt;br /&gt;
        &amp;quot;SystemType&amp;quot;: 8,&lt;br /&gt;
        &amp;quot;SystemUid&amp;quot;: &amp;quot;A5EWSOMYK6&amp;quot;,&lt;br /&gt;
        &amp;quot;DbKey&amp;quot;: &amp;quot;db1&amp;quot;,&lt;br /&gt;
        &amp;quot;ProjectUid&amp;quot;: &amp;quot;A3X1DY8S10&amp;quot;,&lt;br /&gt;
        &amp;quot;WorkingOverlayId&amp;quot;: &amp;quot;A43NKY92H4&amp;quot;&lt;br /&gt;
      },&lt;br /&gt;
      &amp;quot;Code&amp;quot;: &amp;quot;ObjectProcessingFailed&amp;quot;,&lt;br /&gt;
      &amp;quot;Message&amp;quot;: &amp;quot;Description of the processing problem.&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Each error provides:&lt;br /&gt;
* &amp;lt;code&amp;gt;Code&amp;lt;/code&amp;gt;: the type of processing error.&lt;br /&gt;
* &amp;lt;code&amp;gt;Message&amp;lt;/code&amp;gt;: a human-readable description of the problem.&lt;br /&gt;
* &amp;lt;code&amp;gt;Object&amp;lt;/code&amp;gt;: identification of the affected object, where the error can be assigned to a specific object.&lt;br /&gt;
&lt;br /&gt;
The object identifier consists of:&lt;br /&gt;
* &amp;lt;code&amp;gt;SystemType&amp;lt;/code&amp;gt;&lt;br /&gt;
* &amp;lt;code&amp;gt;SystemUid&amp;lt;/code&amp;gt;&lt;br /&gt;
* &amp;lt;code&amp;gt;DbKey&amp;lt;/code&amp;gt;&lt;br /&gt;
* &amp;lt;code&amp;gt;ProjectUid&amp;lt;/code&amp;gt;&lt;br /&gt;
* &amp;lt;code&amp;gt;WorkingOverlayId&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
For errors that apply to the notification as a whole rather than an individual object, &amp;lt;code&amp;gt;Object&amp;lt;/code&amp;gt; may be omitted.&lt;br /&gt;
&lt;br /&gt;
=== Historic Notifications ===&lt;br /&gt;
Historic notifications may not contain a &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt;. In this case, a fallback &amp;lt;code&amp;gt;NotificationProcessingResult&amp;lt;/code&amp;gt; consists of the notification's existing status and an empty &amp;lt;code&amp;gt;Errors&amp;lt;/code&amp;gt; collection.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Failure Reasons and Troubleshooting ==&lt;br /&gt;
&lt;br /&gt;
=== No Matching Login Found ===&lt;br /&gt;
'''Reason:''' &amp;lt;code&amp;gt;NoMatchingLoginFound&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
UBIK could not find a configured Service Login (&amp;lt;code&amp;gt;ComosLogin&amp;lt;/code&amp;gt;) matching the notification's &amp;lt;code&amp;gt;DbKey&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;ProjectUid&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;WorkingOverlayId&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
'''How to resolve:''' Verify that an appropriate Service Login is configured for this combination.&lt;br /&gt;
&lt;br /&gt;
=== No Template/CDevice/DocumentType Information Found ===&lt;br /&gt;
'''Reason:''' &amp;lt;code&amp;gt;NoTemplateCDeviceInfoFound&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
UBIK attempted to resolve the template, CDevice or DocumentType for the referenced object, but the required data could not be retrieved from Comos via the REST API.&lt;br /&gt;
&lt;br /&gt;
'''How to resolve:''' Check the ServiceLogs for additional information.&lt;br /&gt;
&lt;br /&gt;
=== Multiple InterfaceAdministrations Found ===&lt;br /&gt;
'''Reason:''' &amp;lt;code&amp;gt;MultipleInterfaceAdministrationsFound&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
More than one &amp;lt;code&amp;gt;InterfaceAdministration&amp;lt;/code&amp;gt; matches the login and template/CDevice/DocumentType of the referenced object, making the processing configuration ambiguous.&lt;br /&gt;
&lt;br /&gt;
'''How to resolve:''' Check the configured &amp;lt;code&amp;gt;InterfaceAdministration&amp;lt;/code&amp;gt; objects and ensure the affected object can be assigned unambiguously to one configuration.&lt;br /&gt;
&lt;br /&gt;
=== No InterfaceAdministration Found ===&lt;br /&gt;
'''Reason:''' &amp;lt;code&amp;gt;NoInterfaceAdministrationsFound&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
No &amp;lt;code&amp;gt;InterfaceAdministration&amp;lt;/code&amp;gt; configured to process the referenced object could be found for the relevant login and template/CDevice/DocumentType.&lt;br /&gt;
&lt;br /&gt;
'''How to resolve:''' Check the &amp;lt;code&amp;gt;InterfaceAdministration&amp;lt;/code&amp;gt; configuration and ensure an appropriate configuration exists.&lt;br /&gt;
&lt;br /&gt;
=== Proxy Not Imported ===&lt;br /&gt;
'''Reason:''' &amp;lt;code&amp;gt;ProxyNotImported&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The object was processed, but the resulting proxy did not receive a ComosUID. The corresponding proxy is still in creation state because its first export has not finished.&lt;br /&gt;
&lt;br /&gt;
'''How to resolve:''' Check the ServiceLogs for more information.&lt;br /&gt;
&lt;br /&gt;
=== Unexpected Error ===&lt;br /&gt;
'''Reason:''' &amp;lt;code&amp;gt;UnexpectedError&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
An unexpected exception occurred while evaluating the notification.&lt;br /&gt;
&lt;br /&gt;
'''How to resolve:''' Review the error &amp;lt;code&amp;gt;Message&amp;lt;/code&amp;gt; for more information.&lt;br /&gt;
&lt;br /&gt;
== Quick Troubleshooting Overview ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Failure reason&lt;br /&gt;
! What to check&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;code&amp;gt;NoMatchingLoginFound&amp;lt;/code&amp;gt;&lt;br /&gt;
| Service Login / &amp;lt;code&amp;gt;ComosLogin&amp;lt;/code&amp;gt; configuration for &amp;lt;code&amp;gt;DbKey&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;ProjectUid&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;WorkingOverlayId&amp;lt;/code&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;code&amp;gt;NoTemplateCDeviceInfoFound&amp;lt;/code&amp;gt;&lt;br /&gt;
| ServiceLogs and Comos REST API data retrieval&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;code&amp;gt;MultipleInterfaceAdministrationsFound&amp;lt;/code&amp;gt;&lt;br /&gt;
| Ambiguous &amp;lt;code&amp;gt;InterfaceAdministration&amp;lt;/code&amp;gt; configuration&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;code&amp;gt;NoInterfaceAdministrationsFound&amp;lt;/code&amp;gt;&lt;br /&gt;
| Missing &amp;lt;code&amp;gt;InterfaceAdministration&amp;lt;/code&amp;gt; configuration&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;code&amp;gt;ProxyNotImported&amp;lt;/code&amp;gt;&lt;br /&gt;
| ServiceLogs and proxy import/export&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;code&amp;gt;UnexpectedError&amp;lt;/code&amp;gt;&lt;br /&gt;
| Error &amp;lt;code&amp;gt;Message&amp;lt;/code&amp;gt; for exception details&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Summary ==&lt;br /&gt;
&lt;br /&gt;
Successfully processed EventNotifications do not generate persistent log data. If processing fails completely or partially, the EventNotification's &amp;lt;code&amp;gt;NotificationLog&amp;lt;/code&amp;gt; contains structured feedback identifying the failure and, where possible, the affected object.&lt;/div&gt;</summary>
		<author><name>MHM</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Update_to_UBIK_5.2_and_configure_plugin_deployment</id>
		<title>Update to UBIK 5.2 and configure plugin deployment</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Update_to_UBIK_5.2_and_configure_plugin_deployment"/>
				<updated>2026-10-29T09:57:59Z</updated>
		
		<summary type="html">&lt;p&gt;MHM: /* Recommended update procedure */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;This page describes how to update an existing UBIK® database to version 5.2 and how to configure the required standard plugins using the plugin selection introduced with UBIK® 5.2.&lt;br /&gt;
&lt;br /&gt;
If you do not have an existing database and want to initialise a new one, see [[Injection_Management#Version_5.2.0.2B]].&lt;br /&gt;
&lt;br /&gt;
The database-stored plugin configuration is the recommended approach. The Injection folder remains supported, especially for custom plugins and for compatibility with existing installations.&lt;br /&gt;
&lt;br /&gt;
== Prerequisites ==&lt;br /&gt;
&lt;br /&gt;
Before starting the update:&lt;br /&gt;
&lt;br /&gt;
* Identify the plugins currently used by the database.&lt;br /&gt;
* Install UBIK® Studio 5.2 and ensure that it can connect to the database.&lt;br /&gt;
* '''Stop all applications, processes, and services that are connected to the database to be updated.'''&lt;br /&gt;
* Ensure that an appropriate database backup is available according to the project's update procedure.&lt;br /&gt;
* Decide whether the plugins should be configured in the database or continue to be supplied through the Injection folder.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Recommended update procedure ==&lt;br /&gt;
&lt;br /&gt;
=== Stop all applications, processes, and services that are connected to the database to be updated ===&lt;br /&gt;
Important: Before starting the database update, stop all applications, processes, and services that are connected to the database being updated. Ensure that no other UBIK® instance or related service is accessing the database during the update.&lt;br /&gt;
&lt;br /&gt;
=== Start UBIK Studio 5.2 ===&lt;br /&gt;
&lt;br /&gt;
Start UBIK® Studio 5.2 and connect to the existing database that is to be updated.&lt;br /&gt;
&lt;br /&gt;
During database initialisation, the '''Add Plugins''' dialogue is displayed automatically.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;!-- Add screenshot: Add Plugins dialogue during first connection --&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Select the plugins ===&lt;br /&gt;
&lt;br /&gt;
Select the same standard plugins that were used by the database before the update.&lt;br /&gt;
&lt;br /&gt;
[[File:AddPlugins_Studio.png|center|upright|220px|&amp;quot;Add Plugins&amp;quot; Dialog]]&lt;br /&gt;
&lt;br /&gt;
Save the changes. UBIK® Studio continues startup and updates and initialises the database. This may take one or two minutes.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Verify the update ===&lt;br /&gt;
&lt;br /&gt;
After initialisation has completed, verify that:&lt;br /&gt;
&lt;br /&gt;
* the database was updated to UBIK® 5.2;&lt;br /&gt;
* all previously used plugins are loaded;&lt;br /&gt;
* embedded submodules are available.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;!-- Add screenshot: Loaded plugins after initialisation --&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The selected standard plugins are stored in the database. They therefore do not have to be maintained manually in the Injection folder for each UBIK® Studio installation.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Alternative: Use the Injection folder ==&lt;br /&gt;
&lt;br /&gt;
The existing Injection-folder mechanism is still supported.&lt;br /&gt;
&lt;br /&gt;
=== Deploy the plugins ===&lt;br /&gt;
&lt;br /&gt;
Copy all required plugins to the Injection folder of the UBIK® Studio 5.2 installation.&lt;br /&gt;
&lt;br /&gt;
=== Update the database ===&lt;br /&gt;
&lt;br /&gt;
Start UBIK® Studio 5.2 and connect to the existing database.&lt;br /&gt;
&lt;br /&gt;
When the '''Add Plugins''' dialogue is displayed, do not select plugins that are already provided through the Injection folder. Confirm the dialogue and continue.&lt;br /&gt;
&lt;br /&gt;
UBIK® Studio updates the database to version 5.2 and initialises the plugins supplied through the Injection folder.&lt;br /&gt;
&lt;br /&gt;
=== Verify the result ===&lt;br /&gt;
&lt;br /&gt;
After initialisation has completed, verify the database version and the loaded plugins in '''View → Plugins'''.&lt;br /&gt;
&lt;br /&gt;
{{Attention|When plugins are supplied through the Injection folder, administrators must maintain the Injection folder on every relevant UBIK® installation.}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Migrate from the Injection folder ==&lt;br /&gt;
&lt;br /&gt;
An installation that was initially updated using the Injection folder can be migrated later to the database-stored plugin configuration.&lt;br /&gt;
&lt;br /&gt;
# Open the plugin administration in UBIK® Studio.&lt;br /&gt;
# Select '''Add Plugins'''.&lt;br /&gt;
# Select the standard plugins currently supplied through the Injection folder.&lt;br /&gt;
# Save the changes. The plugin configuration is now stored in the database.&lt;br /&gt;
# Remove the selected standard plugins from the Injection folder.&lt;br /&gt;
# Restart UBIK® Studio and reconnect to the database.&lt;br /&gt;
# Verify that the configured plugins are loaded successfully.&lt;br /&gt;
&lt;br /&gt;
{{Attention|The Injection folder can still be used in addition to the database-stored configuration, for example for custom plugins. Avoid deploying the same standard plugin through both mechanisms.}}&lt;br /&gt;
&lt;br /&gt;
== Verification checklist ==&lt;br /&gt;
&lt;br /&gt;
* The database opens successfully with UBIK® Studio 5.2.&lt;br /&gt;
* The database reports version 5.2.&lt;br /&gt;
* All required plugins are loaded.&lt;br /&gt;
* Expected embedded submodules are available.&lt;br /&gt;
* Standard plugins stored in the database are no longer duplicated in the Injection folder.&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
* [[Injection Management]]&lt;br /&gt;
* [[Plugins]]&lt;br /&gt;
* [[HowTo:Create UBIK Plugin|Create UBIK Plugin]]&lt;br /&gt;
* [[Injection_Management#Version_5.2.0.2B]]&lt;/div&gt;</summary>
		<author><name>MHM</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MRO_Replication_Jobs</id>
		<title>MRO Replication Jobs</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MRO_Replication_Jobs"/>
				<updated>2026-09-21T10:05:54Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: /* Replication process */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;MRO replication jobs generate work packages from configured maintenance plans. The processing is divided into two steps: the Maintenance Planning Orchestrator schedules jobs for eligible maintenance plans, and a separate EnterpriseService executes the scheduled jobs.&lt;br /&gt;
&lt;br /&gt;
This page describes the available MRO replication jobs, the required BasicClient App and EnterpriseService configuration, and a basic setup for testing or demonstrating MRO replication.&lt;br /&gt;
&lt;br /&gt;
For the configuration and behaviour of maintenance plans, see [[MROMaintenancePlans]].&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Replication process ==&lt;br /&gt;
&lt;br /&gt;
MRO replication uses the following process:&lt;br /&gt;
&lt;br /&gt;
# The Maintenance Planning Orchestrator searches for maintenance plans that are ready for automatic work package generation.&lt;br /&gt;
# Each eligible maintenance plan provides the replication job required for its plan type.&lt;br /&gt;
# The orchestrator schedules the job in '''MRO_JOB_DISPATCHING'''.&lt;br /&gt;
# A separate EnterpriseService processes the scheduled job.&lt;br /&gt;
# The replication job uses the template work package and the linked '''INSTANCE_REPLICATION''' object to generate the work package.&lt;br /&gt;
&lt;br /&gt;
Scheduling a job does not execute the replication immediately. It creates a dispatching job containing the information required for later execution.&lt;br /&gt;
&lt;br /&gt;
'''For the basic use, the scheduling and execution processes can be configured in two separate UBIK.Studio folders.'''&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Available MRO replication jobs ==&lt;br /&gt;
&lt;br /&gt;
MRO provides two replication jobs.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Job&lt;br /&gt;
! Inheritance&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| '''ReplicateWorkpackageJob'''&lt;br /&gt;
| Derives from '''DispatchingJob''' for '''WorkPackage'''&lt;br /&gt;
| Generates a work package from the template and replication configuration of a maintenance plan.&lt;br /&gt;
|-&lt;br /&gt;
| '''ReplicateRoundWorkpackageJob'''&lt;br /&gt;
| Derives from '''ReplicateWorkpackageJob'''&lt;br /&gt;
| Generates the main work package of a maintenance round and the additional work packages configured by its child maintenance plans.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Both jobs use the same scheduling, dispatching, and execution infrastructure. The maintenance plan implementation returns the appropriate job when the Maintenance Planning Orchestrator requests its replication job.&lt;br /&gt;
&lt;br /&gt;
=== Work package replication ===&lt;br /&gt;
&lt;br /&gt;
A standard maintenance plan uses '''ReplicateWorkpackageJob'''.&lt;br /&gt;
&lt;br /&gt;
The maintenance plan provides:&lt;br /&gt;
&lt;br /&gt;
* a template work package through '''LK_WP_TMPL'''&lt;br /&gt;
* an '''INSTANCE_REPLICATION''' object through '''LK_REPLICATION_CONFIG'''&lt;br /&gt;
* the maintenance plan settings required for automatic work package generation&lt;br /&gt;
&lt;br /&gt;
The linked '''INSTANCE_REPLICATION''' object defines how the template work package is copied. The generated work package is not marked as a template.&lt;br /&gt;
&lt;br /&gt;
For the complete maintenance plan prerequisites and the properties set on generated work packages, see [[MROMaintenancePlans]].&lt;br /&gt;
&lt;br /&gt;
=== Round work package replication ===&lt;br /&gt;
&lt;br /&gt;
A '''RoundMaintenancePlan''' uses '''ReplicateRoundWorkpackageJob'''.&lt;br /&gt;
&lt;br /&gt;
The job creates the main work package from the Round Maintenance Plan. It then processes the child maintenance plans linked through '''SYSREL_ROUND_RELATION''' and creates their additional work packages. The additional work packages are assigned to the main round work package through '''TASK_OWNER'''.&lt;br /&gt;
&lt;br /&gt;
Round work package replication uses the same BasicClient App, EnterpriseService, and dispatching setup as standard work package replication. The maintenance plan implementation determines which job is scheduled.&lt;br /&gt;
&lt;br /&gt;
For the configuration and behaviour of Round Maintenance Plans, see [[MROMaintenancePlans]].&lt;br /&gt;
&lt;br /&gt;
== Scheduling and execution ==&lt;br /&gt;
&lt;br /&gt;
=== Maintenance Planning Orchestrator ===&lt;br /&gt;
&lt;br /&gt;
The scheduling process executes the following method:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| Class&lt;br /&gt;
| '''UBIK.MRO.MaintenancePlanningOrchestrator'''&lt;br /&gt;
|-&lt;br /&gt;
| Method&lt;br /&gt;
| '''Apply'''&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The Maintenance Planning Orchestrator searches for eligible maintenance plans, requests the appropriate replication job from each plan, and schedules the job in '''MRO_JOB_DISPATCHING'''.&lt;br /&gt;
&lt;br /&gt;
=== Scheduled Orchestrator ===&lt;br /&gt;
&lt;br /&gt;
The execution process executes the following method:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| Class&lt;br /&gt;
| '''UBIK.ServiceTask.Orchestration.ScheduledOrchestrator'''&lt;br /&gt;
|-&lt;br /&gt;
| Method&lt;br /&gt;
| '''Apply'''&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The Scheduled Orchestrator searches '''MRO_JOB_DISPATCHING''' for scheduled jobs and executes them.&lt;br /&gt;
&lt;br /&gt;
== MRO job dispatching ==&lt;br /&gt;
&lt;br /&gt;
'''MRO_JOB_DISPATCHING''' is the specialised DISPATCHING Interface Administration MetaClass used for MRO replication jobs.&lt;br /&gt;
&lt;br /&gt;
The orchestration process creates the required job objects automatically. Project teams do not need to create these objects manually.&lt;br /&gt;
&lt;br /&gt;
The execution EnterpriseService identifies '''MRO_JOB_DISPATCHING''' through the '''InterfaceAdmin''' value in '''MRO.PARAM.json'''.&lt;br /&gt;
&lt;br /&gt;
For general information about Interface Administration objects, see [[InterfaceAdministration]].&lt;br /&gt;
&lt;br /&gt;
=== Job statuses ===&lt;br /&gt;
&lt;br /&gt;
The execution status indicates the current state or result of a dispatching job.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Status&lt;br /&gt;
! Meaning&lt;br /&gt;
|-&lt;br /&gt;
| 0&lt;br /&gt;
| Undefined&lt;br /&gt;
| The execution state is undefined.&lt;br /&gt;
|-&lt;br /&gt;
| 1&lt;br /&gt;
| Success&lt;br /&gt;
| The execution completed successfully.&lt;br /&gt;
|-&lt;br /&gt;
| 2&lt;br /&gt;
| Terminated&lt;br /&gt;
| The execution was terminated.&lt;br /&gt;
|-&lt;br /&gt;
| 3&lt;br /&gt;
| Conflict&lt;br /&gt;
| An export conflict occurred.&lt;br /&gt;
|-&lt;br /&gt;
| 4&lt;br /&gt;
| Started&lt;br /&gt;
| Execution has started but has not yet completed.&lt;br /&gt;
|-&lt;br /&gt;
| 5&lt;br /&gt;
| Scheduled&lt;br /&gt;
| The job is scheduled but has not yet been executed.&lt;br /&gt;
|-&lt;br /&gt;
| 10&lt;br /&gt;
| Error&lt;br /&gt;
| An error occurred during execution.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
In a basic replication test, a newly scheduled job first has the status '''Scheduled'''. After successful execution, its status changes to '''Success'''.&lt;br /&gt;
&lt;br /&gt;
== Application setup ==&lt;br /&gt;
&lt;br /&gt;
A basic test or demonstration uses two separate UBIK.Studio folders.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Studio folder&lt;br /&gt;
! Purpose&lt;br /&gt;
! Required applications&lt;br /&gt;
|-&lt;br /&gt;
| Scheduling folder&lt;br /&gt;
| Provides the EnterpriseService web interface and starts the Maintenance Planning Orchestrator through the BasicClient App.&lt;br /&gt;
| '''UBIK.EnterpriseService.exe''' and '''UBIK.EnterpriseService.BasicClient.App.exe'''&lt;br /&gt;
|-&lt;br /&gt;
| Execution folder&lt;br /&gt;
| Runs the Scheduled Orchestrator and executes jobs from '''MRO_JOB_DISPATCHING'''.&lt;br /&gt;
| '''UBIK.EnterpriseService.exe'''&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The folder names and paths in the examples can be changed. Every configured path must point to the corresponding file in the local deployment.&lt;br /&gt;
&lt;br /&gt;
== Scheduling folder setup ==&lt;br /&gt;
&lt;br /&gt;
The scheduling folder requires the following files:&lt;br /&gt;
&lt;br /&gt;
* '''UBIK.EnterpriseService.exe'''&lt;br /&gt;
* '''UBIK.EnterpriseService.exe.config'''&lt;br /&gt;
* '''UBIK.EnterpriseService.BasicClient.App.exe'''&lt;br /&gt;
* '''UBIK.EnterpriseService.BasicClient.App.exe.config'''&lt;br /&gt;
* '''JSON\ReplicateWorkpackageJob.json'''&lt;br /&gt;
&lt;br /&gt;
=== Configure the scheduling EnterpriseService ===&lt;br /&gt;
&lt;br /&gt;
In '''UBIK.EnterpriseService.exe.config''', configure the following application settings:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Default value&lt;br /&gt;
! Required value&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| '''ExecuteWebInterface'''&lt;br /&gt;
| 0&lt;br /&gt;
| 1&lt;br /&gt;
| Enables the web interface used by the BasicClient App.&lt;br /&gt;
|-&lt;br /&gt;
| '''ExecuteTaskByJsonFile'''&lt;br /&gt;
| 0&lt;br /&gt;
| 0&lt;br /&gt;
| The scheduling EnterpriseService does not execute the recurring task configuration used by the execution EnterpriseService.&lt;br /&gt;
|-&lt;br /&gt;
| '''WebInterfacePort'''&lt;br /&gt;
| 9000&lt;br /&gt;
| 9000&lt;br /&gt;
| Defines the port used by the web interface in this example.&lt;br /&gt;
|-&lt;br /&gt;
| '''WebInterfaceHost'''&lt;br /&gt;
| http://localhost&lt;br /&gt;
| http://localhost&lt;br /&gt;
| Defines the host used by the web interface in this example.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Configure the BasicClient App ===&lt;br /&gt;
&lt;br /&gt;
In '''UBIK.EnterpriseService.BasicClient.App.exe.config''', configure the following application settings:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Example value&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| '''BaseAddress'''&lt;br /&gt;
| http://localhost:9000&lt;br /&gt;
| Identifies the web interface exposed by the scheduling EnterpriseService.&lt;br /&gt;
|-&lt;br /&gt;
| '''PathToBasicEnterpriseServiceRequestJsonFile'''&lt;br /&gt;
| Full path to ReplicateWorkpackageJob.json&lt;br /&gt;
| Identifies the request file that starts the Maintenance Planning Orchestrator.&lt;br /&gt;
|-&lt;br /&gt;
| '''PathToBasicEnterpriseServiceRequestJsonFileList'''&lt;br /&gt;
| Empty&lt;br /&gt;
| No request file list is used in this setup.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
'''BaseAddress''' must match '''WebInterfaceHost''' and '''WebInterfacePort''' in the scheduling EnterpriseService configuration. Replace the example path with the actual path to '''ReplicateWorkpackageJob.json'''.&lt;br /&gt;
&lt;br /&gt;
=== Configure ReplicateWorkpackageJob.json ===&lt;br /&gt;
&lt;br /&gt;
Create '''ReplicateWorkpackageJob.json''' in the JSON folder and configure the target database, orchestrator class, and method:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;javascript&amp;quot;&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;SSPI&amp;quot;: true,&lt;br /&gt;
  &amp;quot;SQLUser&amp;quot;: &amp;quot;&amp;quot;,&lt;br /&gt;
  &amp;quot;SQLPassword&amp;quot;: &amp;quot;&amp;quot;,&lt;br /&gt;
  &amp;quot;SQLServer&amp;quot;: &amp;quot;(localdb)\\MSSQLLocalDB&amp;quot;,&lt;br /&gt;
  &amp;quot;SQLInitialCatalog&amp;quot;: &amp;quot;JOB.TEST&amp;quot;,&lt;br /&gt;
  &amp;quot;ClassFullname&amp;quot;: &amp;quot;UBIK.MRO.MaintenancePlanningOrchestrator&amp;quot;,&lt;br /&gt;
  &amp;quot;MethodName&amp;quot;: &amp;quot;Apply&amp;quot;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Adapt the database settings to the target database. Keep '''ClassFullname''' and '''MethodName''' as shown so that the request executes '''UBIK.MRO.MaintenancePlanningOrchestrator.Apply'''.&lt;br /&gt;
&lt;br /&gt;
== Execution folder setup ==&lt;br /&gt;
&lt;br /&gt;
The execution folder requires the following files:&lt;br /&gt;
&lt;br /&gt;
* '''UBIK.EnterpriseService.exe'''&lt;br /&gt;
* '''UBIK.EnterpriseService.exe.config'''&lt;br /&gt;
* '''JSON\MRO.json'''&lt;br /&gt;
* '''JSON\MRO.PARAM.json'''&lt;br /&gt;
&lt;br /&gt;
=== Configure the execution EnterpriseService ===&lt;br /&gt;
&lt;br /&gt;
In '''UBIK.EnterpriseService.exe.config''', configure the following application settings:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Default value&lt;br /&gt;
! Required value&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| '''PluginExecutionConfigPath'''&lt;br /&gt;
| Empty&lt;br /&gt;
| Full path to '''MRO.json'''&lt;br /&gt;
| Identifies the recurring task configuration.&lt;br /&gt;
|-&lt;br /&gt;
| '''ExecuteWebInterface'''&lt;br /&gt;
| 0&lt;br /&gt;
| 0&lt;br /&gt;
| The execution EnterpriseService does not require the web interface in this setup.&lt;br /&gt;
|-&lt;br /&gt;
| '''ExecuteTaskByJsonFile'''&lt;br /&gt;
| 0&lt;br /&gt;
| 1&lt;br /&gt;
| Enables execution of the tasks configured in '''MRO.json'''.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Configure MRO.json ===&lt;br /&gt;
&lt;br /&gt;
Create '''MRO.json''' and configure the database connection, execution interval, Scheduled Orchestrator, and path to '''MRO.PARAM.json''':&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;javascript&amp;quot;&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;RepeateEveryMinutes&amp;quot;: 0.2,&lt;br /&gt;
  &amp;quot;SqlConnectionDefinition&amp;quot;: {&lt;br /&gt;
    &amp;quot;SSPI&amp;quot;: true,&lt;br /&gt;
    &amp;quot;SQLUser&amp;quot;: &amp;quot;&amp;quot;,&lt;br /&gt;
    &amp;quot;SQLPassword&amp;quot;: &amp;quot;&amp;quot;,&lt;br /&gt;
    &amp;quot;SQLServer&amp;quot;: &amp;quot;(localdb)\\MSSQLLocalDB&amp;quot;,&lt;br /&gt;
    &amp;quot;SQLInitialCatalog&amp;quot;: &amp;quot;JOB.TEST&amp;quot;&lt;br /&gt;
  },&lt;br /&gt;
  &amp;quot;Tasks&amp;quot;: [&lt;br /&gt;
    {&lt;br /&gt;
      &amp;quot;ClassFullname&amp;quot;: &amp;quot;UBIK.ServiceTask.Orchestration.ScheduledOrchestrator&amp;quot;,&lt;br /&gt;
      &amp;quot;MethodName&amp;quot;: &amp;quot;Apply&amp;quot;,&lt;br /&gt;
      &amp;quot;MethodParameterPathFullName&amp;quot;: &amp;quot;&amp;lt;full path to MRO.PARAM.json&amp;gt;&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Adapt the database settings and '''MethodParameterPathFullName''' to the target deployment. Keep '''ClassFullname''' and '''MethodName''' as shown so that the task executes '''UBIK.ServiceTask.Orchestration.ScheduledOrchestrator.Apply'''.&lt;br /&gt;
&lt;br /&gt;
'''RepeateEveryMinutes''' defines how often the execution EnterpriseService checks for scheduled jobs. A value of 0 causes continuous checking. The value 0.2 can be used for a demonstration where continuous checking is not required.&lt;br /&gt;
&lt;br /&gt;
=== Configure MRO.PARAM.json ===&lt;br /&gt;
&lt;br /&gt;
Create '''MRO.PARAM.json''' and configure the UID of '''MRO_JOB_DISPATCHING''':&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;javascript&amp;quot;&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;InterfaceAdmin&amp;quot;: &amp;quot;BBAF1C9E-8F3B-4C9A-9E2D-5F7A1C3E4B6D&amp;quot;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The '''InterfaceAdmin''' value identifies '''MRO_JOB_DISPATCHING''' for the Scheduled Orchestrator.&lt;br /&gt;
&lt;br /&gt;
== Maintenance plan prerequisites ==&lt;br /&gt;
&lt;br /&gt;
For a basic work package replication scenario, configure:&lt;br /&gt;
&lt;br /&gt;
* a concrete maintenance plan type such as '''CyclicMaintenancePlan'''&lt;br /&gt;
* an asset through '''LK_ASSET'''&lt;br /&gt;
* a template work package through '''LK_WP_TMPL'''&lt;br /&gt;
* an '''INSTANCE_REPLICATION''' object through '''LK_REPLICATION_CONFIG'''&lt;br /&gt;
* '''PLAN_STATUS''' as Active&lt;br /&gt;
* '''AUTO_CREATE''' as enabled&lt;br /&gt;
* planning dates that make the plan eligible for generation&lt;br /&gt;
* a template work package with '''ISTEMPLATE''' set&lt;br /&gt;
&lt;br /&gt;
The maintenance plan must not already have an open generated work package. Detailed generation conditions are documented in [[MROMaintenancePlans]].&lt;br /&gt;
&lt;br /&gt;
== Basic test or demonstration ==&lt;br /&gt;
&lt;br /&gt;
=== Prepare the maintenance plan ===&lt;br /&gt;
&lt;br /&gt;
# Open the database in UBIK.Studio.&lt;br /&gt;
# Create or select a valid maintenance plan.&lt;br /&gt;
# Assign the required asset through '''LK_ASSET'''.&lt;br /&gt;
# Assign a template work package through '''LK_WP_TMPL'''.&lt;br /&gt;
# Verify that '''ISTEMPLATE''' is set on the template work package.&lt;br /&gt;
# Assign an '''INSTANCE_REPLICATION''' object through '''LK_REPLICATION_CONFIG'''.&lt;br /&gt;
# Set '''PLAN_STATUS''' to Active.&lt;br /&gt;
# Enable '''AUTO_CREATE'''.&lt;br /&gt;
# Configure the planning dates so that '''EARLIEST_GENERATION_DATE''' has been reached.&lt;br /&gt;
# Verify that the maintenance plan has no open generated work package.&lt;br /&gt;
&lt;br /&gt;
=== Schedule the job ===&lt;br /&gt;
&lt;br /&gt;
# Start '''UBIK.EnterpriseService.exe''' in the scheduling folder.&lt;br /&gt;
# Start '''UBIK.EnterpriseService.BasicClient.App.exe''' manually, or start it through a configured Windows Task Scheduler task.&lt;br /&gt;
# The BasicClient App sends the request defined in '''ReplicateWorkpackageJob.json''' to the scheduling EnterpriseService.&lt;br /&gt;
# '''UBIK.MRO.MaintenancePlanningOrchestrator.Apply''' searches for eligible maintenance plans and schedules their replication jobs.&lt;br /&gt;
&lt;br /&gt;
=== Verify the scheduled job ===&lt;br /&gt;
&lt;br /&gt;
# Open '''MRO_JOB_DISPATCHING''' in UBIK.Studio.&lt;br /&gt;
# Verify that a job object was created for the eligible maintenance plan.&lt;br /&gt;
# Verify that '''INTERFACE_EXECUTION_STATUS''' is Scheduled.&lt;br /&gt;
# If the execution EnterpriseService has not been started, verify that no generated work package exists yet.&lt;br /&gt;
&lt;br /&gt;
=== Execute the job ===&lt;br /&gt;
&lt;br /&gt;
# Start '''UBIK.EnterpriseService.exe''' in the execution folder.&lt;br /&gt;
# The EnterpriseService executes '''UBIK.ServiceTask.Orchestration.ScheduledOrchestrator.Apply''' according to '''MRO.json'''.&lt;br /&gt;
# The Scheduled Orchestrator reads the scheduled job from '''MRO_JOB_DISPATCHING'''.&lt;br /&gt;
# The configured replication job generates the work package.&lt;br /&gt;
&lt;br /&gt;
=== Verify the result ===&lt;br /&gt;
&lt;br /&gt;
# Refresh '''MRO_JOB_DISPATCHING'''.&lt;br /&gt;
# Verify that the job status is Success.&lt;br /&gt;
# Refresh the Work Package MetaClass.&lt;br /&gt;
# Verify that a new work package was created.&lt;br /&gt;
# Verify that '''ISTEMPLATE''' is not set on the generated work package.&lt;br /&gt;
# Verify the links and planning values described in [[MROMaintenancePlans]].&lt;br /&gt;
&lt;br /&gt;
For a Round Maintenance Plan, also verify that:&lt;br /&gt;
&lt;br /&gt;
* the main round work package was created&lt;br /&gt;
* the child maintenance plans produced the configured additional work packages&lt;br /&gt;
* the additional work packages are assigned to the main round work package through '''TASK_OWNER'''&lt;br /&gt;
&lt;br /&gt;
== Triggering the scheduling process ==&lt;br /&gt;
&lt;br /&gt;
For a manual test or demonstration, start '''UBIK.EnterpriseService.BasicClient.App.exe''' manually.&lt;br /&gt;
&lt;br /&gt;
For recurring execution, a Windows Task Scheduler task can start '''UBIK.EnterpriseService.BasicClient.App.exe'''. The executable path is configured in the task. The request and target orchestrator are configured in '''UBIK.EnterpriseService.BasicClient.App.exe.config''' and '''ReplicateWorkpackageJob.json'''.&lt;br /&gt;
&lt;br /&gt;
Running the Maintenance Planning Orchestrator processes all eligible maintenance plans.&lt;br /&gt;
&lt;br /&gt;
== Configuration summary ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Component&lt;br /&gt;
! Configuration&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| Scheduling EnterpriseService&lt;br /&gt;
| '''ExecuteWebInterface''' = 1&lt;br /&gt;
| Exposes the web interface used by the BasicClient App.&lt;br /&gt;
|-&lt;br /&gt;
| BasicClient App&lt;br /&gt;
| '''PathToBasicEnterpriseServiceRequestJsonFile'''&lt;br /&gt;
| Points to '''ReplicateWorkpackageJob.json'''.&lt;br /&gt;
|-&lt;br /&gt;
| Scheduling request&lt;br /&gt;
| '''UBIK.MRO.MaintenancePlanningOrchestrator.Apply'''&lt;br /&gt;
| Searches for eligible maintenance plans and schedules their jobs.&lt;br /&gt;
|-&lt;br /&gt;
| Execution EnterpriseService&lt;br /&gt;
| '''ExecuteTaskByJsonFile''' = 1&lt;br /&gt;
| Enables execution using '''MRO.json'''.&lt;br /&gt;
|-&lt;br /&gt;
| Execution task&lt;br /&gt;
| '''UBIK.ServiceTask.Orchestration.ScheduledOrchestrator.Apply'''&lt;br /&gt;
| Processes scheduled dispatching jobs.&lt;br /&gt;
|-&lt;br /&gt;
| Execution parameter&lt;br /&gt;
| '''InterfaceAdmin'''&lt;br /&gt;
| Identifies '''MRO_JOB_DISPATCHING'''.&lt;br /&gt;
|-&lt;br /&gt;
| Maintenance plan&lt;br /&gt;
| '''LK_REPLICATION_CONFIG'''&lt;br /&gt;
| Links directly to the '''INSTANCE_REPLICATION''' object used to copy the template work package.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
* [[MROMaintenancePlans]]&lt;br /&gt;
* [[InterfaceAdministration]]&lt;br /&gt;
* [[InterfaceExecution]]&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=UNC_File_Storage_Layout</id>
		<title>UNC File Storage Layout</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=UNC_File_Storage_Layout"/>
				<updated>2026-09-04T10:06:24Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= UNC File Storage Layout =&lt;br /&gt;
&lt;br /&gt;
The UNC File Storage Layout defines how local file documents are physically stored in the UNC document root. UBIK supports a flat layout and a folder-partitioned layout.&lt;br /&gt;
&lt;br /&gt;
Folder partitioning is available from UBIK 5.2 and is the recommended layout for UNC file storage. To maintain downward compatibility, the default remains the existing flat layout until an administrator starts the transfer.&lt;br /&gt;
&lt;br /&gt;
The layout changes only the physical file location. The document object and its '''LOCALPATH''' value remain unchanged.&lt;br /&gt;
&lt;br /&gt;
== Scope ==&lt;br /&gt;
&lt;br /&gt;
The UNC File Storage Layout applies only when '''File Storage Mode''' is set to '''UNC'''.&lt;br /&gt;
&lt;br /&gt;
Folder partitioning is not a separate File Storage Mode. The existing modes remain unchanged:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! File Storage Mode&lt;br /&gt;
|-&lt;br /&gt;
| 0&lt;br /&gt;
| Undefined&lt;br /&gt;
|-&lt;br /&gt;
| 1&lt;br /&gt;
| UNC&lt;br /&gt;
|-&lt;br /&gt;
| 2&lt;br /&gt;
| Cloud&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Only local file documents with '''IsLocalDoc = true''' are affected. Cloud documents and non-local file documents are ignored.&lt;br /&gt;
&lt;br /&gt;
== UNC File Storage Layout Setting ==&lt;br /&gt;
&lt;br /&gt;
The database setting '''UNC File Storage Layout''' identifies the layout currently used by the database.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Description&lt;br /&gt;
|-&lt;br /&gt;
| Flat&lt;br /&gt;
| Local file documents are stored directly in the document root folder.&lt;br /&gt;
|-&lt;br /&gt;
| Folder Partitioning&lt;br /&gt;
| Local file documents are distributed across generated subfolders based on the document UID.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The setting is visible in the database settings but is read-only. It can be changed only by successfully completing the transfer tool.&lt;br /&gt;
&lt;br /&gt;
For new and existing databases, the default value is '''Flat'''. Updating a database does not change its existing '''File Storage Mode''' or move any files automatically.&lt;br /&gt;
&lt;br /&gt;
== Storage Layouts ==&lt;br /&gt;
&lt;br /&gt;
=== Flat ===&lt;br /&gt;
&lt;br /&gt;
With the flat layout, local file documents are stored directly in the document root folder.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
:''.../doc/8ec24142-17eb-4640-bdcf-31d696c398de.jpg''&lt;br /&gt;
&lt;br /&gt;
=== Folder Partitioning ===&lt;br /&gt;
&lt;br /&gt;
With folder partitioning, UBIK generates two folder levels from the document UID:&lt;br /&gt;
&lt;br /&gt;
* The first character of the UID is used for the first folder level.&lt;br /&gt;
* The second and third characters of the UID are used for the second folder level.&lt;br /&gt;
* Generated folder names use lowercase characters.&lt;br /&gt;
&lt;br /&gt;
Example UID:&lt;br /&gt;
&lt;br /&gt;
:''8ec24142-17eb-4640-bdcf-31d696c398de''&lt;br /&gt;
&lt;br /&gt;
Resulting physical path:&lt;br /&gt;
&lt;br /&gt;
:''.../doc/8/ec/8ec24142-17eb-4640-bdcf-31d696c398de.jpg''&lt;br /&gt;
&lt;br /&gt;
== LOCALPATH and Physical File Resolution ==&lt;br /&gt;
&lt;br /&gt;
The '''LOCALPATH''' property continues to contain only the file name and extension:&lt;br /&gt;
&lt;br /&gt;
:''8ec24142-17eb-4640-bdcf-31d696c398de.jpg''&lt;br /&gt;
&lt;br /&gt;
Folder-partitioning subfolders are not stored in '''LOCALPATH'''. UBIK calculates the complete physical file path when the file is accessed, using:&lt;br /&gt;
&lt;br /&gt;
* the document root path&lt;br /&gt;
* the File Storage Mode&lt;br /&gt;
* the UNC File Storage Layout&lt;br /&gt;
* the document UID and '''LOCALPATH'''&lt;br /&gt;
&lt;br /&gt;
== Database-wide Layout ==&lt;br /&gt;
&lt;br /&gt;
A database uses one UNC storage layout for all local file documents. Flat storage and folder partitioning must not be mixed within the same database.&lt;br /&gt;
&lt;br /&gt;
After a successful transfer, all existing and newly created local file documents use the selected layout.&lt;br /&gt;
&lt;br /&gt;
== Transferring Local File Documents ==&lt;br /&gt;
&lt;br /&gt;
Administrators can transfer all local file documents to the other layout using:&lt;br /&gt;
&lt;br /&gt;
:''Tools → Apply UNC File Storage Layout to All Files''&lt;br /&gt;
&lt;br /&gt;
Tooltip:&lt;br /&gt;
&lt;br /&gt;
:''Updates all local files to use the other UNC file storage layout.''&lt;br /&gt;
&lt;br /&gt;
The tool is available only when '''File Storage Mode = UNC'''. Because there are only two layouts, UBIK determines the target automatically:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Current layout&lt;br /&gt;
! Target layout&lt;br /&gt;
|-&lt;br /&gt;
| Flat&lt;br /&gt;
| Folder Partitioning&lt;br /&gt;
|-&lt;br /&gt;
| Folder Partitioning&lt;br /&gt;
| Flat&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The '''UNC File Storage Layout''' setting is changed only after all affected files have been transferred successfully.&lt;br /&gt;
&lt;br /&gt;
=== Transfer Process ===&lt;br /&gt;
&lt;br /&gt;
For each local file document, UBIK:&lt;br /&gt;
&lt;br /&gt;
# calculates the current and target physical file paths&lt;br /&gt;
# creates the required target folders&lt;br /&gt;
# copies the file to the target path&lt;br /&gt;
# verifies that the copied file exists&lt;br /&gt;
# deletes the source file only after successful verification&lt;br /&gt;
&lt;br /&gt;
If a file already exists at the target path, the transfer is aborted to prevent data loss.&lt;br /&gt;
&lt;br /&gt;
The transfer changes only the physical storage location. It does not:&lt;br /&gt;
&lt;br /&gt;
* change '''LOCALPATH'''&lt;br /&gt;
* update UTS&lt;br /&gt;
* create a new document version&lt;br /&gt;
* update the update session&lt;br /&gt;
* fire events&lt;br /&gt;
&lt;br /&gt;
Empty folders may remain in the previous folder structure after the transfer, but they no longer contain transferred files.&lt;br /&gt;
&lt;br /&gt;
=== Access During the Transfer ===&lt;br /&gt;
&lt;br /&gt;
Local file documents are locked database-wide for all clients and services while the transfer is running. During this time, users and services cannot:&lt;br /&gt;
&lt;br /&gt;
* create new local file document objects&lt;br /&gt;
* change existing local file document objects or their properties&lt;br /&gt;
* open, read, download, or view local document files&lt;br /&gt;
&lt;br /&gt;
Cloud documents and non-local file documents remain available and are not affected by the lock.&lt;br /&gt;
&lt;br /&gt;
== Transfer Result and Error Handling ==&lt;br /&gt;
&lt;br /&gt;
After a successful transfer, UBIK changes the database setting to the target layout and displays the number of transferred files.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
:''1000 files have been transferred.''&lt;br /&gt;
&lt;br /&gt;
If the transfer fails or is interrupted:&lt;br /&gt;
&lt;br /&gt;
* the transfer is aborted&lt;br /&gt;
* the affected file document is reported&lt;br /&gt;
* the '''UNC File Storage Layout''' setting remains unchanged&lt;br /&gt;
* the database is not left with a mixed UNC storage layout&lt;br /&gt;
* the administrator must start the transfer again&lt;br /&gt;
&lt;br /&gt;
A transfer is aborted if a file cannot be found, copied, verified, or deleted, or if the target file already exists.&lt;br /&gt;
&lt;br /&gt;
Failure message:&lt;br /&gt;
&lt;br /&gt;
:''The transfer could not be completed. The UNC File Storage Layout has not been changed.''&lt;br /&gt;
&lt;br /&gt;
== Example: Migrating an Existing Database ==&lt;br /&gt;
&lt;br /&gt;
An existing UBIK database contains 1000 local file documents in flat UNC storage.&lt;br /&gt;
&lt;br /&gt;
# The system is updated to UBIK 5.2.&lt;br /&gt;
# The existing File Storage Mode remains unchanged.&lt;br /&gt;
# The new '''UNC File Storage Layout''' setting is initialized as '''Flat'''.&lt;br /&gt;
# All existing documents remain readable in their current locations.&lt;br /&gt;
# An administrator selects ''Tools → Apply UNC File Storage Layout to All Files''.&lt;br /&gt;
# UBIK locks local file documents and transfers all files to the generated folder structure.&lt;br /&gt;
# After all files have been copied, verified, and removed from their source locations, the layout setting changes to '''Folder Partitioning'''.&lt;br /&gt;
# UBIK confirms that 1000 files have been transferred. &amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
From this point onward, newly created local file documents are stored using folder partitioning.&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
* [[SYSCLS_DOCUMENT]]&lt;br /&gt;
* [[SYSCLS_FILEDOCUMENT]]&lt;br /&gt;
* [[FILEDOCUMENT]]&lt;br /&gt;
* [[SYSCLS_EDITABLEDOCUMENT]]&lt;br /&gt;
* [[Documents (Client)]]&lt;br /&gt;
* [[UBIK_Studio_Basics]]&lt;br /&gt;
&lt;br /&gt;
[[Category:Document|UNC File Storage Layout]]&lt;br /&gt;
[[Category:Studio|UNC File Storage Layout]]&lt;br /&gt;
[[Category:Studio tools|UNC File Storage Layout]]&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MRO_Notification</id>
		<title>MRO Notification</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MRO_Notification"/>
				<updated>2026-09-04T08:35:33Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: Created page with &amp;quot;An MRO Notification represents a reported maintenance issue related to an Asset. It records the responsible user, due date, priority, and current processing status. A Notifica...&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;An MRO Notification represents a reported maintenance issue related to an Asset. It records the responsible user, due date, priority, and current processing status. A Notification can also serve as the origin of a [[MRO (Plugin)#Work Package|Work Package]]. The created Work Package references the Notification so that its origin remains traceable.&lt;br /&gt;
&lt;br /&gt;
Technical object name: NOTIFICATION&lt;br /&gt;
&lt;br /&gt;
Runtime class: UBIK.MRO.Notification&lt;br /&gt;
&lt;br /&gt;
== Creating and Editing Notifications ==&lt;br /&gt;
&lt;br /&gt;
A Notification is created for an Asset using LK_ASSET. Functional Locations and Equipment can be referenced because they are specialized Asset types.&lt;br /&gt;
&lt;br /&gt;
In addition to the standard properties of a {{UBIK}} content object, a Notification provides MRO-specific properties for its Asset, assigned user, due date, priority, status, and optional Work Package template. These properties can be edited after creation. Changes to NOTIF_STATUS are restricted by the [[#Notification Status|defined status transitions]].&lt;br /&gt;
&lt;br /&gt;
'''Properties'''&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=&amp;quot;70%&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Name !! Data type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| LK_ASSET || {{Guid}} || Link to the Asset for which the Notification was created&lt;br /&gt;
|-&lt;br /&gt;
| LK_WP_TMPL || {{Guid}} || Optional link to a Work Package template&lt;br /&gt;
|-&lt;br /&gt;
| LK_ASGN_USER || {{Guid}} || Link to the assigned user&lt;br /&gt;
|-&lt;br /&gt;
| NOTIF_DUE_DATE || {{DateTime}} || Due date of the Notification&lt;br /&gt;
|-&lt;br /&gt;
| NOTIF_PRIORITY || {{Integer}} || Priority of the Notification&lt;br /&gt;
|-&lt;br /&gt;
| NOTIF_STATUS || {{Integer}} || Current processing status of the Notification&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Notification Priority ===&lt;br /&gt;
&lt;br /&gt;
The priority is stored in NOTIF_PRIORITY. The following values are available:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=&amp;quot;50%&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Value !! Name !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || Undefined || No priority has been assigned&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Low || Low priority&lt;br /&gt;
|-&lt;br /&gt;
| 20 || Medium || Medium priority&lt;br /&gt;
|-&lt;br /&gt;
| 30 || High || High priority&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Notification Status ===&lt;br /&gt;
&lt;br /&gt;
The current processing state is stored in NOTIF_STATUS. The following values are available:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=&amp;quot;50%&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Value !! Status&lt;br /&gt;
|-&lt;br /&gt;
| 0 || Undefined&lt;br /&gt;
|-&lt;br /&gt;
| 10 || New&lt;br /&gt;
|-&lt;br /&gt;
| 20 || Confirmed&lt;br /&gt;
|-&lt;br /&gt;
| 30 || In Progress&lt;br /&gt;
|-&lt;br /&gt;
| 40 || Completed&lt;br /&gt;
|-&lt;br /&gt;
| 50 || Rejected&lt;br /&gt;
|-&lt;br /&gt;
| 60 || Closed&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Status changes are validated by the Notification. Only the following transitions are permitted:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=&amp;quot;70%&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Current status !! Permitted next status&lt;br /&gt;
|-&lt;br /&gt;
| Undefined || New&lt;br /&gt;
|-&lt;br /&gt;
| New || Confirmed or Rejected&lt;br /&gt;
|-&lt;br /&gt;
| Confirmed || In Progress&lt;br /&gt;
|-&lt;br /&gt;
| In Progress || Completed&lt;br /&gt;
|-&lt;br /&gt;
| Completed || Closed&lt;br /&gt;
|-&lt;br /&gt;
| Rejected || Closed&lt;br /&gt;
|-&lt;br /&gt;
| Closed || No further transition&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Setting the same status again is permitted. Other status changes are rejected. Completed and Rejected Notifications can only be moved to Closed and cannot be reopened through the standard status logic.&lt;br /&gt;
&lt;br /&gt;
== Creating a Work Package from a Notification ==&lt;br /&gt;
&lt;br /&gt;
A Work Package can be created from a Notification either using a Maintenance Plan or through manual creation. In both cases, the created Work Package is linked to the originating Notification using LK_NOTIFICATION. This makes the origin of the Work Package traceable.&lt;br /&gt;
&lt;br /&gt;
=== Maintenance Plan-based Creation ===&lt;br /&gt;
&lt;br /&gt;
For Maintenance Plan-based creation, the Maintenance Plans assigned to the Notification's Asset are evaluated.&lt;br /&gt;
&lt;br /&gt;
* If multiple Maintenance Plans are available, one of them is selected for the creation.&lt;br /&gt;
* The Work Package is created based on the selected Maintenance Plan and its Work Package template.&lt;br /&gt;
* The created Work Package references the originating Notification through LK_NOTIFICATION.&lt;br /&gt;
&lt;br /&gt;
=== Manual Creation ===&lt;br /&gt;
&lt;br /&gt;
For manual creation, a new Work Package is created for the same Asset as the Notification.&lt;br /&gt;
&lt;br /&gt;
* The Work Package is linked to the Asset referenced by LK_ASSET.&lt;br /&gt;
* The Work Package references the originating Notification through LK_NOTIFICATION.&lt;br /&gt;
* Subordinate Work Packages and Tasks can be added to structure the required maintenance work.&lt;br /&gt;
&lt;br /&gt;
'''Relevant Work Package property'''&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=&amp;quot;70%&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Name !! Data type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| LK_NOTIFICATION || {{Guid}} || Link from the Work Package to the originating Notification&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Supporting File Documents ==&lt;br /&gt;
&lt;br /&gt;
The FileDocumentNotification class provides document attachments for Notifications. Each document is linked to its Notification using LK_NOTIFICATION.&lt;br /&gt;
&lt;br /&gt;
Runtime class: UBIK.MRO.FileDocumentNotification&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=&amp;quot;70%&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Name !! Data type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| LK_NOTIFICATION || {{Guid}} || Link to the associated Notification&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The MRO Notification implementation does not define additional restrictions for file types, file sizes, or the number of attached documents.&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
* [[MRO (Plugin)]]&lt;br /&gt;
* [[MRO (Plugin)#Work Package|Work Package]]&lt;br /&gt;
* [[MRO_Objects_(Client)]]&lt;br /&gt;
* [[MRO_Implemented_Objects]]&lt;br /&gt;
* [[MROMaintenancePlans]]&lt;br /&gt;
* [[MRO_Material_Management]]&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Version_5.3.0_(Server)</id>
		<title>Version 5.3.0 (Server)</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Version_5.3.0_(Server)"/>
				<updated>2026-08-31T13:21:07Z</updated>
		
		<summary type="html">&lt;p&gt;NWE: /* Bug Fixes */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;__NOTOC__&lt;br /&gt;
&lt;br /&gt;
= 5.3.0.?? - 2026-??-?? (Initial Release) =&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div class=&amp;quot;toccolours mw-collapsible mw-collapsed&amp;quot; style=&amp;quot;width:100%; overflow:auto;&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-weight:bold;line-height:1.6;&amp;quot;&amp;gt;&amp;lt;h2 style=&amp;quot;text-decoration:none;border-style:none&amp;quot;&amp;gt;UBIK.Studio&amp;lt;/h2&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;mw-collapsible-content&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
=== Features ===&lt;br /&gt;
* &lt;br /&gt;
--&amp;gt;&lt;br /&gt;
=== Bug Fixes ===&lt;br /&gt;
* An issue where the Bulk Editor's context menu showed actions for the selected, but not the right-clicked object, was fixed.&lt;br /&gt;
* An issue where injectable UI aspects weren't cleaned up when reconnecting was fixed.&lt;br /&gt;
* The &amp;quot;missing plugins&amp;quot; dialog now displays the actual name of the module, if available.&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
=== Enhancements ===&lt;br /&gt;
=== Known Issues ===&lt;br /&gt;
--&amp;gt;&lt;br /&gt;
&amp;lt;/div&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;toccolours mw-collapsible mw-collapsed&amp;quot; style=&amp;quot;width:100%; overflow:auto;&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-weight:bold;line-height:1.6;&amp;quot;&amp;gt;&amp;lt;h2 style=&amp;quot;text-decoration:none;border-style:none&amp;quot;&amp;gt;Kernel&amp;lt;/h2&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;mw-collapsible-content&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
=== Features ===&lt;br /&gt;
* &lt;br /&gt;
 --&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Release notes|Version 5.3.0 (Server)]]&lt;br /&gt;
[[Category:Server|Version 5.3.0 (Server)]]&lt;br /&gt;
[[Category:Version 5.3|Version 5.3.0 (Server)]]&lt;br /&gt;
&lt;br /&gt;
=== Bug Fixes === &lt;br /&gt;
* An issue where the database adaptation for a MetaProxy was incomplete when a relational property was changed after establishing the MetaProxyProperty cache was fixed.&lt;br /&gt;
=== Enhancements ===&lt;br /&gt;
* The custom file document relation (&amp;quot;REL_FILEDOCUMENT&amp;quot;) is now available by default, as it was in version 3.7.1.&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
=== Known Issues === &lt;br /&gt;
* Due to Configurable Unique Constraints not being implemented yet, Exclusive Access is not guaranteed on database level currently.&lt;br /&gt;
--&amp;gt;&lt;br /&gt;
&amp;lt;/div&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
&amp;lt;div class=&amp;quot;toccolours mw-collapsible mw-collapsed&amp;quot; style=&amp;quot;width:100%; overflow:auto;&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-weight:bold;line-height:1.6;&amp;quot;&amp;gt;&amp;lt;h2 style=&amp;quot;text-decoration:none;border-style:none&amp;quot;&amp;gt;MATAP&amp;lt;/h2&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;mw-collapsible-content&amp;quot;&amp;gt;&lt;br /&gt;
=== Features ===&lt;br /&gt;
*&lt;br /&gt;
=== Bug Fixes ===&lt;br /&gt;
*&lt;br /&gt;
=== Enhancements ===&lt;br /&gt;
&amp;lt;/div&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
--&amp;gt;&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
&amp;lt;div class=&amp;quot;toccolours mw-collapsible mw-collapsed&amp;quot; style=&amp;quot;width:100%; overflow:auto;&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-weight:bold;line-height:1.6;&amp;quot;&amp;gt;&amp;lt;h2 style=&amp;quot;text-decoration:none;border-style:none&amp;quot;&amp;gt;MRO&amp;lt;/h2&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;mw-collapsible-content&amp;quot;&amp;gt;&lt;br /&gt;
=== Features ===&lt;br /&gt;
*&lt;br /&gt;
=== Bug Fixes ===&lt;br /&gt;
* &lt;br /&gt;
=== Enhancements ===&lt;br /&gt;
&amp;lt;/div&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
--&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;toccolours mw-collapsible mw-collapsed&amp;quot; style=&amp;quot;width:100%; overflow:auto;&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-weight:bold;line-height:1.6;&amp;quot;&amp;gt;&amp;lt;h2 style=&amp;quot;text-decoration:none;border-style:none&amp;quot;&amp;gt;Plugin Design&amp;lt;/h2&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div class=&amp;quot;mw-collapsible-content&amp;quot;&amp;gt;&lt;br /&gt;
=== Features ===&lt;br /&gt;
* Application, Context and View can now be configured for [[UBIK_Plugin_Design|Plugin code generation]].&lt;br /&gt;
* Scopes are now supported by the [[UBIK_Plugin_Design|PluginDesign feature set]].&lt;br /&gt;
* Queries are now supported by the [[UBIK_Plugin_Design|PluginDesign feature set]].&lt;br /&gt;
* View Items are now supported by the [[UBIK_Plugin_Design|PluginDesign feature set]].&lt;br /&gt;
=== Bug Fixes ===&lt;br /&gt;
* Several issues like the MetaProperty resolution for RelationData MetaClasses were fixed.&lt;br /&gt;
&amp;lt;!--&lt;br /&gt;
=== Enhancements ===&lt;br /&gt;
--&amp;gt;&lt;br /&gt;
&amp;lt;/div&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Release notes|Version 5.3.0 (Server)]]&lt;br /&gt;
[[Category:Server|Version 5.3.0 (Server)]]&lt;br /&gt;
[[Category:Version 5.3|Version 5.3.0 (Server)]]&lt;/div&gt;</summary>
		<author><name>NWE</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MROCLS_INTEGER_TASK</id>
		<title>MROCLS INTEGER TASK</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MROCLS_INTEGER_TASK"/>
				<updated>2026-08-24T11:29:05Z</updated>
		
		<summary type="html">&lt;p&gt;JKN: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{ClassificationInfoBox &lt;br /&gt;
| title = Integer Task classification &lt;br /&gt;
| name = {{PAGENAMEE}} &lt;br /&gt;
| inheritance = [[MROCLS_MRO_TASK]] &lt;br /&gt;
| namespace = UBIK.MRO.Classification &lt;br /&gt;
| purpose = Classify objects as Integer Tasks &lt;br /&gt;
| version = 5.2.0+ &lt;br /&gt;
| id = {2CE8E155-3E52-4C88-BE21-36F0C44484D2} &lt;br /&gt;
}} &lt;br /&gt;
&lt;br /&gt;
An [[MRO_(Plugin)#Integer_Task|Integer Task]] object is an {{UBIK}} content object which is used to document work by entering an integer value.&lt;br /&gt;
&lt;br /&gt;
== MetaProperties == &lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=50% &lt;br /&gt;
|- &lt;br /&gt;
! width=30% | Name !! width=30% | Data type !! Comment &lt;br /&gt;
|- &lt;br /&gt;
| ''VALUE'' || {{Integer}} || The integer value entered for the task &lt;br /&gt;
|- &lt;br /&gt;
|} &lt;br /&gt;
&lt;br /&gt;
== See also == &lt;br /&gt;
* [[MROCLS_MRO_TASK#Task]] (Classification) &lt;br /&gt;
* [[MROCLS_MRO_MEASUREMENT_TASK#Measurement Task]] (Classification) &lt;br /&gt;
* [[MROCLS_MRO_CHECK_TASK#Check Task]] (Classification) &lt;br /&gt;
* [[MROCLS_MRO_INSPECTION_TASK#Inspection Task]] (Classification) &lt;br /&gt;
* [[MRO_Objects_(Client)#Integer_Task]] &lt;br /&gt;
* [[MRO_(Plugin)#Integer_Task]] &lt;br /&gt;
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification) &lt;br /&gt;
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MROCLS_INTERFACE_TASK</id>
		<title>MROCLS INTERFACE TASK</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MROCLS_INTERFACE_TASK"/>
				<updated>2026-08-24T11:22:22Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{ClassificationInfoBox &lt;br /&gt;
| title = Interface Task classification &lt;br /&gt;
| name = {{PAGENAMEE}} &lt;br /&gt;
| inheritance = [[MROCLS_MRO_CHECK_TASK#Check Task]] &lt;br /&gt;
| namespace = UBIK.MRO.Classification &lt;br /&gt;
| purpose = Classify objects as Interface Tasks &lt;br /&gt;
| version = 5.2.0+ &lt;br /&gt;
| id = {C109AA2F-D37E-47F7-A5C9-FD8C4556C61D} &lt;br /&gt;
}} &lt;br /&gt;
&lt;br /&gt;
An [[MRO_(Plugin)#Interface_Task|Interface Task]] object is an {{UBIK}} content object which is used to document work using a boolean value.&lt;br /&gt;
&lt;br /&gt;
== MetaProperties == &lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=50% &lt;br /&gt;
|- &lt;br /&gt;
! width=30% | Name !! width=30% | Data type !! Comment &lt;br /&gt;
|- &lt;br /&gt;
| ''VALUE'' || {{Boolean}} || The boolean value of the task (inherited from [[MROCLS_MRO_CHECK_TASK#Check Task]]) &lt;br /&gt;
|- &lt;br /&gt;
|} &lt;br /&gt;
&lt;br /&gt;
== See also == &lt;br /&gt;
* [[MROCLS_MRO_TASK#Task]] (Classification) &lt;br /&gt;
* [[MROCLS_MRO_CHECK_TASK#Check Task]] (Classification) &lt;br /&gt;
* [[MROCLS_MRO_MEASUREMENT_TASK#Measurement Task]] (Classification) &lt;br /&gt;
* [[MROCLS_MRO_INSPECTION_TASK#Inspection Task]] (Classification) &lt;br /&gt;
* [[MRO_Objects_(Client)#Interface_Task]] &lt;br /&gt;
* [[MRO_(Plugin)#Interface_Task]] &lt;br /&gt;
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification) &lt;br /&gt;
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MROCLS_SIGNATURE_TASK</id>
		<title>MROCLS SIGNATURE TASK</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MROCLS_SIGNATURE_TASK"/>
				<updated>2026-08-18T12:47:09Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: Created page with &amp;quot;{{ClassificationInfoBox | title = Signature Task classification | name = {{PAGENAMEE}} | inheritance = MROCLS_MRO_TASK#Task | namespace = UBIK.MRO.Classification | purpose...&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{ClassificationInfoBox&lt;br /&gt;
| title = Signature Task classification&lt;br /&gt;
| name = {{PAGENAMEE}}&lt;br /&gt;
| inheritance = [[MROCLS_MRO_TASK#Task]]&lt;br /&gt;
| namespace = UBIK.MRO.Classification&lt;br /&gt;
| purpose = Classify objects as Signature Tasks&lt;br /&gt;
| version = 5.2.0+&lt;br /&gt;
| id = {37CC32F9-0113-4AF1-8A02-E21F5E7472F0}&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
A [[MRO_Objects_(Client)#Signature_Task|Signature Task]] object is an {{UBIK}} content object which is used to document work by providing a signature.&lt;br /&gt;
&lt;br /&gt;
== MetaProperties ==&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=50%&lt;br /&gt;
|-&lt;br /&gt;
! width=30% | Name !! width=30% | Data type !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| ''VALUE'' || Signature || The signature entered for the task&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
* [[MROCLS_MRO_TASK#Task]] (Classification)&lt;br /&gt;
* [[MROCLS_MRO_MEASUREMENT_TASK#Measurement Task]] (Classification)&lt;br /&gt;
* [[MROCLS_MRO_CHECK_TASK#Check Task]] (Classification)&lt;br /&gt;
* [[MROCLS_MRO_INSPECTION_TASK#Inspection Task]] (Classification)&lt;br /&gt;
* [[MRO_Objects_(Client)#Signature_Task]]&lt;br /&gt;
* [[MRO_(Plugin)#Signature_Task]]&lt;br /&gt;
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)&lt;br /&gt;
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MROCLS_TEXT_TASK</id>
		<title>MROCLS TEXT TASK</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MROCLS_TEXT_TASK"/>
				<updated>2026-08-18T12:46:44Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: Created page with &amp;quot;{{ClassificationInfoBox | title = Text Task classification | name = {{PAGENAMEE}} | inheritance = MROCLS_MRO_TASK#Task | namespace = UBIK.MRO.Classification | purpose = Cl...&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{ClassificationInfoBox&lt;br /&gt;
| title = Text Task classification&lt;br /&gt;
| name = {{PAGENAMEE}}&lt;br /&gt;
| inheritance = [[MROCLS_MRO_TASK#Task]]&lt;br /&gt;
| namespace = UBIK.MRO.Classification&lt;br /&gt;
| purpose = Classify objects as Text Tasks&lt;br /&gt;
| version = 5.2.0+&lt;br /&gt;
| id = {6042083C-54A2-434C-8318-2CFC8A2BCEE2}&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
A [[MRO_Objects_(Client)#Text_Task|Text Task]] object is an {{UBIK}} content object which is used to document work by entering text.&lt;br /&gt;
&lt;br /&gt;
== MetaProperties ==&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=50%&lt;br /&gt;
|-&lt;br /&gt;
! width=30% | Name !! width=30% | Data type !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| ''VALUE'' || {{String}} || The text entered for the task&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
&lt;br /&gt;
* [[MROCLS_MRO_TASK#Task]] (Classification)&lt;br /&gt;
* [[MROCLS_MRO_MEASUREMENT_TASK#Measurement Task]] (Classification)&lt;br /&gt;
* [[MROCLS_MRO_CHECK_TASK#Check Task]] (Classification)&lt;br /&gt;
* [[MROCLS_MRO_INSPECTION_TASK#Inspection Task]] (Classification)&lt;br /&gt;
* [[MRO_Objects_(Client)#Text_Task]]&lt;br /&gt;
* [[MRO_(Plugin)#Text_Task]]&lt;br /&gt;
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)&lt;br /&gt;
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Configure_UBIK_Credentials_Service</id>
		<title>Configure UBIK Credentials Service</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Configure_UBIK_Credentials_Service"/>
				<updated>2026-08-04T13:36:13Z</updated>
		
		<summary type="html">&lt;p&gt;MHM: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;The '''[[UBIK_Credentials_Service|UBIK Credentials Portal]]''' is an ASP.NET Core web application that provides a self-service interface for users to set their initial password and securely reset forgotten passwords. The portal communicates with the UBIK USAM WebService to perform password management operations.&lt;br /&gt;
&lt;br /&gt;
This page describes how to install, configure, and use the UBIK Credentials Portal.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;!-- DO NOT REMOVE THIS --&amp;gt;{{Template:HowTo/Begin}}&amp;lt;!-- DO NOT REMOVE THIS --&amp;gt;&lt;br /&gt;
&lt;br /&gt;
= Prerequisites =&lt;br /&gt;
&lt;br /&gt;
* Make sure the [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|USAM]] is installed on the IIS Server.&lt;br /&gt;
* Install the UBIK Credentials Portal on the IIS Server.&lt;br /&gt;
* If the IIS Server does not have it installed, download and install the .NET 8.0 Hosting Bundle from Microsoft. This bundle includes the .NET Runtime and the ASP.NET Core Runtime required for hosting ASP.NET Core applications on IIS.&lt;br /&gt;
* Make sure all published application files are accessible.&lt;br /&gt;
* Configure the application by modifying the '''appsettings.json''' file included in the published UBIK Credentials Portal package.&lt;br /&gt;
&lt;br /&gt;
= Installation =&lt;br /&gt;
&lt;br /&gt;
* Download the UBIK Credentials Portal package from the Augmensys release portal.&lt;br /&gt;
* Deploy the published UBIK Credentials Portal files to the designated website folder on the IIS Server (create the folder if necessary).&lt;br /&gt;
* IIS Manager setting check: see [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]]&lt;br /&gt;
&lt;br /&gt;
== IIS Manager ==&lt;br /&gt;
&lt;br /&gt;
* Add a new website under the '''Sites''' folder in IIS Manager.&lt;br /&gt;
** &amp;quot;Site Name&amp;quot;, &amp;quot;Application pool&amp;quot;, &amp;quot;Physical path&amp;quot;, &amp;quot;Binding&amp;quot;, &amp;quot;Host Name&amp;quot;, &amp;quot;Port&amp;quot; and &amp;quot;SSL Certificate&amp;quot;  should be adapted accordingly.&lt;br /&gt;
* ''' Example settings'''. &amp;lt;br/&amp;gt; [[Image:Credentials_IIS.png|300px]]&lt;br /&gt;
&lt;br /&gt;
{{Hint|When setting up the IIS Application Pool responsible for the Credentials Portal, the ''Load User Profile'' setting should be enabled.}}&lt;br /&gt;
&lt;br /&gt;
= Configuration =&lt;br /&gt;
&lt;br /&gt;
== Firewall settings ==&lt;br /&gt;
Firewall and Router settings must be adapted so the Credentials Portal can be accessed from outside the IIS Server.&lt;br /&gt;
&lt;br /&gt;
* Create a new inbound rule in the Windows Firewall using the same port configured in the IIS website binding.&lt;br /&gt;
* Configure port forwarding on the router using the same port if external access is required.&lt;br /&gt;
&lt;br /&gt;
== USAM Connection ==&lt;br /&gt;
&lt;br /&gt;
The Credentials Portal communicates with the UBIK USAM WebService.&lt;br /&gt;
&lt;br /&gt;
Open the '''appsettings.json''' file included in the published UBIK Credentials Portal package and configure the USAM endpoint.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;xml&amp;quot;&amp;gt;&lt;br /&gt;
&amp;quot;UsamService&amp;quot;: {&lt;br /&gt;
    &amp;quot;BaseUrl&amp;quot;: &amp;quot;https://hostname:port/PathToUsam/USAM.svc/&amp;quot;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Password Policy ==&lt;br /&gt;
&lt;br /&gt;
The Credentials Portal supports configurable password policies to enforce secure passwords.&lt;br /&gt;
&lt;br /&gt;
The following settings can be configured:&lt;br /&gt;
&lt;br /&gt;
* Minimum password length&lt;br /&gt;
* Require at least one lowercase character&lt;br /&gt;
* Require at least one uppercase character&lt;br /&gt;
* Require at least one digit&lt;br /&gt;
* Require at least one special character&lt;br /&gt;
&lt;br /&gt;
'''Example:'''&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;xml&amp;quot;&amp;gt;&lt;br /&gt;
&amp;quot;PasswordStrength&amp;quot;: {&lt;br /&gt;
    &amp;quot;MinLength&amp;quot;: 8,&lt;br /&gt;
    &amp;quot;RequireUpperCase&amp;quot;: true,&lt;br /&gt;
    &amp;quot;RequireLowerCase&amp;quot;: true,&lt;br /&gt;
    &amp;quot;RequireDigit&amp;quot;: true,&lt;br /&gt;
    &amp;quot;RequireSpecialCharacter&amp;quot;: true&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Portal Appearance ==&lt;br /&gt;
&lt;br /&gt;
The appearance of the portal can be customized.&lt;br /&gt;
&lt;br /&gt;
The following properties can be configured:&lt;br /&gt;
&lt;br /&gt;
* Portal title&lt;br /&gt;
* Background (brand) color&lt;br /&gt;
* Font color&lt;br /&gt;
* Portal icon&lt;br /&gt;
&lt;br /&gt;
'''Example:'''&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;xml&amp;quot;&amp;gt;&lt;br /&gt;
&amp;quot;PortalAppearance&amp;quot;: {&lt;br /&gt;
    &amp;quot;PortalTitle&amp;quot;: &amp;quot;Your preferred text here&amp;quot;,&lt;br /&gt;
    &amp;quot;BrandColor&amp;quot;: &amp;quot;#F16FFF&amp;quot;,&lt;br /&gt;
    &amp;quot;BrandFontColor&amp;quot;: &amp;quot;#FFFFFF&amp;quot;,&lt;br /&gt;
    &amp;quot;IconUrl&amp;quot;: &amp;quot;https://yourdomain.com/icon.png&amp;quot;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;!-- DO NOT REMOVE THIS --&amp;gt;{{Template:HowTo/End}}&amp;lt;!-- DO NOT REMOVE THIS --&amp;gt;&lt;br /&gt;
== See also ==&lt;br /&gt;
* [[HowTo:Configure_Microsoft_IIS_for_UBIK]]&lt;br /&gt;
* [[HowTo:Install_Microsoft_IIS]]&lt;br /&gt;
&lt;br /&gt;
[[Category:Install|Configure UBIK Credentials Service]]&lt;br /&gt;
[[Category:Installing|Configure UBIK Credentials Service]]&lt;br /&gt;
[[Category:Version 5.2|Configure UBIK Credentials Service]]&lt;br /&gt;
[[Category:Web service|Configure UBIK Credentials Service]]&lt;/div&gt;</summary>
		<author><name>NNE</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Version_5.3_(Mobile)</id>
		<title>Version 5.3 (Mobile)</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Version_5.3_(Mobile)"/>
				<updated>2026-07-30T08:49:46Z</updated>
		
		<summary type="html">&lt;p&gt;LGE: /* 5.3.? on 202?-??-?? */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.x. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}&lt;br /&gt;
&lt;br /&gt;
{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}&lt;br /&gt;
&lt;br /&gt;
{{Attention|The minimum supported OS versions are:&lt;br /&gt;
* Android 9;&lt;br /&gt;
* iOS 12.}}&lt;br /&gt;
&lt;br /&gt;
== Availability ==&lt;br /&gt;
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.&lt;br /&gt;
&lt;br /&gt;
{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.&lt;br /&gt;
&lt;br /&gt;
{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].&lt;br /&gt;
&lt;br /&gt;
{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].&lt;br /&gt;
&lt;br /&gt;
{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].&lt;br /&gt;
&lt;br /&gt;
{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
= Release Notes =&lt;br /&gt;
&lt;br /&gt;
== Release ==&lt;br /&gt;
&lt;br /&gt;
=== 5.3.7 on 2026-11-03 {{key press|Android: Store Preview}} ===&lt;br /&gt;
* The Client now displays task item Title and Details properties in full.&lt;br /&gt;
* Fixed an issue where documents did not load properly when switching the sync mode.&lt;br /&gt;
* The Client now displays a proper toast message when the CopyToClipboardCommand is performed.&lt;br /&gt;
* [[XAML_Tips#Default_Tab_Selection|Default tab preselection via the TabSelector]] is now enabled for the standard Mobile Client.&lt;br /&gt;
* Fixed an issue where clicking out of a Property direct editing input field didn't confirm the value.&lt;br /&gt;
* Fixed an issue where created document files are not recognized (displayed, uploaded, etc.) when their file extensions do not match the configured cases.&lt;br /&gt;
* Fixed an issue where the app sometimes redirects to the login page on certain Android devices. For example, when the device changes the dark mode setting or uses float windows.&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.3 (Mobile)]]&lt;br /&gt;
[[Category:Mobile|Version 5.3 (Mobile)]]&lt;br /&gt;
[[Category:Version 5.3|Version 5.3 (Mobile)]]&lt;br /&gt;
&lt;br /&gt;
== Known issues ==&lt;br /&gt;
* On some Android devices (Pixel 7A, iSafe 930.1 as we know), the app doesn't recognize the device cameras on the first launch after fresh installations. If this happens, please simply restart the app and it should be fine from then on.&lt;br /&gt;
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true. In Mobile, deleting the last annotation does not correctly update the editor's internal edit state. As a result, the Save button may remain visible even though no edits exist.&lt;br /&gt;
* When changing the device orientation during attaching a photo on iOS, the app gets stuck. This is an issue Microsoft confirmed in .NET9 and will fix in .NET10.&lt;br /&gt;
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.&lt;br /&gt;
* Currently, the Samsung keyboard doesn't show {{key press|,}} at all, regardless of the current language/locale setting of the device. Please use a different virtual keyboard (e.g. Gboard from Google) instead if {{key press|.}} is unacceptable.&lt;br /&gt;
* The periodic execution of background pushes is not guaranteed on iOS (the native push feature doesn't have this issue).&lt;br /&gt;
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].&lt;br /&gt;
* It is currently not possible to select which camera to use for AR views (e.g. scan page) on Windows.&lt;br /&gt;
* SfPullToRefresh was removed due to [[Mobile_XAML#Issues_with_SfPullToRefresh_in_Mobile_client|existing issues]], and replaced with a Refresh option in the Context menu.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
= ⚠️ XAML Notes =&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;headertabs /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.3 (Mobile)]]&lt;br /&gt;
[[Category:Mobile|Version 5.3 (Mobile)]]&lt;br /&gt;
[[Category:Version 5.3|Version 5.3 (Mobile)]]&lt;/div&gt;</summary>
		<author><name>CWI</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Version_5.3_(WinX)</id>
		<title>Version 5.3 (WinX)</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Version_5.3_(WinX)"/>
				<updated>2026-07-30T08:38:53Z</updated>
		
		<summary type="html">&lt;p&gt;CWI: /* 5.3.? on 202?-??-?? */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}&lt;br /&gt;
&lt;br /&gt;
== Availability ==&lt;br /&gt;
{{key press|Store}}: Publicly available in Microsoft Store.&lt;br /&gt;
&lt;br /&gt;
{{key press|Store Beta}} / {{key press|Store Preview}}: Publicly available in Microsoft Store as beta or preview versions to those whose account email is participating in our beta or preview test. To join, please send an email to testing@augmensys.com and provide an email address to add to the list as well as the information which test you want to join. Alternatively you can contact the Augmensys staff and submit your chosen email address.&lt;br /&gt;
&lt;br /&gt;
Example: Please add my email account example@example.com to the '''Beta''' test group for the '''WinX''' client.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with ⚠️}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
= Release Notes =&lt;br /&gt;
&lt;br /&gt;
== Release ==&lt;br /&gt;
&lt;br /&gt;
=== 5.3.? on 202?-??-?? ===&lt;br /&gt;
* Fixed an issue where documents did not load properly when switching the sync mode.&lt;br /&gt;
* The Client now displays a proper toast message when the CopyToClipboardCommand is performed.&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.3 (WinX)]]&lt;br /&gt;
[[Category:Version 5.3|Version 5.3 (WinX)]]&lt;br /&gt;
[[Category:WinX|Version 5.3 (WinX)]]&lt;br /&gt;
&lt;br /&gt;
== Known issues ==&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
= ⚠️ XAML Notes =&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;headertabs /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{{Category/Version2|{{PAGENAME}}}}&lt;br /&gt;
&lt;br /&gt;
[[Category:Version 5.3|Version 5.3 (WinX)]]&lt;br /&gt;
[[Category:Client|Version 5.3 (WinX)]]&lt;br /&gt;
[[Category:WinX|Version 5.3 (WinX)]]&lt;/div&gt;</summary>
		<author><name>CWI</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=OIDC_CLS_OFFLINE_SSO</id>
		<title>OIDC CLS OFFLINE SSO</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=OIDC_CLS_OFFLINE_SSO"/>
				<updated>2026-07-20T13:02:15Z</updated>
		
		<summary type="html">&lt;p&gt;MHM: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{ClassificationInfoBox&lt;br /&gt;
| title = Login&lt;br /&gt;
| name = {{PAGENAMEE}}&lt;br /&gt;
| inheritance = [[SYSCLS_LOGIN]]&lt;br /&gt;
| namespace = UBIK.Kernel.SSO&lt;br /&gt;
| purpose = Classify an object as login providing offline SSO information&lt;br /&gt;
| version = 5.2+&lt;br /&gt;
| id = {320D80BD-90D5-428E-972E-43489D5273EA}&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
OIDC_CLS_OFFLINE_SSO classifies objects as login objects providing extra information for offline - SSO - login.&lt;br /&gt;
OIDC_CLS_OFFLINE_SSO is an autonomous classification providing 2 autonomous properties.&lt;br /&gt;
&lt;br /&gt;
Suggestion: add OIDC_CLS_OFFLINE_SSO to the Login - Metaclass scope which adds the 2 autonomous properties to the ACM.&lt;br /&gt;
&lt;br /&gt;
OIDC_CLS_OFFLINE_SSO is provided via UBIK.SSO.OIDCProcessor - Plugin.&lt;br /&gt;
&lt;br /&gt;
== MetaProperties ==&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; width=50%&lt;br /&gt;
|-&lt;br /&gt;
! width=30% | Name !! width=30% | Data type !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| LOGINNAME || {{Text}} || Login name&lt;br /&gt;
|-&lt;br /&gt;
| IS_OFFLINE_SSO_ENABLE || {{Boolean}} || Configures whether offline SSO login should be enabled. This proeprty is autonomously added to the ACM Scope.&lt;br /&gt;
|-&lt;br /&gt;
| OFFLINE_VALIDITY_IN_DAY || {{Double}} || configures how long (in days) offline SSO Login (if enabled) should be possible.This proeprty is autonomously added to the ACM Scope.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
* [[SYSCLS_LOGIN]]&lt;/div&gt;</summary>
		<author><name>MHM</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=UBIK_Studio_Manual</id>
		<title>UBIK Studio Manual</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=UBIK_Studio_Manual"/>
				<updated>2026-07-13T09:41:00Z</updated>
		
		<summary type="html">&lt;p&gt;KPO: /* 8. Scopes and display in the Client */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;==1. Connect to a Database==&lt;br /&gt;
The Options dialog can be opened via the icon located in the top-left toolbar, directly below the main menu bar.&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:Manual2.png|thumb|none|left|300px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;float:left; margin: 0 20px 15px 0;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:Manual.png|thumb|none|400px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
Click Apply and OK. It is also possible to run UBIK Studio using &amp;quot;WindowsAuthentication&amp;quot;. To do this, the option in the &amp;quot;WindowsAuthentication&amp;quot; column must be set to &amp;quot;true&amp;quot; (in which case the username and password fields do not need to be filled in).&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Important:&lt;br /&gt;
* Database&lt;br /&gt;
* Datasource&lt;br /&gt;
* Password&lt;br /&gt;
* User&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==2. Create Metaclasses and Properties==&lt;br /&gt;
MetaClasses define new object types within the UBIK® data model, while [[MetaProperty|MetaProperties]] define the corresponding attributes of these object types. Creating Custom [[MetaClass|MetaClasses]] and [[MetaProperty|MetaProperties]] is what allows the data model to be extended beyond the standard objects to meet customer-specific requirements.&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
To create a new metaclass, right-click on &amp;quot;NAMEDBASECLASS&amp;quot; &amp;gt; &amp;quot;Derive new object&amp;quot;.&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-bottom: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:Metaclass1.png|thumb|none|280px|link=]]&lt;br /&gt;
| style=&amp;quot;width:20px;&amp;quot; |&lt;br /&gt;
| [[File:Metaclass2.png|thumb|none|280px|link=]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;float:left; margin: 0 20px 15px 0;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:Metaclass3.png|thumb|none|220px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
When the newly created metaclass is opened in an [[Object_Editor|ObjectEditor]], the properties of the Metaclass can be edited. The Name and Description are mandatory fields, and it is recommended to write the name in uppercase letters. The Namespace is optional, and there is also a checkbox for selecting multilanguage. To save the changes, first click in a new line and then select the floppy disk icon.&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-bottom: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:Metaclass5.png|thumb|none|550px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
To add properties to a metaclass, CUSTOMMETAPROPERTIES are required. To access the CUSTOMMETAPROPERTY, switch to the Content view in the ClassBrowser. Then, drag Custom -&amp;gt; Main -&amp;gt; Base -&amp;gt; CUSTOMMETAPROPERTY into the BulkEditor. When creating a new property, first specify the name and description. Next, define the namespace and the data type.&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-bottom: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:Metaclass4.png|thumb|none|550px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
To add the newly created Properties to a Metaclass, drag the corresponding Metaclass into the [[Class_Details|ClassDetails Editor]]. Then, drag the desired Properties from CUSTOMMETAPROPERTY into the Metaclass.&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==3. Creating SelectiveList and SelectiveItem==&lt;br /&gt;
A [[SELECTIVELIST|SelectiveList]] provides a predefined list of selectable values that users can choose from instead of entering free text. Each individual entry in this list is represented as a [[SELECTIVEITEM|SelectiveItem]].&lt;br /&gt;
To add a list to a property, you must first switch to the Content View. Then, select Custom &amp;gt; List &amp;gt; SELECTIVELIST and drag it into a Bulk Editor (to access the Content View, switch to the &amp;quot;Content View&amp;quot; in the [[Class_Browser|Class Browser]] – see screenshot). When creating the list, use the same data type as that of the corresponding Metaproperty.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SLL2.png|thumb|none|left|400px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 15px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SLL1.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&lt;br /&gt;
To create SelectiveItems, navigate to Custom &amp;gt; List &amp;gt; SELECTIVEITEM and drag SELECTIVEITEM into a [[Bulk_Editor|BulkEditor]].&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 0px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SLL4.png|thumb|none|left|400px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 15px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SLL3.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
To add SelectiveItems to a list, the previously created list must be opened in a [[Relation_Editor|RelationEditor]]. To do this, for example, drag Custom-&amp;gt;List-&amp;gt;SELECTIVELIST-&amp;gt;Custom-&amp;gt;ANLEITUNG into the RelationEditor. Then, drag the SelectiveItems from the [[Bulk_Editor|BulkEditor]] into the corresponding list.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SLL5.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
To add the list to the property, select the previously created list in the SELECTIVELIST column of CUSTOMMETAPROPERTY.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SLL6.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==4. Create References and Links==&lt;br /&gt;
References define which object types a connection (link) may point to, while links, implemented as a property of type Guid, actually establish this connection between two instances. Both elements are required to model directed relationships between objects within the UBIK® data model, e.g. to point from one object to another without needing a fixed parent-child structure.&lt;br /&gt;
To create a Reference, navigate to Custom-&amp;gt;Reference and drag Custom-&amp;gt;Reference-&amp;gt;REFERENCE into the BulkEditor (to access the content view, you must switch to the content area in the ClassBrowser). Then, specify the Name, Description, Namespace, and TargetType. When creating a new reference—for example, REF_ANLEITUNG—the corresponding metaclass ANLEITUNG must be set as the TargetType.&lt;br /&gt;
[[File:createReferencesAndLinks1.png|thumb|400px|left]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
To create link Properties, drag CUSTOMMETAPROPERTY into a [[Bulk_Editor|BulkEditor]]. Select &amp;quot;Guid&amp;quot; as the data type. Then, assign the previously created Reference—for example, REF_ANLEITUNG to the Reference field.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:REF3.png|none|left|thumb|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
The Metaclass referenced by the link Property must be dragged into a ClassDetails editor. Subsequently, the link Property is assigned to the corresponding metaclass under MetaProperties.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:REF4.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==5. [[HowTo:Create_a_new_View|Create View]]==&lt;br /&gt;
A View defines a hierarchical display of objects, where the associated [[VIEWITEMS|ViewItems]] determine how hierarchy levels are built starting from the View`s root objects.&lt;br /&gt;
To create [[HowTo:Create_a_new_ReferenceViewItem_automatically|ReferenceViewItems]], drag Custom-&amp;gt;View-&amp;gt;REFERENCEVIEWITEM into a BulkEditor (To access the Content-View, switch to the Content area in the ClassBrowser).&lt;br /&gt;
&amp;lt;div style=&amp;quot;float:left; margin: 0 20px 15px 0;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:VI1.png|thumb|none|270px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
Create a new instance of a ReferenceViewItem using the Bulk Editor. Specify the Name of the Reference Property in the &amp;quot;Reference&amp;quot; cell. Select the &amp;quot;Reverse&amp;quot; checkbox if the ReferenceViewItem is to be evaluated in reverse (right-to-left) order. Assign a query instance of the ReferenceViewItem to the &amp;quot;Reversereftype&amp;quot; attribute—either by dragging and dropping a metaclass object onto the cell or by selecting the desired metaclass from the dialog box that appears when you double-click the field. &amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt; [[File:ReferenceViewItemBulkEditor.png|thumb|none|right|700px|link=]]&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
To add the ReferenceViewItem to the view, open the corresponding view in the RelationEditor: Custom -&amp;gt; View -&amp;gt; VIEW -&amp;gt; CUSTOM -&amp;gt; CUSTOM -&amp;gt; TEMPLATE -&amp;gt; VIE_01. The ReferenceViewItem can then be assigned to the view.&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:createViewRelationEditor.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
To correctly display data in hierarchical structures such as trees or nested lists, a view must retrieve the root objects (root elements) of the first level. This ensures that the view has the entry point for navigation and that child elements are referenced correctly. To create a RootObject, the MetaClass must be dragged into the BulkEditor. Then, an object can be created. This object must then be dragged onto the MetaClass in the Relation Editor.&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 10px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:VI4.png|thumb|none|left|700px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==6. Rebuild==&lt;br /&gt;
A Rebuild ccompiles the modified customizing (MetaClasses, MetaProperties and associated custom code) into a new assembly, so that the changes made take effect in UBIK Studio and on the UBIK server.&lt;br /&gt;
To rebuild the customization, a rebuild process must be performed first. A rebuild recompiles all components of the UBIK data model, generates the required .NET assemblies and database objects, and ensures that all changes are applied consistently.&lt;br /&gt;
&lt;br /&gt;
Once the rebuild is complete, first click the left icon (Syntax Check) and then the right icon (Compile and Release).&lt;br /&gt;
&lt;br /&gt;
The program then restarts automatically.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 25px;&amp;quot;&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:RB1.png|thumb|none|330px|link=]]&lt;br /&gt;
| style=&amp;quot;width:30px;&amp;quot; |&lt;br /&gt;
| [[File:RB2.png|thumb|none|330px|link=]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==7. [[View_Test_Environment|View Test Environment]]==&lt;br /&gt;
The View Test Environment allows a configured View to be tested directly in UBIK Studio, to verify that the defined root objects and ViewItems build the desired hierarchy correctly before the View is used in production. &lt;br /&gt;
To test the Customizing, select the &amp;quot;View Test Environment&amp;quot; option from the Tools menu.&lt;br /&gt;
&lt;br /&gt;
A window opens where the desired view can be selected from the drop-down menu. The root object should then be visible. A new object can be created by right-clicking on the object, though the triangle next to the name must be expanded first.&lt;br /&gt;
&lt;br /&gt;
The Properties can be edited in the newly opened window.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 25px;&amp;quot;&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:VTE1.png|thumb|none|330px|link=]]&lt;br /&gt;
| style=&amp;quot;width:30px;&amp;quot; |&lt;br /&gt;
| [[File:VTE2.png|thumb|none|330px|link=]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==8. Scopes and display in the Client==&lt;br /&gt;
Scopes define which MetaClasses, Properties, and queries are published to the mobile UBIK® Client, thereby determining which objects and information are actually displayed to the user there.&lt;br /&gt;
&lt;br /&gt;
To display the content in the client, navigate to Custom -&amp;gt; ACM -&amp;gt; CONTEXT -&amp;gt; CUSTOM -&amp;gt; CUSTOM TEMPLATE. The context can then be inspected (to access the Content view, switch to the Content section in the Class Browser). UBIK Studio provides an automatism that assists in [[HowTo:Create_a_new_MetaClassScope|creating MetaClassScopes]]: to use it, drag the desired MetaClass onto the Context. After dropping it, a small window appears with the option &amp;quot;Add fitting Scope to Context&amp;quot;, which should be selected.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;text-align:left;margin-top: 10px; margin-bottom: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SC1.png|thumb|none|left|650px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Afterwards, the MetaClassScope – Configuration dialog opens. Here, properties such as Visibility and Lock Status can be configured. Once the configuration is complete, confirm the changes by clicking OK. The created MetaClassScope can be viewed under Custom → ACM → Scopes → METACLASSSCOPES.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;text-align:left;margin-top: 10px; margin-bottom: 25px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SC2.png|thumb|none|left|600px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
To make the object creatable later on, the Default Context is dragged into the Relation Editor. There, the ContextScope is expanded via the plus icon, and the MetaClassScope is selected. This opens another window in which the &amp;quot;Creation enabled&amp;quot; option can be activated.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;text-align:left;margin-top: 10px; margin-bottom: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SC3.png|thumb|none|left|550px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All objects/classes/tasks/etc. that should later be visible in the client must be contained within the Context.&lt;br /&gt;
To edit the visibility of individual properties within the Scopes, the Default Context is required in the Relation Editor. There, the ContextScope is expanded, then the plus icon next to the desired MetaClassScope is opened to reveal the MetaProperties. Selecting a property opens a new window in which the visibility, lock status, priority, and sort order can be configured.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;text-align:left;margin-top: 10px; margin-bottom: 20px;&amp;quot;&amp;gt;&lt;br /&gt;
[[File:SC4.png|thumb|none|left|550px|link=]]&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==9. Release Metadefinitions==&lt;br /&gt;
Only after releasing the Metadefinitions are changes to the Metamodel — such as newly created MetaClasses, MetaProperties, or Scopes — published from Sandbox mode and thereby actually made available to the client and other Studio instances.&lt;br /&gt;
&lt;br /&gt;
Select Tools from the menu bar and then open the [[ACM_Manager|ACM Manager]].&lt;br /&gt;
&lt;br /&gt;
After opening the dialog window, two context areas are displayed: &amp;quot;Context objects&amp;quot; and &amp;quot;Custom Context objects.&amp;quot; Only the &amp;quot;Custom Context objects&amp;quot; area is relevant for the subsequent steps. Expand the &amp;quot;Custom Context objects&amp;quot; area until the desired context is visible, and select it with a single mouse click. Then, perform the following actions in the toolbar in the order specified: Evaluate Temporary Meta Definitions -&amp;gt; Clear Released Meta Definitions (this icon appears only after the context has been successfully rebuilt at least once) -&amp;gt; Release Meta Definitions. Ensure that the actions are performed sequentially and in the specified order.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;margin-top: 25px;&amp;quot;&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:MDR1.png|none|330px|thumb|link=]]&lt;br /&gt;
| style=&amp;quot;width:30px;&amp;quot; |&lt;br /&gt;
| [[File:MDR2.png|none|330px|thumb|link=]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==10. Create User==&lt;br /&gt;
Custom-&amp;gt;Main-&amp;gt;User-&amp;gt;LOGIN is dragged into a BulkEditor. Subsequently, the Name and Description can be specified, with the LoginName being populated automatically once the name has been entered.&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:USER1.png|thumb|none|330px]]&lt;br /&gt;
| [[File:USER2.png|thumb|none|900px]]&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==11. Create Workpackages and Tasks==&lt;br /&gt;
Workpackages and Tasks are the MRO (Maintenance, Repair and Operations) objects used to structure work to be carried out: a Workpackage groups the individual Tasks through which users report progress, results, and completion of work in the UBIK® client.&lt;br /&gt;
&lt;br /&gt;
Navigate the hierarchy to &amp;quot;WORKPACKAGES MRO workpackages.&amp;quot; Right-click this item and select &amp;quot;Derive new Object&amp;quot; to create a new Metaclass for a new type of Workpackage. The Workpackage Name can subsequently be adjusted in the ObjectEditor. The Name should be entered in uppercase letters; the Description field can be filled in as desired, and there is also an option to enable multilingual support.&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:WorkPackage1.png|thumb|none|220px]]&lt;br /&gt;
| style=&amp;quot;width:20px;&amp;quot; |&lt;br /&gt;
| [[File:createWorkpackagesAndTasks.png|thumb|none|300px]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;br&amp;gt;&lt;br /&gt;
To create a new task, use &amp;quot;TASK MRO tasks.&amp;quot; Again, right-click and select &amp;quot;Derive new object&amp;quot; to create the metaclass. The task type is determined by the data type; for example, a Texttask requires an additional value Property of type &amp;quot;string,&amp;quot; whereas a check task requires a value Property of type &amp;quot;bool.&amp;quot; This value Property is then dragged from the CUSTOMMETAPROPERTIES onto the Metaclass opened in the RelationEditor.&lt;br /&gt;
[[File:WP2.png|thumb|none|500px]]&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
By deriving from the TASK MRO task, the task inherits the classification of the parent object. This classification determines the type assigned to the newly created task. You can view the required Property in the Class Details; to do this, select the cube icon at the top. Then, open the &amp;quot;Task Classification Object&amp;quot;; color-coded markers (red and green) will indicate whether specific Properties still need to be added.&lt;br /&gt;
&amp;lt;br style=&amp;quot;clear:both&amp;quot; /&amp;gt;&lt;br /&gt;
{| style=&amp;quot;margin-left: 0;&amp;quot;&lt;br /&gt;
| [[File:WP3.png|thumb|none|330px]]&lt;br /&gt;
| [[File:WP4.png|thumb|none|330px]]&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;br /&gt;
&lt;br /&gt;
==12. Editors==&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Editor !! Description&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Class_Browser|Class Browser]]''' || Navigate through metaclasses and instances; create and delete them.&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Class_Details|Class Details]]''' || Configure metaclass details; add or remove metaproperties and classifications.&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Bulk_Editor|Bulk Editor]]''' || Create and edit multiple instances of a metaclass in a tabular format.&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Code_Editor|Code Editor]]''' || Add small code snippets to any metaclass. For example: automatically generate a name based on today's date and the company name when a new batch is created.&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Relation_Editor|Relation Editor]]''' || Link objects and edit relational data.&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Object_Explorer|Object Explorer]]''' || View and edit all visible object properties (list view).&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Object_Editor|Object Editor]]''' || Edit the property values of a single object.&lt;br /&gt;
|-&lt;br /&gt;
| '''[[Workflow_Editor|Workflow Editor]]''' || View, design, and execute custom workflows.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
[[Category:Pages with broken file links|UBIK Studio Manual]]&lt;/div&gt;</summary>
		<author><name>KPO</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Intelligent_Atelier_(Plugin)</id>
		<title>Intelligent Atelier (Plugin)</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Intelligent_Atelier_(Plugin)"/>
				<updated>2026-07-03T13:10:10Z</updated>
		
		<summary type="html">&lt;p&gt;NWE: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;The {{UBIK}} Intelligent Atelier Plugin provides a user interface for interactive agentic AI modelling in {{UBIK}} Studio.&lt;br /&gt;
&lt;br /&gt;
== Overview ==&lt;br /&gt;
The Intelligent Atelier can be used to develop part of a {{UBIK}} customizing, debug errors or to find answers to {{UBIK}}-specific questions.&lt;br /&gt;
In the To-Do List, one can always see what is being planned and done. The artefacts view lists all currently relevant objects, ready for drag &amp;amp; drop to other {{UBIK}} Studio controls.&lt;br /&gt;
[[File:intelligent-atelier-control.png|thumb|right|350px|Intelligent Atelier as a tab control]]&lt;br /&gt;
&lt;br /&gt;
== Prerequisites ==&lt;br /&gt;
The Intelligent Atelier is a {{UBIK}} Plugin for {{UBIK}} Studio{{Version/ServerSince|5.2.0}}. &lt;br /&gt;
=== Installation ===&lt;br /&gt;
Install the plugin with the name &amp;quot;UBIK.Module.IntelligentAtelier&amp;quot; using [[Injection_Management|UBIK Plugin Injection]].&lt;br /&gt;
=== Configuration ===&lt;br /&gt;
For the feature to work, an AI model is required. Access to this service must be provided by the administrator.&lt;br /&gt;
In {{UBIK}} Studio's database connection settings, configure values for the following keys:&lt;br /&gt;
* &amp;lt;b&amp;gt;AI REST API URL&amp;lt;/b&amp;gt;: Azure AI Foundry deployment URL&lt;br /&gt;
* &amp;lt;b&amp;gt;AI REST API Key&amp;lt;/b&amp;gt;: Azure AI Foundry deployment Key&lt;br /&gt;
* &amp;lt;b&amp;gt;AI REST API Model&amp;lt;/b&amp;gt;: The name of the deployed model&lt;br /&gt;
When this article was created, the supported models are GPT-4.1 and GPT-5.4, presumably including any version in between.&lt;br /&gt;
Further, only the Azure OpenAI chat completion REST API is supported.&lt;br /&gt;
[[File:ai-api-settings.png|thumb|right|350px|UBIK Studio connection settings for the AI REST API]]&lt;br /&gt;
=== Accessibility ===&lt;br /&gt;
The Intelligent Atelier can be opened either as a Window or as a Tab Control. Use the &amp;quot;Magic Wand&amp;quot; toolbar menu icon or the &amp;quot;Intelligent Atelier&amp;quot; View-menu entry to open it in a window, or right-click the tab header in the main working area to open the Intelligent Atelier as a tab control, using the respective context menu entry. &lt;br /&gt;
[[File:intelligent-atelier-icon.png|thumb|right|350px|Opening the Intelligent Atelier as a window via toolbar button]]&lt;br /&gt;
[[File:intelligent-atelier-tab.png|thumb|right|350px|Opening the Intelligent Atelier as a tab control via tab header context menu]]&lt;br /&gt;
&lt;br /&gt;
== Usage ==&lt;br /&gt;
[[File:intelligent-atelier-control-areas.png|thumb|right|350px|Intelligent Atelier control areas]]&lt;br /&gt;
[[File:intelligent-atelier-example.png|thumb|right|350px|The Intelligent Atelier processing an example...]]&lt;br /&gt;
[[File:intelligent-atelier-example-result.png|thumb|right|350px|...and showing the result.]]&lt;br /&gt;
=== Paradigm ===&lt;br /&gt;
The general usage workflow is to enter and send a request, upon which the Intelligent Atelier creates a plan and works it off, providing the results.&lt;br /&gt;
Complex requests usually require a dialog to refine the results iteratively.&lt;br /&gt;
=== Use-cases ===&lt;br /&gt;
The Intelligent Atelier supports the following use-cases:&lt;br /&gt;
* &amp;lt;b&amp;gt;Support&amp;lt;/b&amp;gt;: Answer a {{UBIK}}-related question&lt;br /&gt;
* &amp;lt;b&amp;gt;Concept&amp;lt;/b&amp;gt;: Provide a functional or technical customizing concept&lt;br /&gt;
* &amp;lt;b&amp;gt;Debugging&amp;lt;/b&amp;gt;: Find a configuration error&lt;br /&gt;
* &amp;lt;b&amp;gt;Bugfixing&amp;lt;/b&amp;gt;: Fix a misconfiguration&lt;br /&gt;
* &amp;lt;b&amp;gt;Prototyping&amp;lt;/b&amp;gt;: Implement requirements&lt;br /&gt;
=== Request ===&lt;br /&gt;
In the &amp;quot;Request&amp;quot; field (1.), the user can enter any prompt corresponding to a use-case listed above, and start processing using the Play-button. &lt;br /&gt;
=== Response ===&lt;br /&gt;
Once the Intelligent Atelier has come to a conclusion, it will output an answer in the &amp;quot;Response&amp;quot; field (2.).&lt;br /&gt;
This can take a while, because there is a lot of expert knowledge to process for the Atelier.&lt;br /&gt;
Further, similarly to an interaction with a coworker, complex requests usually require a dialog, with the user reviewing the (intermediate) results and providing follow-up instructions.&lt;br /&gt;
=== To-Do List ===&lt;br /&gt;
For most non-trivial use-cases, the Intelligent Atelier establishes a plan in the form of a To-Do List (3.). Hover the items to inspect its notes in a tool-tip!&lt;br /&gt;
=== Artefacts ===&lt;br /&gt;
All relevant objects accessed, created or edited by the Intelligent Atelier are listed in the Artefacts area (4.). These items can be dragged and dropped to most other {{UBIK}} Studio controls, including tab controls like the Bulk Editor, Relation Editor or Object Explorer.&lt;br /&gt;
=== Tips and tricks ===&lt;br /&gt;
* Create a backup of the database before starting an Atelier session.&lt;br /&gt;
* To restart a session completely, close the Intelligent Atelier control or window and open a new one.&lt;br /&gt;
* The quality of the results depends, amongst other factors, on the quality of the request. The clearer and more precise a prompt is, the easier it is to process.&lt;br /&gt;
* Ambiguity or even contradiction are some of the most difficult obstacles for the Intelligent Atelier; the results are rarely satisfactory for requests with these properties.&lt;br /&gt;
* Sometimes, the modelling gets off on the wrong foot. When things just don't work out, often it's best to restart with a new session.&lt;br /&gt;
* Sessions are not persisted and cease to exist when closing the Atelier view. The configured REST API may or may not persist details about the interaction, this depends on the configured service.&lt;br /&gt;
&lt;br /&gt;
== Supported scope ==&lt;br /&gt;
When this article was created, the Intelligent Atelier had an understanding of the following concepts:&lt;br /&gt;
* Basic ER-models with MetaClasses, MetaProperties, References, Relations&lt;br /&gt;
* Basic View Items (Relation, Reference, including the reverse cases)&lt;br /&gt;
* MetaClass Scopes &lt;br /&gt;
* Basic View configuration including explicit root objects&lt;br /&gt;
* Not yet supported: Queries, Proxies, Plugin content like MRO, etc.&lt;br /&gt;
== Technical background ==&lt;br /&gt;
The Intelligent Atelier uses an agentic loop with a mixture-of-experts architecture on application level. An Azure OpenAI chat completions REST API is accessed in combination with a rich set of functions for tool-calls and elaborate system instructions to enable both a deep understanding of {{UBIK}} and an algorithm for processing complex requirements.  &lt;br /&gt;
== See also ==&lt;br /&gt;
*[[Injection_Management|UBIK Plugin Injection]]&lt;br /&gt;
&lt;br /&gt;
[[Category:AI|Intelligent Atelier (Plugin)]]&lt;br /&gt;
[[Category:Injecting|Intelligent Atelier (Plugin)]]&lt;br /&gt;
[[Category:Plugin|Intelligent Atelier (Plugin)]]&lt;br /&gt;
[[Category:Studio|Intelligent Atelier (Plugin)]]&lt;br /&gt;
[[Category:Version 5.2|Intelligent Atelier (Plugin)]]&lt;/div&gt;</summary>
		<author><name>AMI</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Version_5.2_(WinX)</id>
		<title>Version 5.2 (WinX)</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Version_5.2_(WinX)"/>
				<updated>2026-06-30T14:09:45Z</updated>
		
		<summary type="html">&lt;p&gt;CWI: /* Release */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}&lt;br /&gt;
&lt;br /&gt;
== Availability ==&lt;br /&gt;
{{key press|Store}}: Publicly available in Microsoft Store.&lt;br /&gt;
&lt;br /&gt;
{{key press|Store Beta}} / {{key press|Store Preview}}: Publicly available in Microsoft Store as beta or preview versions to those whose account email is participating in our beta or preview test. To join, please send an email to testing@augmensys.com and provide an email address to add to the list as well as the information which test you want to join. Alternatively you can contact the Augmensys staff and submit your chosen email address.&lt;br /&gt;
&lt;br /&gt;
Example: Please add my email account example@example.com to the '''Beta''' test group for the '''WinX''' client.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with ⚠️}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
= Release Notes =&lt;br /&gt;
&lt;br /&gt;
== Release ==&lt;br /&gt;
&lt;br /&gt;
=== 5.2.? on 2026-??-?? ===&lt;br /&gt;
&lt;br /&gt;
=== 5.2.9 on 2026-11-11 ===&lt;br /&gt;
* Fixed an issue where decimal values could not always be entered properly.&lt;br /&gt;
&lt;br /&gt;
=== 5.2.8 on 2026-10-06 ===&lt;br /&gt;
* Fixed an issue where text entered into input fields would repeatedly disappear when using direct editing.&lt;br /&gt;
&lt;br /&gt;
=== 5.2.7 on 2026-10-05 {{key press|Store}} ===&lt;br /&gt;
* The [[MROCLS_TEXT_TASK|TextTaskClassification]] and [[MROCLS_SIGNATURE_TASK|SignatureTaskClassification]] have now a proper UID.&lt;br /&gt;
* Added [[MROCLS_INTEGER_TASK|IntegerTaskClassification]] and [[MROCLS_INTERFACE_TASK|InterfaceTaskClassification]].&lt;br /&gt;
* Fixed an issue where numbers couldn't be entered correctly.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== 5.2.5 on 2026-09-02 {{key press|Store}} ===&lt;br /&gt;
* Fixed the broken string property editing.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== 5.2.4 on 2026-09-01 {{key press|Store}} ===&lt;br /&gt;
* Fixed an issue where clients displayed extremely large or small values using scientific notation.&lt;br /&gt;
* Fixed an issue where, after saving a file with an external editor, you had to refocus UBIK twice before it was automatically committed.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== 5.2.3 on 2026-08-04 {{key press|Store}} ===&lt;br /&gt;
* Fixed a bug that prevented file access within the Pictures/Edit folder, which could cause failures of uploading edited files.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== 5.2.2 on 2026-07-21 {{key press|Store Beta}} ===&lt;br /&gt;
* Added support for [[Login_View#Offline_SSO_Login|Offline SSO Login]], allowing users to securely access the UBIK Client in offline mode after a successful online SSO authentication.&lt;br /&gt;
* Resolved an issue where page transitions can be annoying/distracting.&lt;br /&gt;
* UBIK LABs (Experimental) The update interval for live value updates (LiveValueUpdateIntervalMs) can be configured in profiles.&lt;br /&gt;
* Updated all client localization translations.&lt;br /&gt;
* Fixed an issue where Developer Mode failed to display certain property descriptions.&lt;br /&gt;
* Updated misleading text resources on dialogues to delete an object on the server and to locally discard an object.&lt;br /&gt;
* Fixed an issue where DocumentViewModel.ShowDocumentCommand did not work when combined with InvokeCommandAction.&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.2 (WinX)]]&lt;br /&gt;
[[Category:Version 5.2|Version 5.2 (WinX)]]&lt;br /&gt;
[[Category:WinX|Version 5.2 (WinX)]]&lt;br /&gt;
&lt;br /&gt;
== Known issues ==&lt;br /&gt;
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true.&lt;br /&gt;
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.&lt;br /&gt;
* Free Text Annotations that where created in former sessions cannot be selected and therefore cannot be edited any more.&lt;br /&gt;
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].&lt;br /&gt;
* Known issues regarding the [[Documents_(Client)#Remember_Document_Settings|Remember Document Settings]] feature:&lt;br /&gt;
** Saving the Zoom value via touch gestures is not supported.&lt;br /&gt;
** Due to a third-party framework issue it can't be guaranteed that saving the Zoom level is always working properly. We reported this issue and will update our solution as soon as it is resolved on their side.&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
= ⚠️ XAML Notes =&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;headertabs /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{{Category/Version2|{{PAGENAME}}}}&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.2 (WinX)]]&lt;br /&gt;
[[Category:Version 5.2|Version 5.2 (WinX)]]&lt;br /&gt;
[[Category:WinX|Version 5.2 (WinX)]]&lt;/div&gt;</summary>
		<author><name>LGE</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=Version_5.2_(Mobile)</id>
		<title>Version 5.2 (Mobile)</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=Version_5.2_(Mobile)"/>
				<updated>2026-06-30T14:09:37Z</updated>
		
		<summary type="html">&lt;p&gt;ARU: /* 5.2.? on 2026-??-?? */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.x. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}&lt;br /&gt;
&lt;br /&gt;
{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}&lt;br /&gt;
&lt;br /&gt;
{{Attention|The minimum supported OS versions are:&lt;br /&gt;
* Android 9;&lt;br /&gt;
* iOS 12.}}&lt;br /&gt;
&lt;br /&gt;
== Availability ==&lt;br /&gt;
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.&lt;br /&gt;
&lt;br /&gt;
{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.&lt;br /&gt;
&lt;br /&gt;
{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].&lt;br /&gt;
&lt;br /&gt;
{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].&lt;br /&gt;
&lt;br /&gt;
{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].&lt;br /&gt;
&lt;br /&gt;
{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].&lt;br /&gt;
&amp;lt;br/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
= Release Notes =&lt;br /&gt;
&lt;br /&gt;
== Release ==&lt;br /&gt;
&lt;br /&gt;
=== 5.2.? on 2026-??-?? ===&lt;br /&gt;
* The [[MROCLS_TEXT_TASK|TextTaskClassification]] and [[MROCLS_SIGNATURE_TASK|SignatureTaskClassification]] have now a proper UID.&lt;br /&gt;
* Added [[MROCLS_INTEGER_TASK|IntegerTaskClassification]] and [[MROCLS_INTERFACE_TASK|InterfaceTaskClassification]].&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.2 (Mobile)]]&lt;br /&gt;
[[Category:Mobile|Version 5.2 (Mobile)]]&lt;br /&gt;
[[Category:Version 5.2|Version 5.2 (Mobile)]]&lt;br /&gt;
&lt;br /&gt;
=== 5.2.5 on 2026-09-01 {{key press|Android: Store}} 5.2.10 on 2026-09-09 {{key press|iOS: Store}} ===&lt;br /&gt;
* {{UBIK}} now supports credentials containing accented (and other special) characters, enabling users to authenticate successfully with a wider range of credential formats. (This must be paired with the [[Version_5.2.0_(Server)|5.2 service version]].)&lt;br /&gt;
* Fixed an issue where clients displayed extremely large or small values using scientific notation.&lt;br /&gt;
* Fixed an issue where POIs for scanned 2D codes are not stable and jump a lot.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== 5.2.3 on 2026-08-04 {{key press|Android: Store}}{{key press|iOS: Store}} ===&lt;br /&gt;
* Fixed an issue where documents did not reload properly.&lt;br /&gt;
* Fixed an issue where it was not possible to toggle the text input scanner from within the string edit dialog, and added [[Editors#String_value_editor|a button]] to do so to the default UI.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== 5.2.2 on 2026-07-21 {{key press|Android: Store Beta}}{{key press|iOS: Store Beta}} ===&lt;br /&gt;
* Added support for [[Login_View#Offline_SSO_Login|Offline SSO Login]], allowing users to securely access the UBIK Client in offline mode after a successful online SSO authentication.&lt;br /&gt;
* UBIK LABs (Experimental) The update interval for live value updates (LiveValueUpdateIntervalMs) can be configured in profiles.&lt;br /&gt;
* Updated all client localization translations.&lt;br /&gt;
* Updated misleading text resources on dialogues to delete an object on the server and to locally discard an object.&lt;br /&gt;
* Fixed an issue where DocumentViewModel.ShowDocumentCommand did not work when combined with InvokeCommandAction.&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.2 (Mobile)]]&lt;br /&gt;
[[Category:Mobile|Version 5.2 (Mobile)]]&lt;br /&gt;
[[Category:Version 5.2|Version 5.2 (Mobile)]]&lt;br /&gt;
&lt;br /&gt;
== Known issues ==&lt;br /&gt;
* On some Android devices (Pixel 7A, iSafe 930.1 as we know), the app doesn't recognize the device cameras on the first launch after fresh installations. If this happens, please simply restart the app and it should be fine from then on.&lt;br /&gt;
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true. In Mobile, deleting the last annotation does not correctly update the editor's internal edit state. As a result, the Save button may remain visible even though no edits exist.&lt;br /&gt;
* When changing the device orientation during attaching a photo on iOS, the app gets stuck. This is an issue Microsoft confirmed in .NET9 and will fix in .NET10.&lt;br /&gt;
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.&lt;br /&gt;
* Currently, the Samsung keyboard doesn't show {{key press|,}} at all, regardless of the current language/locale setting of the device. Please use a different virtual keyboard (e.g. Gboard from Google) instead if {{key press|.}} is unacceptable.&lt;br /&gt;
* The periodic execution of background pushes is not guaranteed on iOS (the native push feature doesn't have this issue).&lt;br /&gt;
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].&lt;br /&gt;
* It is currently not possible to select which camera to use for AR views (e.g. scan page) on Windows.&lt;br /&gt;
* SfPullToRefresh was removed due to [[Mobile_XAML#Issues_with_SfPullToRefresh_in_Mobile_client|existing issues]], and replaced with a Refresh option in the Context menu.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
= ⚠️ XAML Notes =&lt;br /&gt;
&lt;br /&gt;
* [[Editors#String_value_editor|UBIKEditString]] now uses ScanningIsActive rather than CallingViewModel.ScanToInput to show/hide the text input scanner/QR reader. Backwards compatibility is retained for existing customizings, inlcuding that of a [[EditPropertyValueCommand#Scan_to_Input|scan to input]] button to trigger property editing. However, the ScanningIsActive binding is more dynamic and can be toggled in realtime, whereas the CallingViewModel.ScanToInput is only applied once when the page is first rendered. &lt;br /&gt;
&lt;br /&gt;
&amp;lt;headertabs /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category:Client|Version 5.2 (Mobile)]]&lt;br /&gt;
[[Category:Mobile|Version 5.2 (Mobile)]]&lt;br /&gt;
[[Category:Version 5.2|Version 5.2 (Mobile)]]&lt;/div&gt;</summary>
		<author><name>LGE</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MRO_Material_Management</id>
		<title>MRO Material Management</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MRO_Material_Management"/>
				<updated>2026-06-16T12:28:34Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: /* See also */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== MRO Material Management ==&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Summary:''' The MRO material management features provide the foundation for handling materials, material master data, reservations, storage locations, and goods movements in MRO workflows. The central objects are &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialMaster&amp;lt;/span&amp;gt;, and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt;. Materials are linked to master data and storage locations. Reservations are created manually by users and link materials to tasks.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
MRO material management is used to support maintenance work with required spare parts, consumables, tools, or other material items.&lt;br /&gt;
&lt;br /&gt;
Users can see which material is required for a task, where the material is stored, how much material is available, how much material is reserved, and which reservation status applies.&lt;br /&gt;
&lt;br /&gt;
== Basic concept ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Object&lt;br /&gt;
! Type&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialMaster&amp;lt;/span&amp;gt;&lt;br /&gt;
| Master data&lt;br /&gt;
| Defines the catalogue entry for a material, including item number, unit, packaging, manufacturer data, and material type.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt;&lt;br /&gt;
| Quantity-bearing MRO object&lt;br /&gt;
| Represents a material instance or stock entry in MRO. It links to a material master and a storage location and exposes quantity, reserved quantity, and available quantity logic.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt;&lt;br /&gt;
| Workflow object&lt;br /&gt;
| Represents a manually created material reservation for a task. It links a material to a task and stores planned and actual quantities.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement&amp;lt;/span&amp;gt;&lt;br /&gt;
| Technical base class&lt;br /&gt;
| Provides the common &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; property used by both materials and reservations.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;StorageLocation&amp;lt;/span&amp;gt;&lt;br /&gt;
| Related storage object&lt;br /&gt;
| Represents a physical storage location for materials.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Core idea:''' &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialMaster&amp;lt;/span&amp;gt; defines what the material is. &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt; represents the material in stock or material context. &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt; links a material to a task and reserves a planned quantity for maintenance execution.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== MaterialMaster ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialMaster&amp;lt;/span&amp;gt; represents the material master or catalogue entry.&lt;br /&gt;
&lt;br /&gt;
It stores item-level master data that can be referenced by material instances in MRO.&lt;br /&gt;
&lt;br /&gt;
=== Important properties ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Type&lt;br /&gt;
! Meaning&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ITEM_NUMBER&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Item number or material number.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PACKAGING_UNIT&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Packaging unit.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PACKAGING_SIZE&amp;lt;/span&amp;gt;&lt;br /&gt;
| double&lt;br /&gt;
| Packaging size.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ACTIVE&amp;lt;/span&amp;gt;&lt;br /&gt;
| bool&lt;br /&gt;
| Defines whether the material master is active.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;UNIT_OF_MEASURE&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Unit of measure.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MATERIAL_TYPE&amp;lt;/span&amp;gt; / &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialType&amp;lt;/span&amp;gt;&lt;br /&gt;
| int / enum&lt;br /&gt;
| Material type.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MANUFACTURER_COMPANY_NAME&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Manufacturer company name.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MANUFACTURER_PRODUCT_TAG&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Manufacturer product tag or product identifier.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Material type ===&lt;br /&gt;
&lt;br /&gt;
Values of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialType&amp;lt;/span&amp;gt; are:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SpareParts&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Consumables&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Tools&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Material ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt; represents a material instance or stock entry in MRO.&lt;br /&gt;
&lt;br /&gt;
It inherits from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement&amp;lt;/span&amp;gt; and therefore uses the inherited &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; property as its material quantity.&lt;br /&gt;
&lt;br /&gt;
A material links to:&lt;br /&gt;
&lt;br /&gt;
* a material master via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL_MASTER&amp;lt;/span&amp;gt;&lt;br /&gt;
* a storage location via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_STORAGE_LOCATION&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Important properties ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Type&lt;br /&gt;
! Meaning&lt;br /&gt;
! Stored or calculated&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL_MASTER&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialMaster&amp;lt;/span&amp;gt;&lt;br /&gt;
| Link to the material master data.&lt;br /&gt;
| Stored link&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_STORAGE_LOCATION&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;StorageLocation&amp;lt;/span&amp;gt;&lt;br /&gt;
| Link to the storage location where the material is located.&lt;br /&gt;
| Stored link&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| double&lt;br /&gt;
| Material quantity. Inherited from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement&amp;lt;/span&amp;gt;.&lt;br /&gt;
| Stored property&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RESERVED_QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| double&lt;br /&gt;
| Sum of planned quantities of confirmed reservations for this material.&lt;br /&gt;
| Calculated property&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MATERIAL_STATUS&amp;lt;/span&amp;gt; / &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialStatus&amp;lt;/span&amp;gt;&lt;br /&gt;
| int / enum&lt;br /&gt;
| Material status.&lt;br /&gt;
| User/admin managed property&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Material status ===&lt;br /&gt;
&lt;br /&gt;
The material status is stored in &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MATERIAL_STATUS&amp;lt;/span&amp;gt; and exposed through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialStatus&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
The property is managed by the user or administrator. The system does not change it automatically.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Numeric value&lt;br /&gt;
! Meaning&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Undefined&amp;lt;/span&amp;gt;&lt;br /&gt;
| 0&lt;br /&gt;
| No specific material status is defined.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Inactive&amp;lt;/span&amp;gt;&lt;br /&gt;
| 10&lt;br /&gt;
| Material is inactive and should not be used for new reservations.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Active&amp;lt;/span&amp;gt;&lt;br /&gt;
| 20&lt;br /&gt;
| Material is active and can be used for reservations.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Reserved quantity ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RESERVED_QUANTITY&amp;lt;/span&amp;gt; is calculated at read time.&lt;br /&gt;
&lt;br /&gt;
The calculation uses reservations where:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt; points to the current material&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;STATUS&amp;lt;/span&amp;gt; is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ReservationStatus.Confirmed&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The calculated value is the sum of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; of these confirmed reservations.&lt;br /&gt;
&lt;br /&gt;
=== Available quantity ===&lt;br /&gt;
&lt;br /&gt;
The available material quantity is calculated by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AvailableQuantity()&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 8px 10px; margin: 10px 0;&amp;quot;&amp;gt;&lt;br /&gt;
AvailableQuantity = QUANTITY - RESERVED_QUANTITY&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Delete behavior ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material.InternalDeleteAllowed()&amp;lt;/span&amp;gt; prevents deleting a material if it still has quantity or active reservations.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #d33; background-color: #fff5f5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Restriction:''' A &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt; cannot be deleted while it has a quantity greater than 0 or active reservations.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Reservation ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt; represents a manually created material reservation for a task.&lt;br /&gt;
&lt;br /&gt;
It links:&lt;br /&gt;
&lt;br /&gt;
* a task via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt;&lt;br /&gt;
* a material via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
It stores the planned reservation quantity in &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; and the actually issued or consumed quantity in &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Important properties ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Type&lt;br /&gt;
! Meaning&lt;br /&gt;
! Important behavior&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Task&amp;lt;/span&amp;gt;&lt;br /&gt;
| Link to the task for which the material is reserved.&lt;br /&gt;
| Setter is blocked when status is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt; or &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt;&lt;br /&gt;
| Link to the material being reserved.&lt;br /&gt;
| Setter is blocked when status is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt; or &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;STATUS&amp;lt;/span&amp;gt; / &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Status&amp;lt;/span&amp;gt;&lt;br /&gt;
| int / enum&lt;br /&gt;
| Reservation status.&lt;br /&gt;
| Changes are validated by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowStatusChange(int newStatus)&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt;&lt;br /&gt;
| double&lt;br /&gt;
| Planned quantity for the reservation.&lt;br /&gt;
| Setter validates through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowQuantityPlanned(double)&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| double&lt;br /&gt;
| Actually issued or consumed quantity. Overrides &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement.QUANTITY&amp;lt;/span&amp;gt;.&lt;br /&gt;
| Setter validates through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowQuantity(double)&amp;lt;/span&amp;gt;.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Reservation status ===&lt;br /&gt;
&lt;br /&gt;
Values of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ReservationStatus&amp;lt;/span&amp;gt; are:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Status&lt;br /&gt;
! Numeric value&lt;br /&gt;
! Meaning&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt;&lt;br /&gt;
| 0&lt;br /&gt;
| Reservation is planned.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;&lt;br /&gt;
| 10&lt;br /&gt;
| Reservation is confirmed and contributes to the material's reserved quantity.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;&lt;br /&gt;
| 20&lt;br /&gt;
| Material has been physically issued.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Cancelled&amp;lt;/span&amp;gt;&lt;br /&gt;
| 30&lt;br /&gt;
| Reservation was cancelled.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Expired&amp;lt;/span&amp;gt;&lt;br /&gt;
| 50&lt;br /&gt;
| Reservation has expired.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Status change rules ===&lt;br /&gt;
&lt;br /&gt;
Status changes are controlled by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowStatusChange(int newStatus)&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
The following rules are applied:&lt;br /&gt;
&lt;br /&gt;
* no status change is allowed when the current status is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;&lt;br /&gt;
* changing from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt; back to &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt; is not allowed&lt;br /&gt;
* other status changes are allowed by this method&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #d33; background-color: #fff5f5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Restriction:''' Once a reservation has status &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;, its status can no longer be changed by the normal status setter logic.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Planned quantity validation ===&lt;br /&gt;
&lt;br /&gt;
The setter of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; validates changes through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowQuantityPlanned(double)&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
A new planned quantity is only allowed if:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Status&amp;lt;/span&amp;gt; is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ReservationStatus.Planned&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt; is assigned&lt;br /&gt;
* the new quantity is greater than 0&lt;br /&gt;
* the new quantity is lower than or equal to &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL.AvailableQuantity()&amp;lt;/span&amp;gt; &lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Quantity rule:''' A planned reservation quantity can only be set while the reservation is still &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt; and only if the selected material has enough available quantity.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Actual quantity validation ===&lt;br /&gt;
&lt;br /&gt;
The overridden &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; setter validates changes through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowQuantity(double)&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
A new actual quantity is only allowed if:&lt;br /&gt;
&lt;br /&gt;
* the new quantity is greater than 0&lt;br /&gt;
* the status is either &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt; or &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Link editing rules ===&lt;br /&gt;
&lt;br /&gt;
The setters of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt; are guarded by reservation status.&lt;br /&gt;
&lt;br /&gt;
The links cannot be changed when the reservation is:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== StorageLocation ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;StorageLocation&amp;lt;/span&amp;gt; is a related object used to represent a physical storage location.&lt;br /&gt;
&lt;br /&gt;
A material can reference a storage location via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_STORAGE_LOCATION&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Important properties and values ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Type&lt;br /&gt;
! Values / meaning&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;STORAGE_TYPE&amp;lt;/span&amp;gt; / &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;StorageType&amp;lt;/span&amp;gt;&lt;br /&gt;
| int / enum&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Floor&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Shelf&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Rack&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Bin&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Pallet&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Container&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ACCESS_TYPE&amp;lt;/span&amp;gt; / &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AccessType&amp;lt;/span&amp;gt;&lt;br /&gt;
| int / enum&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Manual&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Forklift&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Crane&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Automated&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;OCCUPANCY_STATUS&amp;lt;/span&amp;gt; / &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;OccupancyStatus&amp;lt;/span&amp;gt;&lt;br /&gt;
| int / enum&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Empty&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Partial&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Full&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reserved&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Blocked&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;OutOfService&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;STORAGE_LABEL&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Label of the storage location.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEVEL&amp;lt;/span&amp;gt;&lt;br /&gt;
| int&lt;br /&gt;
| Level of the storage location.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;POSITION&amp;lt;/span&amp;gt;&lt;br /&gt;
| string&lt;br /&gt;
| Position identifier.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== GoodsMovement ==&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement&amp;lt;/span&amp;gt; is a technical base class.&lt;br /&gt;
&lt;br /&gt;
It provides the common &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; property for material-related objects such as &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Quantity concepts ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Quantity&lt;br /&gt;
! Property / method&lt;br /&gt;
! Object&lt;br /&gt;
! Stored or calculated&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| Material quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt;&lt;br /&gt;
| Stored&lt;br /&gt;
| Inherited from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Reserved quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RESERVED_QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt;&lt;br /&gt;
| Calculated&lt;br /&gt;
| Sum of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; of confirmed reservations for the material.&lt;br /&gt;
|-&lt;br /&gt;
| Available quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AvailableQuantity()&amp;lt;/span&amp;gt; &lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt;&lt;br /&gt;
| Calculated&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; minus &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RESERVED_QUANTITY&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Planned reservation quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt;&lt;br /&gt;
| Stored&lt;br /&gt;
| Validated by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowQuantityPlanned(double)&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Actually issued or consumed quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt;&lt;br /&gt;
| Stored&lt;br /&gt;
| Overrides &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GoodsMovement.QUANTITY&amp;lt;/span&amp;gt; and is validated by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AllowQuantity(double)&amp;lt;/span&amp;gt;.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Reservation workflow ==&lt;br /&gt;
&lt;br /&gt;
=== Creating or editing a reservation ===&lt;br /&gt;
&lt;br /&gt;
Reservations are created manually by the user.&lt;br /&gt;
&lt;br /&gt;
A reservation links a material to a task.&lt;br /&gt;
&lt;br /&gt;
For a reservation to define its planned quantity correctly:&lt;br /&gt;
&lt;br /&gt;
# &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt; must be set.&lt;br /&gt;
# &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt; must point to the task requiring the material.&lt;br /&gt;
# &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Status&amp;lt;/span&amp;gt; must still be &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt;.&lt;br /&gt;
# &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; must be greater than 0.&lt;br /&gt;
# &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; must not exceed &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL.AvailableQuantity()&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Confirmed reservations ===&lt;br /&gt;
&lt;br /&gt;
When a reservation is confirmed, it contributes to the material's reserved quantity.&lt;br /&gt;
&lt;br /&gt;
This affects the available quantity of the material.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 8px 10px; margin: 10px 0;&amp;quot;&amp;gt;&lt;br /&gt;
AvailableQuantity = QUANTITY - sum(QTY_PLANNED of confirmed reservations)&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Finishing a task ===&lt;br /&gt;
&lt;br /&gt;
When a task is finished, the task logic calls &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CloseReservations()&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Workflow effect:''' Finishing a task closes its reservations. Confirmed reservations become &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;; other active reservations become &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Cancelled&amp;lt;/span&amp;gt;.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Usage in tasks ==&lt;br /&gt;
&lt;br /&gt;
Reservations are the central link between material handling and task execution.&lt;br /&gt;
&lt;br /&gt;
A reservation connects:&lt;br /&gt;
&lt;br /&gt;
* the required material through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt;&lt;br /&gt;
* the task through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt;&lt;br /&gt;
* the planned quantity through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt;&lt;br /&gt;
* the actually issued or consumed quantity through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
* the reservation state through &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Status&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This means that material usage is tracked at task level.&lt;br /&gt;
&lt;br /&gt;
== Example workflow ==&lt;br /&gt;
&lt;br /&gt;
=== Step 1: Material master exists ===&lt;br /&gt;
&lt;br /&gt;
A spare part is defined as a &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialMaster&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Field&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ITEM_NUMBER&amp;lt;/span&amp;gt;&lt;br /&gt;
| OF-10045&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;UNIT_OF_MEASURE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Piece&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaterialType&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SpareParts&amp;lt;/span&amp;gt;&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Step 2: Material exists in a storage location ===&lt;br /&gt;
&lt;br /&gt;
A &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material&amp;lt;/span&amp;gt; object references the material master and a storage location.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL_MASTER&amp;lt;/span&amp;gt;&lt;br /&gt;
| Oil Filter Type A&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_STORAGE_LOCATION&amp;lt;/span&amp;gt;&lt;br /&gt;
| Storage Shelf A&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| 10&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RESERVED_QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| 0&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AvailableQuantity()&amp;lt;/span&amp;gt; &lt;br /&gt;
| 10&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Step 3: Reservation is created for a task ===&lt;br /&gt;
&lt;br /&gt;
A user manually creates a &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation&amp;lt;/span&amp;gt; and links the material to the task.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt;&lt;br /&gt;
| Replace oil filter&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt;&lt;br /&gt;
| Oil Filter Type A&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Status&amp;lt;/span&amp;gt;&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt;&lt;br /&gt;
| 1&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Step 4: Reservation is confirmed ===&lt;br /&gt;
&lt;br /&gt;
The reservation status is changed to &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
After confirmation, the material's reserved quantity includes the reservation's planned quantity.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Quantity&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material.QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| 10&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material.RESERVED_QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| 1&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Material.AvailableQuantity()&amp;lt;/span&amp;gt; &lt;br /&gt;
| 9&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Step 5: Actual quantity is entered ===&lt;br /&gt;
&lt;br /&gt;
The actually issued or consumed quantity is stored in &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation.QUANTITY&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Reservation.QUANTITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| 1&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Step 6: Task is finished ===&lt;br /&gt;
&lt;br /&gt;
When the task is finished, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CloseReservations()&amp;lt;/span&amp;gt; is called.&lt;br /&gt;
&lt;br /&gt;
The confirmed reservation is changed to &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Validation and business rules ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Area&lt;br /&gt;
! Rule&lt;br /&gt;
|-&lt;br /&gt;
| Planned reservation quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; must be greater than 0.&lt;br /&gt;
|-&lt;br /&gt;
| Planned reservation quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; can only be changed while the reservation is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Planned reservation quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QTY_PLANNED&amp;lt;/span&amp;gt; must not exceed &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL.AvailableQuantity()&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Actual issued or consumed quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; must be greater than 0.&lt;br /&gt;
|-&lt;br /&gt;
| Actual issued or consumed quantity&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; can only be changed while the reservation is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt; or &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Reservation status&lt;br /&gt;
| Status cannot be changed once the reservation is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Reservation status&lt;br /&gt;
| A reservation cannot be changed from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt; back to &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Planned&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Reservation links&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_TASK&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MATERIAL&amp;lt;/span&amp;gt; cannot be changed when status is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Issued&amp;lt;/span&amp;gt; or &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Confirmed&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Material deletion&lt;br /&gt;
| Material cannot be deleted while &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;QUANTITY&amp;lt;/span&amp;gt; is greater than 0.&lt;br /&gt;
|-&lt;br /&gt;
| Material deletion&lt;br /&gt;
| Material cannot be deleted while active reservations exist.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
* [[MRO (Plugin)]]&lt;br /&gt;
* [[MRO_Objects_(Client)]]&lt;br /&gt;
* [[MRO_Implemented_Objects]]&lt;br /&gt;
* [[MROMaintenancePlans]]&lt;br /&gt;
* [[MRO_Notification]]&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	<entry>
		<id>https://wiki.augmensys.com/index.php?title=MROMaintenancePlans</id>
		<title>MROMaintenancePlans</title>
		<link rel="alternate" type="text/html" href="https://wiki.augmensys.com/index.php?title=MROMaintenancePlans"/>
				<updated>2026-06-07T12:47:18Z</updated>
		
		<summary type="html">&lt;p&gt;LMA: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= MRO Maintenance Planning =&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Summary:''' The Maintenance Planning feature in MRO is used to plan recurring maintenance work and automatically generate work packages from maintenance plans. The maintenance plan defines the rules. The generated work package is used by users to execute and complete the actual maintenance work.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Overview ==&lt;br /&gt;
&lt;br /&gt;
A maintenance plan defines the rules for creating work packages. These rules include:&lt;br /&gt;
&lt;br /&gt;
* when work package generation should be scheduled&lt;br /&gt;
* which asset the work package belongs to&lt;br /&gt;
* which template work package is used&lt;br /&gt;
* how the template work package is copied&lt;br /&gt;
* how many days before the planned execution date work package generation may be scheduled&lt;br /&gt;
* how future planning dates are calculated&lt;br /&gt;
&lt;br /&gt;
The actual maintenance work is not executed by the maintenance plan itself. The Maintenance Planning Orchestrator schedules replication jobs; a separate execution process runs these jobs to create work packages. These generated work packages are then used by users to execute and complete the maintenance work.&lt;br /&gt;
&lt;br /&gt;
In MRO, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaintenancePlan&amp;lt;/span&amp;gt; is the abstract base class for maintenance planning. It provides the common foundation for maintenance plans, but it is not intended to be used directly.&lt;br /&gt;
&lt;br /&gt;
The fully implemented maintenance plan types in standard MRO are:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Custom maintenance plan types can be implemented by deriving from the abstract &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaintenancePlan&amp;lt;/span&amp;gt; base class. However, the standard MRO maintenance planning feature is based on cyclic maintenance plans and round maintenance plans.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Important:''' &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt; support recurrence-based scheduling. This includes planned execution dates, automatic work package generation, calendar-based scheduling, completion-based scheduling, automatic recalculation of scheduling dates, and generation based on due dates.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt; additionally supports maintenance rounds. A round maintenance plan creates one main work package for the round. It can also create additional work packages from child maintenance plans linked via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt;. These additional work packages are assigned to the main round work package.&lt;br /&gt;
&lt;br /&gt;
== Basic Concept ==&lt;br /&gt;
&lt;br /&gt;
The maintenance planning feature is built around four main parts:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Part&lt;br /&gt;
! Description&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines the rules for creating generated work packages.&lt;br /&gt;
|-&lt;br /&gt;
| Template work package&lt;br /&gt;
| Defines what the generated work package should look like.&lt;br /&gt;
|-&lt;br /&gt;
| Replication configuration&lt;br /&gt;
| Defines how the template work package is copied.&lt;br /&gt;
|-&lt;br /&gt;
| Generated work package&lt;br /&gt;
| The actual work package created by the maintenance plan.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Maintenance Plan ===&lt;br /&gt;
&lt;br /&gt;
The maintenance plan defines the rules for creating work packages.&lt;br /&gt;
&lt;br /&gt;
This includes, for example:&lt;br /&gt;
&lt;br /&gt;
* when work package generation should be scheduled&lt;br /&gt;
* which asset the work package should belong to&lt;br /&gt;
* how many days before the planned execution date work package generation may be scheduled&lt;br /&gt;
* which template work package should be used&lt;br /&gt;
* which recurrence pattern should be used&lt;br /&gt;
* whether future dates are calculated calendar-based or completion-based&lt;br /&gt;
&lt;br /&gt;
=== Template Work Package ===&lt;br /&gt;
&lt;br /&gt;
The template work package defines what the generated work package should look like.&lt;br /&gt;
&lt;br /&gt;
It is the source work package that is copied when the maintenance plan creates a new work package.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Rule:''' Only work packages with &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ISTEMPLATE&amp;lt;/span&amp;gt; set can be used as template work packages.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Replication Configuration ===&lt;br /&gt;
&lt;br /&gt;
The replication configuration defines how the template work package is copied.&lt;br /&gt;
&lt;br /&gt;
This includes, for example:&lt;br /&gt;
&lt;br /&gt;
* which properties are copied&lt;br /&gt;
* how referenced objects are handled&lt;br /&gt;
* what the target meta class of the generated work package should be&lt;br /&gt;
&lt;br /&gt;
To generate a non-template work package, configure replication so that &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ISTEMPLATE&amp;lt;/span&amp;gt; is false on the result. The replication job does not clear this flag automatically. Linked work packages with &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ISTEMPLATE&amp;lt;/span&amp;gt; set are excluded from the plan’s related work package calculations, including open work package checks, recurrence counts, and planning and completion reference dates.&lt;br /&gt;
&lt;br /&gt;
=== Generated Work Package ===&lt;br /&gt;
&lt;br /&gt;
The generated work package is the actual result created by the maintenance plan.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
# A pump has to be inspected every month.&lt;br /&gt;
# A cyclic maintenance plan is created for this pump.&lt;br /&gt;
# The plan is configured with a monthly recurrence, an assigned asset, a template work package, and a replication configuration.&lt;br /&gt;
# When the plan becomes due, the system schedules a replication job. When executed, this job creates a new work package from the configured template work package.&lt;br /&gt;
# The generated work package is linked back to the maintenance plan via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
This link allows the maintenance plan to react when the generated work package is planned or completed.&lt;br /&gt;
&lt;br /&gt;
== MaintenancePlan Base Class ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaintenancePlan&amp;lt;/span&amp;gt; is the abstract base class for maintenance planning in MRO.&lt;br /&gt;
&lt;br /&gt;
It provides the common properties and logic required by maintenance plan implementations.&lt;br /&gt;
&lt;br /&gt;
Because &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;MaintenancePlan&amp;lt;/span&amp;gt; is abstract, users do not create or use this base class directly in the standard MRO feature. Instead, the concrete maintenance plan types are used:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Developers can derive from the abstract base class if a project requires a custom maintenance plan type. In that case, the custom implementation must provide the missing plan-specific behavior.&lt;br /&gt;
&lt;br /&gt;
=== Base Class Properties ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Purpose&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;&lt;br /&gt;
| Links the maintenance plan to the asset that requires maintenance.&lt;br /&gt;
| Required for a valid cyclic maintenance plan.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;&lt;br /&gt;
| Links the maintenance plan to the template work package.&lt;br /&gt;
| The linked work package must have &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ISTEMPLATE&amp;lt;/span&amp;gt; set.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt;&lt;br /&gt;
| Links the maintenance plan to the replication configuration.&lt;br /&gt;
| Required for work package generation.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines the planned execution date of the next maintenance activity.&lt;br /&gt;
| Used as &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; on generated work packages.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines how many days before &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; the system may schedule work package generation.&lt;br /&gt;
| Does not define the recurrence interval.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines the earliest date on which work package generation may be scheduled.&lt;br /&gt;
| Calculated by the system.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines whether the maintenance plan is active or inactive.&lt;br /&gt;
| Only active plans are considered for automatic job scheduling.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines whether automatic job scheduling is enabled.&lt;br /&gt;
| If disabled, no new replication job is automatically scheduled for the plan.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Stores the retained completion reference date; see &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; below.&lt;br /&gt;
| Especially relevant for completion-based scheduling.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PRIORITY&amp;lt;/span&amp;gt;&lt;br /&gt;
| Numeric value that can be used to sort maintenance plans.&lt;br /&gt;
| For round maintenance plans, see also &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt; is the link to the asset that requires maintenance.&lt;br /&gt;
&lt;br /&gt;
This can be, for example:&lt;br /&gt;
&lt;br /&gt;
* equipment&lt;br /&gt;
* a functional location&lt;br /&gt;
* another customized maintainable object deriving from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Asset&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The generated work package is linked to the same asset.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Requirement:''' A cyclic maintenance plan requires &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt; to be assigned in order to be valid.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt; is the link to the template work package.&lt;br /&gt;
&lt;br /&gt;
The template work package defines what the generated work package should look like.&lt;br /&gt;
&lt;br /&gt;
When the maintenance plan creates a work package, the system copies the work package referenced by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
The linked work package must be a template work package. This means its &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ISTEMPLATE&amp;lt;/span&amp;gt; property must be set.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Requirement:''' &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt; must be configured before the maintenance plan can create a work package.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt; is the link to the replication configuration.&lt;br /&gt;
&lt;br /&gt;
The replication configuration defines how the template work package is copied into a generated work package.&lt;br /&gt;
&lt;br /&gt;
It can define, for example:&lt;br /&gt;
&lt;br /&gt;
* which properties are copied&lt;br /&gt;
* how references are copied&lt;br /&gt;
* what the target meta class of the generated work package should be&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Requirement:''' &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt; must be configured before the maintenance plan can create a work package.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; defines the planned execution date of the next maintenance activity.&lt;br /&gt;
&lt;br /&gt;
It answers the question: '''When should the next maintenance work be performed?'''&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is not necessarily the date on which the work package is created.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| 3&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 12 March&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
In this example, the system may create the work package on 12 March, but the generated work package is planned for 15 March.&lt;br /&gt;
&lt;br /&gt;
When a work package is generated, the generated work package receives the maintenance plan’s &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; as its &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; defines how many days before &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; the system may schedule work package generation.&lt;br /&gt;
&lt;br /&gt;
This is used to schedule work package generation before the actual planned execution date.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| 3&lt;br /&gt;
|-&lt;br /&gt;
| Resulting &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 12 March&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Note:''' &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; does not define the recurrence interval. It only defines how early work package generation may be scheduled before the planned execution date.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; is calculated by the system.&lt;br /&gt;
&lt;br /&gt;
It defines the earliest date on which work package generation may be scheduled.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE = NEXT_DATE - max(LEAD_DAYS, 0) days&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Only positive &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; values are subtracted; zero or negative values leave the date unchanged. If the year of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is less than 2000, the result is &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;default(DateTime)&amp;lt;/span&amp;gt; instead.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| 3&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 12 March&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The maintenance planning orchestrator searches for active plans where &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; has been reached.&lt;br /&gt;
&lt;br /&gt;
A plan can be considered for automatic job scheduling when:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE &amp;lt;= current date and time&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; has not yet been reached, no new replication job is automatically scheduled for the plan.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS&amp;lt;/span&amp;gt; defines whether the maintenance plan is active or inactive.&lt;br /&gt;
&lt;br /&gt;
Only active plans are considered for automatic job scheduling. Inactive plans are ignored by the maintenance planning orchestrator.&lt;br /&gt;
&lt;br /&gt;
Typical values are:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Inactive&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;Active&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This allows users to temporarily disable a maintenance plan without deleting it.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt; defines whether the system is allowed to automatically schedule replication jobs for the maintenance plan.&lt;br /&gt;
&lt;br /&gt;
If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt; is enabled, the maintenance planning orchestrator can schedule replication jobs once the plan is due.&lt;br /&gt;
&lt;br /&gt;
If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt; is disabled, no new replication job is automatically scheduled for the plan.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; stores the highest of its existing value and the completion dates of related non-template finished work packages. For cyclic maintenance plans, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; is an additional lower bound. The value is updated only when the resulting reference date is valid.&lt;br /&gt;
&lt;br /&gt;
This property is especially important for completion-based scheduling.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| Previous generated work package completed&lt;br /&gt;
| 20 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Completion-Based&lt;br /&gt;
|-&lt;br /&gt;
| Next date is calculated from&lt;br /&gt;
| 20 March&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The system updates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; when a generated work package is completed. In Completion-Based mode, relevant recurrence-setting changes also recalculate this reference during save; it can therefore use &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; before the first completion.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PRIORITY&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PRIORITY&amp;lt;/span&amp;gt; is a numeric value that can be used to sort maintenance plans.&lt;br /&gt;
&lt;br /&gt;
For round maintenance plans, there is also a property called &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Open point:''' The exact effect of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt; should only be documented after the implementation behavior has been verified.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Work Package Properties Used by Maintenance Planning ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Used on&lt;br /&gt;
! Purpose&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt;&lt;br /&gt;
| Generated work package&lt;br /&gt;
| Links the generated work package back to the maintenance plan that triggered its creation.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;&lt;br /&gt;
| Generated work package&lt;br /&gt;
| Stores the template work package that was used to create the generated work package.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;&lt;br /&gt;
| Generated work package&lt;br /&gt;
| Stores the asset for which the work package was created.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt;&lt;br /&gt;
| Generated work package&lt;br /&gt;
| Stores the planned start date of the generated work package.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORGA_STATUS&amp;lt;/span&amp;gt;&lt;br /&gt;
| Generated work package&lt;br /&gt;
| Used to determine whether a generated work package is finished.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;TASK_OWNER&amp;lt;/span&amp;gt;&lt;br /&gt;
| Additional round work package&lt;br /&gt;
| Assigns additional generated work packages to the main round work package.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORDERID&amp;lt;/span&amp;gt;&lt;br /&gt;
| Additional round work package&lt;br /&gt;
| Can be copied from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt; to structure or order round work packages.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GROUPID&amp;lt;/span&amp;gt;&lt;br /&gt;
| Additional round work package&lt;br /&gt;
| Can be copied from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt; to group round work packages.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt; is set on generated work packages.&lt;br /&gt;
&lt;br /&gt;
It stores the maintenance plan that triggered the creation of the work package.&lt;br /&gt;
&lt;br /&gt;
This is important because the maintenance plan itself does not directly store a list of generated work packages. Instead, generated work packages reference their source maintenance plan via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
This link allows the system to find work packages created from a maintenance plan and to update the maintenance plan when a generated work package is planned or completed.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
On a generated work package, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt; stores the template work package that was used to create the generated work package.&lt;br /&gt;
&lt;br /&gt;
This allows users and the system to see which template was used as the source.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
On a generated work package, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt; stores the asset for which the work package was created.&lt;br /&gt;
&lt;br /&gt;
This is usually copied or assigned based on the maintenance plan’s &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; stores the planned start date of the generated work package.&lt;br /&gt;
&lt;br /&gt;
When a maintenance plan generates a work package, the system sets:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
generated WorkPackage.PLANNED_START = MaintenancePlan.NEXT_DATE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORGA_STATUS&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORGA_STATUS&amp;lt;/span&amp;gt; is used to determine whether a generated work package is finished.&lt;br /&gt;
&lt;br /&gt;
A work package is considered finished when:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
ORGA_STATUS == 100&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Open work packages are non-template work packages linked to the maintenance plan where:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
ORGA_STATUS != 100&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Generation rule:''' For Completion-Based scheduling, automatic job scheduling is skipped while the maintenance plan has an open non-template work package. Open work packages do not block Calendar-Based scheduling.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;TASK_OWNER&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;TASK_OWNER&amp;lt;/span&amp;gt; is used in round maintenance scenarios.&lt;br /&gt;
&lt;br /&gt;
When a round maintenance plan creates a main work package and additional work packages from linked child plans, the additional work packages are assigned to the main round work package via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;TASK_OWNER&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORDERID&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GROUPID&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORDERID&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GROUPID&amp;lt;/span&amp;gt; can be copied from the &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt; relation to generated work packages in a round maintenance scenario.&lt;br /&gt;
&lt;br /&gt;
They can be used to order or group the additional work packages that belong to the generated round work package.&lt;br /&gt;
&lt;br /&gt;
== CyclicMaintenancePlan ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
A &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt; is used for recurring maintenance work on an asset.&lt;br /&gt;
&lt;br /&gt;
It is the standard maintenance plan type for maintenance activities that repeat according to a defined recurrence pattern.&lt;br /&gt;
&lt;br /&gt;
Examples:&lt;br /&gt;
&lt;br /&gt;
* inspect a pump every month&lt;br /&gt;
* service a machine every 6 months&lt;br /&gt;
* check safety equipment every Monday&lt;br /&gt;
* replace a filter every 30 days&lt;br /&gt;
* perform annual maintenance on a functional location&lt;br /&gt;
&lt;br /&gt;
A cyclic maintenance plan uses &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; to define the recurrence. It also uses &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; to define how future dates are calculated.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Key concept:''' &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; defines whether the plan follows fixed calendar dates or whether the next date depends on the actual completion date of the previous generated work package.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The supported scheduling modes are:&lt;br /&gt;
&lt;br /&gt;
* Calendar-Based&lt;br /&gt;
* Completion-Based&lt;br /&gt;
&lt;br /&gt;
== CyclicMaintenancePlan Properties ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Purpose&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines the recurrence pattern.&lt;br /&gt;
| Must be valid and parseable.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines when the recurrence pattern starts.&lt;br /&gt;
| Used as the start point for recurrence calculation.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Optional end date for the recurrence.&lt;br /&gt;
| Used as an end boundary for calculating new occurrences.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt;&lt;br /&gt;
| Limits further next-date calculation based on the number of related non-template work packages.&lt;br /&gt;
| Applies only to positive values; reaching the count does not clear the existing &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Defines how &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is calculated.&lt;br /&gt;
| Supports Calendar-Based and Completion-Based scheduling.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; defines the recurrence pattern of a cyclic maintenance plan.&lt;br /&gt;
&lt;br /&gt;
It describes how often the maintenance should occur.&lt;br /&gt;
&lt;br /&gt;
Examples:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
FREQ=DAILY&lt;br /&gt;
FREQ=WEEKLY;BYDAY=MO,WE,FR&lt;br /&gt;
FREQ=MONTHLY;BYMONTHDAY=15&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The system uses &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; to calculate future planned execution dates.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #d33; background-color: #fff5f5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Problem:''' If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; is invalid and cannot be parsed, the cyclic maintenance plan is not valid and is not eligible for new automatic job scheduling.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; defines when the recurrence pattern starts.&lt;br /&gt;
&lt;br /&gt;
For Calendar-Based scheduling, the recurrence rule is calculated from this date forward. In both scheduling modes, this date is also a lower bound for the planning or completion reference date.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 01 January&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Monthly on the 15th&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The system uses these values to determine valid planned execution dates.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt; is an optional end date for the recurrence.&lt;br /&gt;
&lt;br /&gt;
If this date is valid and configured, it is passed to the recurrence calculation as an end boundary.&lt;br /&gt;
&lt;br /&gt;
This can be used to set an end boundary for recurrence calculation.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; limits further next-date calculation based on the number of related non-template work packages.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt;&lt;br /&gt;
| 10&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
When a positive &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; is reached by the number of related non-template work packages, the system no longer calculates new occurrences for the plan. Finished and unfinished work packages are counted; values of zero or less impose no count limit. Reaching the limit also blocks new automatic job scheduling in both scheduling modes.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; defines how &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is calculated for a cyclic maintenance plan.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; is only relevant for concrete maintenance plan types that use recurrence logic, such as &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
The supported scheduling modes are:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Scheduling mode&lt;br /&gt;
! Description&lt;br /&gt;
|-&lt;br /&gt;
| Calendar-Based&lt;br /&gt;
| Future dates follow the recurrence pattern defined by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Completion-Based&lt;br /&gt;
| Future dates are calculated from the completion reference described under &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
This property is one of the most important settings because it defines whether future dates follow the calendar or depend on the actual completion of the previous generated work package.&lt;br /&gt;
&lt;br /&gt;
== Calendar-Based Scheduling ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
Calendar-based scheduling is used when maintenance should follow fixed calendar occurrences.&lt;br /&gt;
&lt;br /&gt;
The next planned execution date is calculated according to &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; and the calendar recurrence.&lt;br /&gt;
&lt;br /&gt;
This means that delays in completing a work package do not automatically shift the whole future schedule.&lt;br /&gt;
&lt;br /&gt;
Use calendar-based scheduling when the maintenance should happen on fixed dates or fixed calendar intervals.&lt;br /&gt;
&lt;br /&gt;
Examples:&lt;br /&gt;
&lt;br /&gt;
* inspection every 15th day of the month&lt;br /&gt;
* safety check every Monday&lt;br /&gt;
* yearly inspection every January&lt;br /&gt;
* quarterly maintenance in fixed maintenance windows&lt;br /&gt;
&lt;br /&gt;
=== How Calendar-Based Scheduling Works ===&lt;br /&gt;
&lt;br /&gt;
In calendar-based scheduling, the system calculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; based on the recurrence rule and the relevant dates of existing generated work packages.&lt;br /&gt;
&lt;br /&gt;
The system determines the highest of the existing &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt;, and the relevant dates of related non-template work packages: the finished date for finished work packages and the planned start for unfinished work packages. Then it uses the recurrence rule to calculate the next valid occurrence after that date.&lt;br /&gt;
&lt;br /&gt;
This means the schedule continues according to the recurrence pattern.&lt;br /&gt;
&lt;br /&gt;
If a work package is completed later than planned, the calendar pattern is retained, but the completion reference can move past one or more occurrences and cause them to be skipped. These skipped occurrences are not generated retroactively.&lt;br /&gt;
&lt;br /&gt;
=== Example: Calendar-Based Scheduling ===&lt;br /&gt;
&lt;br /&gt;
A pump must be inspected on the 15th of every month.&lt;br /&gt;
&lt;br /&gt;
==== Configuration ====&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| Plan type&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;&lt;br /&gt;
| Pump 1&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;&lt;br /&gt;
| Pump Inspection Template&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt;&lt;br /&gt;
| Pump Inspection Replication&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Calendar-Based&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Monthly on the 15th&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 01 January&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| 3&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS&amp;lt;/span&amp;gt;&lt;br /&gt;
| Active&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Enabled&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Result ====&lt;br /&gt;
&lt;br /&gt;
The system calculates:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE = 12 March&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
On or after 12 March, the system can create the work package.&lt;br /&gt;
&lt;br /&gt;
Generated work package:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
After the work package is planned, the system can calculate the next occurrence:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
NEXT_DATE = 15 April&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If the March work package is completed on 20 March, the next date still follows the monthly recurrence. The next planned execution date remains 15 April.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Result:''' The late completion does not shift the future schedule to 20 April.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Completion-Based Scheduling ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
Completion-based scheduling is used when the next maintenance date should depend on the actual completion date of the previous generated work package.&lt;br /&gt;
&lt;br /&gt;
This means that the interval starts after the work has actually been completed.&lt;br /&gt;
&lt;br /&gt;
Use completion-based scheduling when the maintenance should repeat based on the time since the last completed maintenance activity.&lt;br /&gt;
&lt;br /&gt;
Examples:&lt;br /&gt;
&lt;br /&gt;
* service every 30 days after the last service&lt;br /&gt;
* inspection 6 months after the previous inspection was completed&lt;br /&gt;
* replacement 90 days after the previous replacement&lt;br /&gt;
* maintenance where a delay should also delay the next cycle&lt;br /&gt;
&lt;br /&gt;
=== How Completion-Based Scheduling Works ===&lt;br /&gt;
&lt;br /&gt;
In completion-based scheduling, the system recalculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; after a generated work package is completed.&lt;br /&gt;
&lt;br /&gt;
The completion date becomes the basis for the next occurrence.&lt;br /&gt;
&lt;br /&gt;
Planning changes alone do not define the next recurrence in the same way as calendar-based scheduling.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Important:''' An open non-template work package blocks new automatic job scheduling. Completion triggers next-date calculation; relevant recurrence-setting changes can also trigger calculation during save.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Example: Completion-Based Scheduling ===&lt;br /&gt;
&lt;br /&gt;
A machine must be serviced every 30 days after the previous service was completed.&lt;br /&gt;
&lt;br /&gt;
==== Configuration ====&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Setting&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| Plan type&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;&lt;br /&gt;
| Machine 1&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;&lt;br /&gt;
| Machine Service Template&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt;&lt;br /&gt;
| Machine Service Replication&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Completion-Based&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Every 30 days&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 01 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| 3&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS&amp;lt;/span&amp;gt;&lt;br /&gt;
| Active&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Enabled&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Result ====&lt;br /&gt;
&lt;br /&gt;
The system calculates:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE = 12 March&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
On or after 12 March, the system can create the work package.&lt;br /&gt;
&lt;br /&gt;
Generated work package:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Property&lt;br /&gt;
! Value&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt;&lt;br /&gt;
| 15 March&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The work package is completed on 20 March.&lt;br /&gt;
&lt;br /&gt;
Because the plan is completion-based, the system calculates the next date from 20 March.&lt;br /&gt;
&lt;br /&gt;
If the recurrence is every 30 days:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Value&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| around 19 April&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;&lt;br /&gt;
| 3&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| around 16 April&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Result:''' In this mode, the delay from 15 March to 20 March shifts the future schedule.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Calendar-Based vs Completion-Based Scheduling ==&lt;br /&gt;
&lt;br /&gt;
The difference is the date that is used as the basis for calculating &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Aspect&lt;br /&gt;
! Calendar-Based&lt;br /&gt;
! Completion-Based&lt;br /&gt;
|-&lt;br /&gt;
| Basis for &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Recurrence defined by &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Completion reference described under &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Effect of late completion&lt;br /&gt;
| The calendar pattern is retained, but missed occurrences can be skipped&lt;br /&gt;
| Future dates move with the completion date&lt;br /&gt;
|-&lt;br /&gt;
| Typical use case&lt;br /&gt;
| Fixed maintenance windows, fixed calendar intervals, legal or organizational inspection dates&lt;br /&gt;
| Service intervals that depend on the actual last maintenance&lt;br /&gt;
|-&lt;br /&gt;
| Example&lt;br /&gt;
| Planned: 15 March&amp;lt;br /&amp;gt;Completed: 20 March&amp;lt;br /&amp;gt;Next date: 15 April&lt;br /&gt;
| Planned: 15 March&amp;lt;br /&amp;gt;Completed: 20 March&amp;lt;br /&amp;gt;Interval: 30 days&amp;lt;br /&amp;gt;Next date: around 19 April&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Calendar-Based ===&lt;br /&gt;
&lt;br /&gt;
Calendar-based scheduling should be used when the maintenance must follow fixed planned dates.&lt;br /&gt;
&lt;br /&gt;
Characteristics:&lt;br /&gt;
&lt;br /&gt;
* The plan follows the &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; calendar pattern.&lt;br /&gt;
* The calendar pattern is retained, but late completion can change the next selected occurrence.&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; can be recalculated after planning updates.&lt;br /&gt;
* It is useful for fixed maintenance windows and legally or organizationally fixed inspection dates.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Event&lt;br /&gt;
! Date&lt;br /&gt;
|-&lt;br /&gt;
| Planned inspection&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| Completed&lt;br /&gt;
| 20 March&lt;br /&gt;
|-&lt;br /&gt;
| Next date&lt;br /&gt;
| 15 April&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The future date stays aligned with the calendar recurrence.&lt;br /&gt;
&lt;br /&gt;
=== Completion-Based ===&lt;br /&gt;
&lt;br /&gt;
Completion-based scheduling should be used when the next maintenance interval starts after the previous work was completed.&lt;br /&gt;
&lt;br /&gt;
Characteristics:&lt;br /&gt;
&lt;br /&gt;
* An open non-template work package blocks new automatic job scheduling.&lt;br /&gt;
* The completion date is used as the basis for &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
* If the work is completed late, the future schedule moves.&lt;br /&gt;
* It is useful for service intervals that depend on the actual last maintenance.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
! Event&lt;br /&gt;
! Date&lt;br /&gt;
|-&lt;br /&gt;
| Planned service&lt;br /&gt;
| 15 March&lt;br /&gt;
|-&lt;br /&gt;
| Completed&lt;br /&gt;
| 20 March&lt;br /&gt;
|-&lt;br /&gt;
| Interval&lt;br /&gt;
| 30 days&lt;br /&gt;
|-&lt;br /&gt;
| Next date&lt;br /&gt;
| around 19 April&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The future date shifts because the work was completed later.&lt;br /&gt;
&lt;br /&gt;
== RoundMaintenancePlan ==&lt;br /&gt;
&lt;br /&gt;
=== Purpose ===&lt;br /&gt;
&lt;br /&gt;
A &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt; is used for recurring maintenance rounds.&lt;br /&gt;
&lt;br /&gt;
It is a specialized type of cyclic maintenance plan. This means that it also uses &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
In addition to the cyclic scheduling logic, a round maintenance plan includes child maintenance plans linked via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
When the round maintenance plan is due, the system creates the main work package for the round. Then it creates additional work packages from the child maintenance plans linked via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Important for child plans:''' For the child plans, the system does not care whether they are due, active, auto-created, or whether they have a valid &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;. The round maintenance plan uses the child plans as configuration for the additional work packages that should be created as part of the round.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The important configuration on the child plans is their work package generation setup, especially the configured template work package and replication setup.&lt;br /&gt;
&lt;br /&gt;
=== Generated Result ===&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Element&lt;br /&gt;
! Example&lt;br /&gt;
|-&lt;br /&gt;
| Round maintenance plan&lt;br /&gt;
| Machine Room Round&lt;br /&gt;
|-&lt;br /&gt;
| Linked child plan 1&lt;br /&gt;
| Pump 1 Inspection&lt;br /&gt;
|-&lt;br /&gt;
| Linked child plan 2&lt;br /&gt;
| Pump 2 Inspection&lt;br /&gt;
|-&lt;br /&gt;
| Linked child plan 3&lt;br /&gt;
| Pump 3 Inspection&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Generated main work package:&lt;br /&gt;
&lt;br /&gt;
* Machine Room Round&lt;br /&gt;
&lt;br /&gt;
Additional generated work packages inside the main round work package:&lt;br /&gt;
&lt;br /&gt;
* Pump 1 Inspection&lt;br /&gt;
* Pump 2 Inspection&lt;br /&gt;
* Pump 3 Inspection&lt;br /&gt;
&lt;br /&gt;
The additional work packages are assigned to the main round work package. This allows the result of the round maintenance plan to be structured as one complete maintenance round.&lt;br /&gt;
&lt;br /&gt;
== RoundMaintenancePlan Properties and Relations ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Property / relation&lt;br /&gt;
! Purpose&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt;&lt;br /&gt;
| Links the round maintenance plan to its child maintenance plans.&lt;br /&gt;
| Child plans define additional work packages created as part of the round.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Exists on &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;.&lt;br /&gt;
| Runtime behavior must be verified before documenting further effects.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORDERID&amp;lt;/span&amp;gt;&lt;br /&gt;
| Can exist on the relation between the round plan and a child plan.&lt;br /&gt;
| Can be copied to generated work packages.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GROUPID&amp;lt;/span&amp;gt;&lt;br /&gt;
| Can exist on the relation between the round plan and a child plan.&lt;br /&gt;
| Can be copied to generated work packages.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt; links the round maintenance plan to its child maintenance plans.&lt;br /&gt;
&lt;br /&gt;
The linked child plans define which additional work packages should be generated when the round maintenance plan is due.&lt;br /&gt;
&lt;br /&gt;
When the round plan generates work packages, the system creates:&lt;br /&gt;
&lt;br /&gt;
* one main work package from the round plan’s own &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;&lt;br /&gt;
* one additional work package for each child maintenance plan linked via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The child maintenance plans do not need to be due themselves for the round maintenance plan to use them during round generation.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt; exists on &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Open point:''' The exact runtime effect of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt; should be documented after the implementation behavior has been verified. Until that behavior is confirmed, the wiki should not claim that &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_SELECTION_RULE&amp;lt;/span&amp;gt; filters child plans by due date, asset, or priority.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORDERID&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GROUPID&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
The relation between the round maintenance plan and a linked child maintenance plan can contain &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORDERID&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;GROUPID&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
When the system creates an additional work package from a linked child maintenance plan, these values can be copied to the generated work package.&lt;br /&gt;
&lt;br /&gt;
This can be used to structure, order, or group the additional work packages in the generated round.&lt;br /&gt;
&lt;br /&gt;
== Properties Calculated or Updated by the System ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Property / link&lt;br /&gt;
! System behavior&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Calculated from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Calculated or recalculated for &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
| Updated when a generated work package is completed.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt;&lt;br /&gt;
| Set on generated work packages from the maintenance plan’s &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Links on generated work packages&lt;br /&gt;
| Required links are set automatically during generation.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; is calculated by the system from &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE = NEXT_DATE - max(LEAD_DAYS, 0) days&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This value is recalculated during save when:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; changes&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; changes&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is recalculated after planning or completion&lt;br /&gt;
* recurrence settings cause a new &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; to be calculated&lt;br /&gt;
&lt;br /&gt;
For cyclic maintenance plans, this value is recalculated on every save.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
For &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;CyclicMaintenancePlan&amp;lt;/span&amp;gt; and &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RoundMaintenancePlan&amp;lt;/span&amp;gt;, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; can be calculated or recalculated by the system.&lt;br /&gt;
&lt;br /&gt;
The calculation depends on:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt;&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;&lt;br /&gt;
* related generated work packages&lt;br /&gt;
* planning events&lt;br /&gt;
* completion events&lt;br /&gt;
&lt;br /&gt;
For calendar-based scheduling, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is calculated from the recurrence pattern and the highest relevant planned or finished date of related generated work packages.&lt;br /&gt;
&lt;br /&gt;
For completion-based scheduling, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is calculated from the completion reference described under &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; ===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; is updated by the system when a generated work package is completed.&lt;br /&gt;
&lt;br /&gt;
It retains the completion reference described in the &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; section above.&lt;br /&gt;
&lt;br /&gt;
This value is especially relevant for completion-based scheduling.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; on Generated Work Packages ===&lt;br /&gt;
&lt;br /&gt;
When the system generates a work package from a maintenance plan, it sets the generated work package’s &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; to the maintenance plan’s &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; at job execution. The scheduled job stores the plan identifier, not a snapshot of this date.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
MaintenancePlan.NEXT_DATE: 15 March&lt;br /&gt;
Generated WorkPackage.PLANNED_START: 15 March&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Links on Generated Work Packages ===&lt;br /&gt;
&lt;br /&gt;
When the system generates a work package, it automatically sets the required links on the generated work package.&lt;br /&gt;
&lt;br /&gt;
The generated work package is linked to:&lt;br /&gt;
&lt;br /&gt;
* the source maintenance plan via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt;&lt;br /&gt;
* the template work package via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt;&lt;br /&gt;
* the assigned asset via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
For round maintenance plans, additional generated work packages from linked child maintenance plans are assigned to the main round work package via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;TASK_OWNER&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Properties and Events That Trigger Recalculation ==&lt;br /&gt;
&lt;br /&gt;
Property changes trigger recalculation during save. A new &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is assigned only if recurrence calculation succeeds. If no further occurrence can be calculated, including when a positive &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; is reached, the existing &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is retained. In both scheduling modes, a reached positive &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; or an exhausted recurrence blocks new automatic job scheduling. The final permitted occurrence may still be generated once; retaining &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; does not by itself authorize another automatic job.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Trigger&lt;br /&gt;
! Recalculation behavior&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Recalculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Recalculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; based on the new recurrence rule and selected &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Recalculates the schedule and may change &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Checks whether future occurrences are still available.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Checks whether the positive count limit for next-date calculation has been reached.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; according to the selected scheduling mode.&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; according to the selected scheduling mode.&lt;br /&gt;
|-&lt;br /&gt;
| Generated work package &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; changed&lt;br /&gt;
| Notifies the linked maintenance plan and may trigger date recalculation.&lt;br /&gt;
|-&lt;br /&gt;
| Generated work package completed&lt;br /&gt;
| Updates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; and attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;; see Generated Work Package Completed below.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; changes, the system recalculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE = NEXT_DATE - max(LEAD_DAYS, 0) days&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LEAD_DAYS&amp;lt;/span&amp;gt; changes, the system recalculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
EARLIEST_GENERATION_DATE = NEXT_DATE - max(LEAD_DAYS, 0) days&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt; changes, the recurrence pattern changes.&lt;br /&gt;
&lt;br /&gt;
The system attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; based on the new recurrence rule and the selected &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
After &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is recalculated, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; is recalculated as well.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_START_DATE&amp;lt;/span&amp;gt; changes, the start point of the recurrence changes.&lt;br /&gt;
&lt;br /&gt;
The system recalculates the schedule. This can change &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; changes, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; is recalculated as well.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt; changes, the end boundary of the recurrence changes.&lt;br /&gt;
&lt;br /&gt;
The system checks whether future occurrences are still available.&lt;br /&gt;
&lt;br /&gt;
If no further occurrence is possible because of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_UNTIL_DATE&amp;lt;/span&amp;gt;, the system cannot calculate a new &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;. The end boundary is inclusive. When no permitted occurrence remains to be generated, new automatic job scheduling is blocked in both modes.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; changes, the system checks whether the positive count limit for next-date calculation has been reached.&lt;br /&gt;
&lt;br /&gt;
If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; is positive and the number of related non-template work packages is greater than or equal to it, the system does not calculate further occurrences.&lt;br /&gt;
&lt;br /&gt;
=== &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt; changes, the logic for calculating future dates changes.&lt;br /&gt;
&lt;br /&gt;
Changing to Calendar-Based means that the plan follows the calendar recurrence.&lt;br /&gt;
&lt;br /&gt;
Changing to Completion-Based means that the plan calculates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; from the completion reference described under &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Because this changes the calculation logic, the system attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; according to the selected &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SCHEDULING_MODE&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
If &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; changes, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; is recalculated as well.&lt;br /&gt;
&lt;br /&gt;
=== Generated Work Package &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; Changed ===&lt;br /&gt;
&lt;br /&gt;
When &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; of a generated work package is set or changed, the work package notifies the linked maintenance plan.&lt;br /&gt;
&lt;br /&gt;
For calendar-based cyclic maintenance plans, this can trigger recalculation of &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;. The system uses the planning information to continue the calendar-based recurrence.&lt;br /&gt;
&lt;br /&gt;
For completion-based cyclic maintenance plans, a &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLANNED_START&amp;lt;/span&amp;gt; change does not drive the recurrence in the same way. &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is mainly calculated after the work package is completed.&lt;br /&gt;
&lt;br /&gt;
=== Generated Work Package Completed ===&lt;br /&gt;
&lt;br /&gt;
When a generated work package is completed, the work package notifies the linked maintenance plan.&lt;br /&gt;
&lt;br /&gt;
A work package is considered completed when:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
ORGA_STATUS == 100&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The system updates &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt;. Completion-Based scheduling directly attempts to recalculate &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;. Calendar-Based scheduling attempts recalculation during the subsequent plan save if &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LAST_DATE&amp;lt;/span&amp;gt; has changed.&lt;br /&gt;
&lt;br /&gt;
For calendar-based scheduling:&lt;br /&gt;
&lt;br /&gt;
* the system continues according to the calendar recurrence&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is calculated from the recurrence pattern and relevant planned or finished dates&lt;br /&gt;
&lt;br /&gt;
For completion-based scheduling:&lt;br /&gt;
&lt;br /&gt;
* the completion date becomes the basis for the next occurrence&lt;br /&gt;
* &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is calculated from the completion date&lt;br /&gt;
&lt;br /&gt;
After &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; is updated, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt; is recalculated.&lt;br /&gt;
&lt;br /&gt;
== Work Package Generation Logic ==&lt;br /&gt;
&lt;br /&gt;
=== When Is a Plan Ready to Create a Work Package? ===&lt;br /&gt;
&lt;br /&gt;
Automatic generation consists of job scheduling followed by later execution. The plan validity, status, automatic generation, due-date, recurrence-limit, and open work package checks below apply before scheduling. The open work package check applies only to Completion-Based scheduling. The template and replication configuration must be present when the job executes.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;width: 100%;&amp;quot;&lt;br /&gt;
! Requirement&lt;br /&gt;
! Condition&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| Plan validity&lt;br /&gt;
| The plan must be valid.&lt;br /&gt;
| For cyclic maintenance plans, this requires a valid &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;, assigned &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_ASSET&amp;lt;/span&amp;gt;, and available &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;.&lt;br /&gt;
|-&lt;br /&gt;
| Plan status&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS == Active&amp;lt;/span&amp;gt;&lt;br /&gt;
| Inactive plans are ignored for new automatic job scheduling.&lt;br /&gt;
|-&lt;br /&gt;
| Automatic generation&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt; must be enabled.&lt;br /&gt;
| If disabled, no new replication job is automatically scheduled for the plan.&lt;br /&gt;
|-&lt;br /&gt;
| Template work package&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_WP_TMPL&amp;lt;/span&amp;gt; must be set.&lt;br /&gt;
| The linked work package must be a template work package.&lt;br /&gt;
|-&lt;br /&gt;
| Replication configuration&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_REPLICATION_CONFIG&amp;lt;/span&amp;gt; must be set.&lt;br /&gt;
| Required at job execution; not checked before automatic job scheduling.&lt;br /&gt;
|-&lt;br /&gt;
| Earliest generation date&lt;br /&gt;
| &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE &amp;lt;= current date and time&amp;lt;/span&amp;gt;&lt;br /&gt;
| A new job may only be automatically scheduled once the earliest generation date has been reached.&lt;br /&gt;
|-&lt;br /&gt;
| Open work packages (Completion-Based only)&lt;br /&gt;
| No open non-template work package may exist for the plan when automatic scheduling is checked.&lt;br /&gt;
| There must be no non-template work package linked via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;LK_MAINTENANCE_PLAN&amp;lt;/span&amp;gt; where &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;ORGA_STATUS != 100&amp;lt;/span&amp;gt;. Calendar-Based scheduling is not blocked by open work packages.&lt;br /&gt;
|-&lt;br /&gt;
| Recurrence limits&lt;br /&gt;
| A positive &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE_COUNT&amp;lt;/span&amp;gt; must not be reached, and a permitted occurrence must remain to be generated.&lt;br /&gt;
| Applies to both scheduling modes; a retained &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt; alone does not authorize another automatic job.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #f0ad4e; background-color: #fff8e5; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Generation rule:''' In Completion-Based scheduling, the open work package check prevents new automatic job scheduling while an open non-template work package exists. This check alone does not guarantee protection against multiple queued jobs or concurrent execution.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The standard replication job checks that the template and replication configuration are present, but does not repeat the plan validity, status, &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE&amp;lt;/span&amp;gt;, due-date, or open work package checks during execution. Changing these settings must not be assumed to cancel an already scheduled job.&lt;br /&gt;
&lt;br /&gt;
'''Open point:''' Whether an already scheduled job must recheck recurrence limits if they become exhausted before execution remains to be defined.&lt;br /&gt;
&lt;br /&gt;
== Round Work Package Generation ==&lt;br /&gt;
&lt;br /&gt;
A round maintenance plan creates a main work package for the round.&lt;br /&gt;
&lt;br /&gt;
After the main work package has been created, the system processes the maintenance plans linked via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;SYSREL_ROUND_RELATION&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
For each linked child maintenance plan, the system creates an additional work package.&lt;br /&gt;
&lt;br /&gt;
These additional generated work packages are assigned to the main round work package via &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;TASK_OWNER&amp;lt;/span&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
For child plans used in a round, the system does not care whether the child plan:&lt;br /&gt;
&lt;br /&gt;
* has &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;PLAN_STATUS == Active&amp;lt;/span&amp;gt;&lt;br /&gt;
* has &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;AUTO_CREATE == true&amp;lt;/span&amp;gt;&lt;br /&gt;
* has a valid &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;RRULE&amp;lt;/span&amp;gt;&lt;br /&gt;
* has a valid &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;NEXT_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
* is due based on its own &amp;lt;span style=&amp;quot;font-family: Consolas, 'Courier New', monospace; color: #202122; background-color: #f8f9fa; border: 1px solid #c8ccd1; border-radius: 3px; padding: 1px 4px; white-space: nowrap;&amp;quot;&amp;gt;EARLIEST_GENERATION_DATE&amp;lt;/span&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;div style=&amp;quot;border-left: 4px solid #36c; background-color: #f8f9fa; padding: 10px 12px; margin: 12px 0;&amp;quot;&amp;gt;&lt;br /&gt;
'''Rule:''' The round plan controls the timing. The child plans define what additional work packages should be created as part of the round.&lt;br /&gt;
&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
* [[MRO (Plugin)]]&lt;br /&gt;
* [[MRO_Objects_(Client)]]&lt;br /&gt;
* [[MRO_Implemented_Objects]]&lt;br /&gt;
* [[MRO_Material_Management]]&lt;br /&gt;
* [[MRO_Notification]]&lt;br /&gt;
* [[MRO_Replication_Jobs]]&lt;/div&gt;</summary>
		<author><name>LMA</name></author>	</entry>

	</feed>