The {{UBIK}} Console project allows a user to interact with UBIK via C# script-code.

== Concept ==
C# code will be interpreted like script code. This script can be either loaded from file and executed at start up or directly typed into a console window. When starting up the console it will automatically execute some common using statements in order to comfortably with code from these assemblies: System, UBIK, UBIK.Kernel, System.Collections.Generic, UBIK.Dynamic, System.Linq. If you need other namespaces you need to load them in your code.

[[File:UBIK.Console.PNG|500px|]]

== Using the console ==
As UBIK.Console is a command line application without any graphical user interface, it can be started in two ways:
* Start UBIK.Console.exe which will open a commandline interface
* Start directly out of a windows command line (e.g. powershell or cmd.exe)

=== Mono and Roslyn ===
The console can either execute using Roslyn or Mono. By typing ''#mono'' or ''#roslyn'' you can switch between these engines. The default is Roslyn.

== Example using Script file to connect to a Database ==
<source lang=csharp>
>//build up a connection to a UBIK database
>var demo = new UBIKEnvironmentConnection("Data Source = AUGLNZ2SQL2016; Initial Catalog = UBIK.DEMO.262; Persist Security Info = True; User ID = sa; Password = ****");
//Connecting ('Data Source=AUGLNZ2SQL2016;Initial Catalog=UBIK.DEMO.262;Persist Security Info=True;User ID=sa;Password=********')
//Database version: 2.6.2.0
//Kernel version: 2.6.0.0
//Customizing version: 2.6.215
//Session mgmt. type: SingleLocal_Management
//USAM ignored.
//bma (AUGBMA02) now connected to 'UBIK.DEMO.262'.

>//get one of the metaclasses
>var metaclassOfPump = demo.Environment.UBIKDataFactory().MetaClass(new Guid("b81a9d31-03b2-4dbd-91aa-b62c499011f7"));

>//find a content object (e.g. the first one with the name "PU212")
>var myFavouritePump = metaclassOfPump.AllInstances("PU212").FirstOrDefault();

>//show all interesting propertyvalues
>foreach(var prop in myFavouritePump.Properties.Where(p => p.DisplayValue() != "")) //%
>{ //%
> Console.WriteLine("//{0} = {1}", prop.Description, prop.DisplayValue()); //%
>}
//Shutdown finished = False
//RPM = 2920
//Flow rate = 68
//Nominal Diameter DN1 = 80
//Protection = II 2 G c TX
//Nominal Power (Process) = 55
//Static Head = 18
//Nominal Power (electrical) = 50
//Live RPM = (RPM)
//Live Flow = (Flow1)
//Height = 750
//Nominal Diameter DN2 = 60
//Nominal Pressure PN2 = 20
//Variable Frequency Drive = False
//Volt = 400
//Impeller Diameter = 120
//Nominal Pressure PN1 = 16
//Weight = 234
//Installation Level = 60
//Parent POI Group ID = DEMO_LEVEL_1 (Demo Level 1)
//Technical Status = 0
//Organisational Status = 0
//Type = KSB Kreiselpumpe
//Layer ID = ML_PUMP (Pumps)
//Position Number = A12345
//QR Code = PU212
//Order Number = SAP987456
//Barcode = PU212
//Marker ID = 2
//OCRText = PU212
//Weblink = http://www.augmensys.com
//Progress = 50
//Manufacturer = KSB AG
//Weight = 6
//Maintenance finished = False
//Geo data = 46,6152954101563;14,2624282836914;0
//Scan = PU212
//SAP-ID = 210100092
//Namespace = DemoHL
//Name = PU212
//Description = Effluent Discharge Pumpx
//Created on = 22.07.2013 14:43:20
//Delete status = 0
//UTS = 27.11.2018 17:18:33
//Update session = MHM@unknown device -- 27.11.2018 10:40:13
//Version = 983
>
>
</source>

== Example using Script file to connect to a UBIK Web Service==
<source lang=csharp>
>var demo = new UBIKServiceConnection("console", "ubik", "*****", "APP_DEMO", "CXT_DEMO", "https://52.178.138.55:777/UBIK/DEMO.250/Usam/USAM.svc/SOAP", "https://52.178.138.55:777/UBIK/DEMO.250/Content/UBIKContent.svc/SOAP");
>var rootObjects = demo.GetRoot();
Fetching root objects.
Fetching token for 'ubik@console' from 'https://52.178.138.55:777/UBIK/DEMO.250/Usam/USAM.svc/SOAP'.
ok (105 ms).
Service request delivered 4 objects (218 ms).
>@"\\" + string.Join(", ", rootObjects.Select(item => item.DisplayStrings[0]))
\\Plant, Inspection, Playground, Commissioning
</source>

== Example using Script file ==
In order to execute a C# script file using the {{UBIK}} Console you need execute the UBIK.Console.exe using the ''-cmdfile'' parameter. If you add the ''-connectionstring'' parameter as shown in the example the console will instantiate UBIKEnvironmentConnection variable called ''ubikEnvironmentConnection''. This variable is then accessible in your script and can be used. Also the current customizing assembly will be added to the script.
<source lang="powershell">
UBIK.Console.exe -cmdfile "\\PathToScript\script.txt" -connectionstring "Data Source = ...; Initial Catalog = ...; User ID = ...; Password = ..."
</source>

The following script code is taken from the example script file and shows how to work with {{UBIK}} Console via script file. If you store these six lines to a text file you can directly run it. In line one a new dependency is loaded, namely the [http://wiki.augmensys.com/index.php?title=UBIK_DBTool DBTool]. Line two creates a SqlConnectionStringBuilder in order to work comfortably with the connectionstring provided by ubikEnvironmentConnection. Line four calls a method from the customizing assembly which has been loaded by the console for us as mention earlier. Line 6 uses the DBTool project and creates a backup of the database.
<source lang="xml">
1. #r "C:\\Users\\cle\\Documents\\Dev\\UBIK.Server\\Branches\\2.6\\UBIK.Console\\bin\\Debug\\DBTool.exe"
2. System.Data.SqlClient.SqlConnectionStringBuilder scsb = new System.Data.SqlClient.SqlConnectionStringBuilder(ubikEnvironmentConnection.ConnectionString);
3. string backUpDir = @"C:\SQL\bakup";
4. bool isTrue = UBIK.Runtime.WorkflowUtility.Str2Bool("1");
5. System.Console.WriteLine(isTrue.ToString());
6. DBTool.MSSQLTools.BackupDatabase(scsb.DataSource, scsb.UserID, scsb.Password, false, scsb.InitialCatalog, bak: string.Format(@"{0}\{1}_{2}_{3}.bak", backUpDir, scsb.InitialCatalog, DateTime.Now.ToString("yyyyMMdd"), DateTime.Now.ToString("HHmm")));
</source>

== CmdLine ==

[[File:CmdLine.Execute.PNG]]

== PwdTool ==
If you do not want to type in your password in plain text you can first generate an encrypted password by executing Pwd.Encrpyt in the {{UBIK}} Console.

[[File:PwdTool.Encrypt.PNG]]

[[Category:FAQ|UBIK Console]]

2018-11-30T13:56:10Z

BMA:

The {{UBIK}} Console project allows a user to interact with UBIK via C# script-code.

== Concept ==
C# code will be interpreted like script code. This script can be either loaded from file and executed at start up or directly typed into a console window. When starting up the console it will automatically execute some common using statements in order to comfortably with code from these assemblies: System, UBIK, UBIK.Kernel, System.Collections.Generic, UBIK.Dynamic, System.Linq. If you need other namespaces you need to load them in your code.

[[File:UBIK.Console.PNG|500px|]]

== Using the console ==
As UBIK.Console is a command line application without any graphical user interface, it can be started in two ways:
* Start UBIK.Console.exe which will open a commandline interface
* Start directly out of a windows command line (e.g. powershell or cmd.exe)

=== Mono and Roslyn ===
The console can either execute using Roslyn or Mono. By typing ''#mono'' or ''#roslyn'' you can switch between these engines. The default is Roslyn.

<source lang=csharp>
>//build up a connection to a UBIK database
>var demo = new UBIKEnvironmentConnection("Data Source = AUGLNZ2SQL2016; Initial Catalog = UBIK.DEMO.262; Persist Security Info = True; User ID = sa; Password = ai#2011");
Connecting ('Data Source=AUGLNZ2SQL2016;Initial Catalog=UBIK.DEMO.262;Persist Security Info=True;User ID=sa;Password=********')
Database version: 2.6.2.0
Kernel version: 2.6.0.0
Customizing version: 2.6.215
Session mgmt. type: SingleLocal_Management
USAM ignored.
bma (AUGBMA02) now connected to 'UBIK.DEMO.262'.

>//get one of the metaclasses
>var metaclassOfPump = demo.Environment.UBIKDataFactory().MetaClass(new Guid("b81a9d31-03b2-4dbd-91aa-b62c499011f7"));

>//find a content object (e.g. the first one found containing "PU212"
>var myFavouritePump = metaclassOfPump.AllChilds().First(p => p.DisplayString.Contains("PU212"));

>//show all propertyvalues
>foreach(var prop in myFavouritePump.Properties) //%
>{ //%
> Console.WriteLine("{0} = {1}", prop.Description, prop.DisplayValue()); //%
>}

Shutdown finished = False
RPM = 2920
Flow rate = 68
Nominal Diameter DN1 = 80
Protection = II 2 G c TX
Nominal Power (Process) = 55
Static Head = 18
Nominal Power (electrical) = 50
Live RPM = (RPM)
Live Flow = (Flow1)
Height = 750
Live Manz =
Nominal Diameter DN2 = 60
Nominal Pressure PN2 = 20
Variable Frequency Drive = False
Volt = 400
Impeller Diameter = 120
Nominal Pressure PN1 = 16
Extension Weller =
Weight = 234
ARMARKERID =
TRANSLATIONY =
Installation Level = 60
Parent POI Group ID = DEMO_LEVEL_1 (Demo Level 1)
Technical Status = 0
RFID Tag =
Organisational Status = 0
Type = KSB Kreiselpumpe
TRANSLATIONX =
Layer ID = ML_PUMP (Pumps)
ROTAIONY =
ISFACINGCAMERA =
Position Number = A12345
QR Code = PU212
ROTAIONZ =
Maintenance state =
ROTAIONX =
Order Number = SAP987456
Barcode = PU212
Marker ID = 2
OCRText = PU212
SCALEX =
ARMARKERSIDELENGTH =
Weblink = http://www.augmensys.com
Progress = 50
TRANSLATIONZ =
Manufacturer = KSB AG
Weight = 6
Maintenance finished = False
Geo data = 46,6152954101563;14,2624282836914;0
Visio group ID =
LK to Structure =
Scan = PU212
Order ID =
SAP-ID = 210100092
Namespace = DemoHL
Name = PU212
Description = Effluent Discharge Pumpx
Create Session =
Created on = 22.07.2013 14:43:20
Delete status = 0
UTS = 27.11.2018 17:18:33
Update session = MHM@unknown device -- 27.11.2018 10:40:13
Tenant =
Version = 983
>
</source>

== Example using Script file ==
In order to execute a C# script file using the {{UBIK}} Console you need execute the UBIK.Console.exe using the ''-cmdfile'' parameter. If you add the ''-connectionstring'' parameter as shown in the example the console will instantiate UBIKEnvironmentConnection variable called ''ubikEnvironmentConnection''. This variable is then accessible in your script and can be used. Also the current customizing assembly will be added to the script.
<source lang="powershell">
UBIK.Console.exe -cmdfile "\\PathToScript\script.txt" -connectionstring "Data Source = ...; Initial Catalog = ...; User ID = ...; Password = ..."
</source>

The following script code is taken from the example script file and shows how to work with {{UBIK}} Console via script file. If you store these six lines to a text file you can directly run it. In line one a new dependency is loaded, namely the [http://wiki.augmensys.com/index.php?title=UBIK_DBTool DBTool]. Line two creates a SqlConnectionStringBuilder in order to work comfortably with the connectionstring provided by ubikEnvironmentConnection. Line four calls a method from the customizing assembly which has been loaded by the console for us as mention earlier. Line 6 uses the DBTool project and creates a backup of the database.
<source lang="xml">
1. #r "C:\\Users\\cle\\Documents\\Dev\\UBIK.Server\\Branches\\2.6\\UBIK.Console\\bin\\Debug\\DBTool.exe"
2. System.Data.SqlClient.SqlConnectionStringBuilder scsb = new System.Data.SqlClient.SqlConnectionStringBuilder(ubikEnvironmentConnection.ConnectionString);
3. string backUpDir = @"C:\SQL\bakup";
4. bool isTrue = UBIK.Runtime.WorkflowUtility.Str2Bool("1");
5. System.Console.WriteLine(isTrue.ToString());
6. DBTool.MSSQLTools.BackupDatabase(scsb.DataSource, scsb.UserID, scsb.Password, false, scsb.InitialCatalog, bak: string.Format(@"{0}\{1}_{2}_{3}.bak", backUpDir, scsb.InitialCatalog, DateTime.Now.ToString("yyyyMMdd"), DateTime.Now.ToString("HHmm")));
</source>

== CmdLine ==

[[File:CmdLine.Execute.PNG]]

== PwdTool ==
If you do not want to type in your password in plain text you can first generate an encrypted password by executing Pwd.Encrpyt in the {{UBIK}} Console.

[[File:PwdTool.Encrypt.PNG]]

[[Category:Pages with broken file links|UBIK Console]]

UBIK Console

2018-11-30T13:55:46Z

BMA:

The {{UBIK}} Console project allows a user to interact with UBIK via C# script-code.

== Concept ==
C# code will be interpreted like script code. This script can be either loaded from file and executed at start up or directly typed into a console window. When starting up the console it will automatically execute some common using statements in order to comfortably with code from these assemblies: System, UBIK, UBIK.Kernel, System.Collections.Generic, UBIK.Dynamic, System.Linq. If you need other namespaces you need to load them in your code.

[[File:UBIK.Console.PNG|500px|]]

== Using the console ==
As UBIK.Console is a command line application without any graphical user interface, it can be started in two ways:
* Start UBIK.Console.exe which will open a commandline interface
* Start directly out of a windows command line (e.g. powershell or cmd.exe)

=== Mono and Roslyn ===
The console can either execute using Roslyn or Mono. By typing ''#mono'' or ''#roslyn'' you can switch between these engines. The default is Roslyn.

<source lang=C#>
>//build up a connection to a UBIK database
>var demo = new UBIKEnvironmentConnection("Data Source = AUGLNZ2SQL2016; Initial Catalog = UBIK.DEMO.262; Persist Security Info = True; User ID = sa; Password = ai#2011");
Connecting ('Data Source=AUGLNZ2SQL2016;Initial Catalog=UBIK.DEMO.262;Persist Security Info=True;User ID=sa;Password=********')
Database version: 2.6.2.0
Kernel version: 2.6.0.0
Customizing version: 2.6.215
Session mgmt. type: SingleLocal_Management
USAM ignored.
bma (AUGBMA02) now connected to 'UBIK.DEMO.262'.

>//get one of the metaclasses
>var metaclassOfPump = demo.Environment.UBIKDataFactory().MetaClass(new Guid("b81a9d31-03b2-4dbd-91aa-b62c499011f7"));

>//find a content object (e.g. the first one found containing "PU212"
>var myFavouritePump = metaclassOfPump.AllChilds().First(p => p.DisplayString.Contains("PU212"));

>//show all propertyvalues
>foreach(var prop in myFavouritePump.Properties) //%
>{ //%
> Console.WriteLine("{0} = {1}", prop.Description, prop.DisplayValue()); //%
>}

Shutdown finished = False
RPM = 2920
Flow rate = 68
Nominal Diameter DN1 = 80
Protection = II 2 G c TX
Nominal Power (Process) = 55
Static Head = 18
Nominal Power (electrical) = 50
Live RPM = (RPM)
Live Flow = (Flow1)
Height = 750
Live Manz =
Nominal Diameter DN2 = 60
Nominal Pressure PN2 = 20
Variable Frequency Drive = False
Volt = 400
Impeller Diameter = 120
Nominal Pressure PN1 = 16
Extension Weller =
Weight = 234
ARMARKERID =
TRANSLATIONY =
Installation Level = 60
Parent POI Group ID = DEMO_LEVEL_1 (Demo Level 1)
Technical Status = 0
RFID Tag =
Organisational Status = 0
Type = KSB Kreiselpumpe
TRANSLATIONX =
Layer ID = ML_PUMP (Pumps)
ROTAIONY =
ISFACINGCAMERA =
Position Number = A12345
QR Code = PU212
ROTAIONZ =
Maintenance state =
ROTAIONX =
Order Number = SAP987456
Barcode = PU212
Marker ID = 2
OCRText = PU212
SCALEX =
ARMARKERSIDELENGTH =
Weblink = http://www.augmensys.com
Progress = 50
TRANSLATIONZ =
Manufacturer = KSB AG
Weight = 6
Maintenance finished = False
Geo data = 46,6152954101563;14,2624282836914;0
Visio group ID =
LK to Structure =
Scan = PU212
Order ID =
SAP-ID = 210100092
Namespace = DemoHL
Name = PU212
Description = Effluent Discharge Pumpx
Create Session =
Created on = 22.07.2013 14:43:20
Delete status = 0
UTS = 27.11.2018 17:18:33
Update session = MHM@unknown device -- 27.11.2018 10:40:13
Tenant =
Version = 983
>
</source>

== Example using Script file ==
In order to execute a C# script file using the {{UBIK}} Console you need execute the UBIK.Console.exe using the ''-cmdfile'' parameter. If you add the ''-connectionstring'' parameter as shown in the example the console will instantiate UBIKEnvironmentConnection variable called ''ubikEnvironmentConnection''. This variable is then accessible in your script and can be used. Also the current customizing assembly will be added to the script.
<source lang="powershell">
UBIK.Console.exe -cmdfile "\\PathToScript\script.txt" -connectionstring "Data Source = ...; Initial Catalog = ...; User ID = ...; Password = ..."
</source>

The following script code is taken from the example script file and shows how to work with {{UBIK}} Console via script file. If you store these six lines to a text file you can directly run it. In line one a new dependency is loaded, namely the [http://wiki.augmensys.com/index.php?title=UBIK_DBTool DBTool]. Line two creates a SqlConnectionStringBuilder in order to work comfortably with the connectionstring provided by ubikEnvironmentConnection. Line four calls a method from the customizing assembly which has been loaded by the console for us as mention earlier. Line 6 uses the DBTool project and creates a backup of the database.
<source lang="xml">
1. #r "C:\\Users\\cle\\Documents\\Dev\\UBIK.Server\\Branches\\2.6\\UBIK.Console\\bin\\Debug\\DBTool.exe"
2. System.Data.SqlClient.SqlConnectionStringBuilder scsb = new System.Data.SqlClient.SqlConnectionStringBuilder(ubikEnvironmentConnection.ConnectionString);
3. string backUpDir = @"C:\SQL\bakup";
4. bool isTrue = UBIK.Runtime.WorkflowUtility.Str2Bool("1");
5. System.Console.WriteLine(isTrue.ToString());
6. DBTool.MSSQLTools.BackupDatabase(scsb.DataSource, scsb.UserID, scsb.Password, false, scsb.InitialCatalog, bak: string.Format(@"{0}\{1}_{2}_{3}.bak", backUpDir, scsb.InitialCatalog, DateTime.Now.ToString("yyyyMMdd"), DateTime.Now.ToString("HHmm")));
</source>

== CmdLine ==

[[File:CmdLine.Execute.PNG]]

== PwdTool ==
If you do not want to type in your password in plain text you can first generate an encrypted password by executing Pwd.Encrpyt in the {{UBIK}} Console.

[[File:PwdTool.Encrypt.PNG]]

[[Category:Pages with broken file links|UBIK Console]]

2018-01-10T09:01:00Z

BMA: /* Client */

Hierarchy Filtering allows the UBIK data designer to provide filter rules for the global object hierarchy on the client. For example, if a user wants to see all objects having the color green and a certain progress value, we have to create hierarchy filter rules - only allowing to view filterable objects that meet both of these criteria. When the filter is applied, objects that do not meet the criteria will be invisible. This means they will not be seen when browsing through the data and not even be found when doing queries or search operations. The designer can decide which objects are affected by the filtering by declaring objects as [[SYSCLS_HIERARCHYFILTERABLE|hierarchy filterable]] objects. These will be filtered based on the defined criteria. In addition, the designer can also declare objects to be [[SYSCLS_HIERARCHYFILTERABLE|hierachy filterable folder]] objects. These objects are filtered depending if there is visible content inside the data branch beneath this object. By defining these objects and rules, it is possible to thin out whole data branches depending on filter rules.

{{Template:HowTo/Begin}}

= Studio =

* declare the metaclasses to be filtered with the [[SYSCLS_HIERARCHYFILTERABLE|hierarchy filterable classification]].
* declare the metaclasses to be used as filterable folder objects with the [[SYSCLS_HIERARCHYFILTERABLEFOLDER|hierarchy filterable folder classification]].
* objects that should not be affected by the filtering do not have any of both classifications.

= Client =

* Define a preset file containing the property names of the filter criteria. Place it in the local databse directory ({AppData}\LocalState\Databases\<Profile or Project name>\<Profile or Project name>.hfpreset). One filter setting consists of the Property ID to be filteres, and the level of filtering for this property, which is relevant when composing filter rules in the UI. The following paramaters can be defined:
* list of settings (one per property)
* each setting contains:
** property name
** property level
** default matching mode
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<HierarchyFilterPreset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<HierarchyFilterSettings>
<HierarchyFilterSetting>
<PropertyName>MP_DESCRIPTION</PropertyName>
<PropertyDescription>Description</PropertyDescription>
<Level>0</Level>
<DefaultMode>StartsWith</DefaultMode>
</HierarchyFilterSetting>
<HierarchyFilterSetting>
<PropertyName>MP_BRAND</PropertyName>
<PropertyDescription>Brand</PropertyDescription>
<Level>1</Level>
<DefaultMode>Equals</DefaultMode>
</HierarchyFilterSetting>
<HierarchyFilterSetting>
<PropertyName>MP_MODEL</PropertyName>
<PropertyDescription>Model</PropertyDescription>
<Level>2</Level>
<DefaultMode>Equals</DefaultMode>
</HierarchyFilterSetting>
</HierarchyFilterSettings>
</HierarchyFilterPreset>
</source>

* Define one or more profiles for filtering. Create files having the extension ("*.hfprofile"). A filter rule consists of the property id, the value to be compared and a comparison mode (StartsWith, Equals).
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<HierarchyFilterRulesProfile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Name>HF_CUSTOM_01</Name>
<IsDefault>true</IsDefault>
<HierarchyFilterRules>
<HierarchyFilterRule>
<PropertyName>MP_DESCRIPTION</PropertyName>
<Value>PUMP</Value>
<Mode>StartsWith</Mode>
</HierarchyFilterRule>
<HierarchyFilterRule>
<PropertyName>MP_BRAND</PropertyName>
<Value>MÜLLER</Value>
<Mode>Equals</Mode>
</HierarchyFilterRule>
<HierarchyFilterRule>
<PropertyName>MP_MODEL</PropertyName>
<Value>SUPER</Value>
<Mode>StartsWith</Mode>
</HierarchyFilterRule>
</HierarchyFilterRules>
</HierarchyFilterRulesProfile>
</source>
{{Template:HowTo/End}}

==See also==


[[Category:How-To|Configure Hierarchy Filtering]]
[[Category:WinX|Configure Hierarchy Filtering]]

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:23:28Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

MRO Objects (Client)

2017-12-05T11:22:20Z

BMA: /* Organisational Status */

[[File:UI_WinX_MRO_ChildList.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===
[[File:UI_WinX_MRO_TechnicalStatusIndicator.png|thumb|Technical Status Indicator (WinX)]]
The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

=== Organisational Status ===
The organisational status indicator is shown on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch. This indicator shows the amount of confirmed work done in the data branch. It can as well display a work package to be already confirmed or show tasks that are already locked by their owning workpackage.
<gallery>
File:UI_WinX_MRO_OrganisationalStatusIndicator.png|Organisational Status Indicator (WinX)
File:UI_WinX_MRO_WPConfirmedIndicator.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
</gallery>

[[Category:Pages with broken file links|MRO Objects (UBIK WinX)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== Work Progress ===
[[File:UI_WinX_MRO_WorkProgressIndicator.png|thumb|MRO Work Progress Indicator (WinX)]]
The work progress is shown on all objects that represent the current work progress or receive the work progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:UI_WinX_MRO_WPConfirmButton.png|MRO Workpackage confirm button (WinX)
File:UI_WinX_MRO_WPRevokeConfirmButton.png|MRO Workpackage revoke confirmation button (WinX)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====
[[File:UI_WinX_MRO_ChildItemMeasurementTask_Empty.png|thumb|Measurement Task without a reported value (WinX)]]
[[File:UI_WinX_MRO_ChildItemMeasurementTask.png|thumb|Measurement Task with a reported value (WinX)]]
A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

==== Progress Task ====
[[File:UI_WinX_MRO_ProgressTask.png|thumb|Progress Task with a reported work progress (WinX)]]
[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

==== Check Task ====
[[File:UI_WinX_MRO_CheckTask.png|thumb|Unfinished MRO CheckTask (WinX)]]
A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

==== Inspection Task ====
[[File:UI_WinX_MRO_InspectionTask.png|thumb|Finished MRO InspectionTask (WinX)]]
[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

=== MRO objects with project information {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}

== See also ==
* [[MRO (Plugin)]]

[[Category:WinX|MRO Objects (UBIK WinX)]]

MRO Objects (Client)

2017-12-05T11:21:59Z

BMA:

[[File:UI_WinX_MRO_ChildList.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===
[[File:UI_WinX_MRO_TechnicalStatusIndicator.png|thumb|Technical Status Indicator (WinX)]]
The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

=== Organisational Status ===
The organisational status indicator is shown on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch. This indicator shows the amount of confirmed work done in the data branch. It can as well display a work package to be already confirmed or show tasks that are already locked by their owning workpackage.
<gallery>
File:UI_WinX_MRO_OrganisationalStatusIndicator.png|Organisational Status Indicator (WinX)
File:http://wiki.augmensys.com/images/archive/7/77/20171205111948%21UI_WinX_MRO_WPConfirmedIndicator.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
</gallery>

=== Work Progress ===
[[File:UI_WinX_MRO_WorkProgressIndicator.png|thumb|MRO Work Progress Indicator (WinX)]]
The work progress is shown on all objects that represent the current work progress or receive the work progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:UI_WinX_MRO_WPConfirmButton.png|MRO Workpackage confirm button (WinX)
File:UI_WinX_MRO_WPRevokeConfirmButton.png|MRO Workpackage revoke confirmation button (WinX)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====
[[File:UI_WinX_MRO_ChildItemMeasurementTask_Empty.png|thumb|Measurement Task without a reported value (WinX)]]
[[File:UI_WinX_MRO_ChildItemMeasurementTask.png|thumb|Measurement Task with a reported value (WinX)]]
A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

==== Progress Task ====
[[File:UI_WinX_MRO_ProgressTask.png|thumb|Progress Task with a reported work progress (WinX)]]
[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

==== Check Task ====
[[File:UI_WinX_MRO_CheckTask.png|thumb|Unfinished MRO CheckTask (WinX)]]
A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

==== Inspection Task ====
[[File:UI_WinX_MRO_InspectionTask.png|thumb|Finished MRO InspectionTask (WinX)]]
[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

=== MRO objects with project information {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}

== See also ==
* [[MRO (Plugin)]]

[[Category:WinX|MRO Objects (UBIK WinX)]]

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:20:03Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:19:48Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:18:42Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:17:10Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:13:27Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

File:UI WinX MRO WPConfirmedIndicator.png

2017-12-05T11:13:20Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmedIndicator.png

File:UI WinX MRO WPConfirmButton.png

2017-12-05T11:12:15Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmButton.png

File:UI WinX MRO WPConfirmButton.png

2017-12-05T11:10:02Z

BMA: BMA uploaded a new version of File:UI WinX MRO WPConfirmButton.png