Jump to: navigation, search

Entry Points & Use Cases (Admin Tool)

Wiki Under Construction Start.PNG

Entry Points

To display various data in the Admin Tool, we have the following Entry Points with Use Cases under them:

00 - All Important

Under Entry Point 00 - All Important are the following Use Cases:

  • All Icons: Displays all icons that have already been created / set up.”
  • Job Runs: Displays all jobs that have been initialized for all turnaround projects.
  • Turnaround Project: Shows all Turnaround Projects in the database. It is important for the execution of jobs.

01 - All Other

For the 01 - All Other Entry Point, its Use Cases show all Data, regardless of whether instances are Templates or belong to a Project or not. Under Entry Point 01 - All Other, there are the following Use Cases:

  • Activity Codes
  • Commissioning Codes
  • Commissioning Packages
  • Commissioning Tasks
  • Companies
  • Daily HSE
  • Daily Meetings
  • Equipment Groups
  • Equipment Types
  • Equipment’s
  • Execution Documents
  • Functional Locations
  • Functionalities
  • Material
  • Media
  • Notifications
  • Operations
  • Plants
  • Plot Plans
  • Predefined Filters
  • Predefined Views
  • Preparation Documents
  • Punchpoint Attachments
  • Punchpoints
  • Quick Access Items
  • Reports
  • Scope Change attachments
  • Scope Changes
  • Subsystems
  • Systems
  • Timesheets
  • Users
  • Workorders
  • Zones

02 - Templates

The Use Cases under this entry point are for displaying data that is only marked as a template. By default, there are already pre-made Use Cases for displaying template data, which are the following:

  • Activity Codes
  • Commissioning Codes
  • Equipment Group
  • Equipment Type
  • Functionalities
  • Users

Turnaround Project

Project-specific Entry Points

These entry points display data that belongs to the respective project. For example, if the TurnaroundProjectCreationJob is executed for a Turnaround Project, there will be a new Entry Point created for this Turnaround Project. All Use Cases under such an entry point only display instances belonging to this specific project. There is also a difference between the TA Project Entry Points and the 01 - All Other, in that the TA Project Entry Point has one more use case, the Turnaround Project Use Case. This use case displays only the Turnaround Project in which it has been opened.

Use Cases

Under this use case, it is possible to create icons, which can then be assigned to Contractors / Companies.

MatapIcons.png

To be able to upload a photo, the name and description properties must be filled out and press “Enter”. Then a double click has to be made on the instances "Icon" property (without a sign on the left side) and then on the button with the three dots. After that a Windows Explorer will open and a selection can be made for the desired image. When the selection is uploaded the icon field will be filled automatically and the last step is to save everything. The icon is now successfully created and could now be assigned to a contractor/company.

With the "Companies" use case we display all Companies/Contractors that are created in total (Entry Point 01 - All Other) or are linked to a specific project (Entry Points Turnaround Project).

Companies MATAP Picture.png

The assigning of custom icons to the company/contractor is also done here. This will be done by double-clicking on the "Icon" property shown in the picture below. After pressing the "three dots" button, a pop-up window will open and one of all available icons can be selected. Operations will automatically get the same custom icon after the selection is made.

Company Icon query.png

Under this use case, you can view and edit the root items (tiles) that are delivered to the clients.

The following Functionalities are displayed:

  • Commissioning Wallpaper
  • Communication
  • Daily HSE
  • Daily Meetings
  • Plant Layouts
  • Precom
  • Punchpoints
  • Quick access
  • Reports
  • Scope Changes
  • Turnaround Wallpaper


You can also change the default Branch Download Configruation for every functionality. The corresponding properties are "Branchdownload Levels" and "Offline Sync Configuration". By default the auto branch download for Turnaround Wallpaper and Commissioning Wallpaper is enabled.


Functionalities

ORDERID & GROUPID

With these two properties, you can set the order (sorting) of the Functionalities (RootItems) on the client. See the SYSCLS SORTEDITEM and Sort Objects on Mobile Client articles for instructions on how to set up the sorting.


Visibility on Client

With this property, you can set the visibility of individual functionalities for the UWP and XAMARIN client. There are 5 options available that can be chosen:


  • Undefined
 undefined


  • Fully Visible
  UWP and XAMARIN users can see this functionality


  • Only Desktop
  Only Desktop (UWP) users can see this functionality


  • Only Mobile
  Only mobile users can see this functionality


  • Hidden
  No one can see this functionality


Based on these options you can control and change the visibility of the functionalities for different clients depending on the application use. If this property changes for a functionality, the user group rights are adjusted in the background, and only users who are in the groups that have the rights can then see the functionality on the client. The users must be added to one of the following groups in order to make the visibility of the functionalities applicable to them:

  • G1 General WallpaperWrite Group (UWP)
  • G30 General ReadProject Group (Xamarin).

For the "Turnaround Project" use case, we either display all projects ( See Entry Points => 00 - All Important ) or only the project for which replication has been performed ( See Entry Points => Turnaround Project ). In both cases, the following properties are displayed in the columns:

  • Archived
  • Backup Export Path
  • Create Timestamp
  • Critical delay buffer
  • Cultural Settings
  • Description
  • Document Export Path
  • Handover to Contractor Activity Code
  • Handover to Contractor Activity Code Order
  • Handover to Contractor Commissioning Code
  • Handover to Contractor Commissioning Code Order
  • Icon
  • Interface is active
  • Location
  • Name
  • Planned Project End
  • Planned Project Start
  • Planning Plant
  • Precom ready Activity Code
  • Precom ready Activity Code Order
  • Precom Ready Commissioning Code
  • Precom Ready Commissioning Code Order
  • Primavera Export Path
  • Project ID
  • Project Status
  • Project System Status
  • Project Type
  • Revision Codes
  • SAP Interface Is Active
  • SAP System
  • Scheduling Option
  • Show On Wallpaper
  • System
  • Show on Wallpaper
  • Timesheet decline limit
  • Update timestamp


Turnaround Project Use Case Columns Admin Tool.png

Project Status

This property allows you to define the status of the project.

It is important to note that the preparations for the Turnaround Project must be completed before changing the value of this property. Once all preparations are finalized (all jobs have been executed), the Admin Tool user must manually change this value to "Execution"; otherwise, the push will not work.

In the case of the Recalculate Project Job, the SAP Interface Is Active is also important.


There are 4 options available that can be chosen:

  • Preparation (initial value)
 - Here, the Excel files are imported, and the project is prepared.
 - The current scheduling from Primavera is retrieved and also imported.
 - Then the project can be assigned to a slot for testing. (Doesn't have to be live eg. push not active)


  • Execution
 - The project remains on the slot and can then be executed live on the wallpaper.
 - Changes are only allowed outside of service hours.


  • Aftercare
 - The project is removed from the slot but remains in the current MaTaP database for possible discussions, reports, etc.


  • Ready For Archive
 - The project can be moved to an archive database—it is no longer assigned to any slot.
 - If there is a backup of the database, it is stored in parallel to PROD with a .archive extension and can still be analyzed with the admin tool.

Show On Wallpaper

This property allows you to assign the project to a slot, which is displayed on the wallpaper at the client depending on the Matap context.

SAP Interface Is Active

This property allows you to control whether the SAP interface is active, i.e., whether SAP imports are enabled. As long as this property is set to active (true), the Recalculate Project Job cannot be executed.

Whitelist

We can configure, with the help of the whitelist, which columns we want to have/see for each use case in the Bulk Editor. This helps us to present our data more clearly. For the Use Cases provided via the system definitions, we already have defined Whitelists that can be adapted when needed.

Now we come to the configuration of the whitelist for a use case: 1. Open your UBIK.Studio. 2. Navigate to the following point: System => System.Matap => System.Matap.AdminTool => USE_CASE_ADMIN_TOOL_QUERY. 3. Open the USE_CASE_ADMIN_TOOL_QUERY in the Bulk Editor. 4. Open the use case whose columns you want to change in the Relation Editor. 5. Drag and drop the Meta Property which you want to have shown into the REL_COLUMN_WHITELIST Section and the configuration is done.

MP_PRELOAD

There is also the possibility to preload properties, and this can be set with “MP_PRELOAD”. Just check this, and the property where the “MP_PRELOAD” was set will be preloaded. This can be set individually for each property.


Wiki Under Construction End.PNG

Retrieved from "https://wiki.augmensys.com/index.php?title=Entry_Points_%26_Use_Cases_(Admin_Tool)&oldid=27516"