Wiki source code of Objektverwaltung

Last modified by YellowFox_RD on 2025/03/05 10:52

Hide last authors
YellowFox_RD 1.1 1 (% class="box" %)
Dominic Lippmann 4.1 2 (((
Dominic Lippmann 5.1 3 Table of Contents
Dominic Lippmann 4.1 4 )))
5
YellowFox_RD 1.1 6 {{toc/}}
7
Dominic Lippmann 5.1 8 The item management contains items and inventories, which does not have own locating hardware, but should be display on maps. This could be container, construction equipments, aso.
Dominic Lippmann 4.1 9
Dominic Lippmann 5.1 10 = Overview =
Dominic Lippmann 4.1 11
Dominic Lippmann 5.1 12 == What do i use the item management for? ==
Dominic Lippmann 4.1 13
Dominic Lippmann 5.1 14 In the module "Item management" you can access your items and group them. Furthermore you can get an overview about the history, or the whole "life" of your items, you can add entries or revise them. Under the tab profiles you organize the structur of your items.
15 Users having access to the item management on their displays, can change there item data (if these are marked as changeable). For instance a driver can set the status "loaded" and it will be send to the Yellowfox portal and all other displays with enabled item management.
Dominic Lippmann 4.1 16
Dominic Lippmann 5.1 17 == Common basics of the module ==
Dominic Lippmann 4.1 18
Dominic Lippmann 5.1 19 Items where described with profils. These contains fields of different data types, which can be set with values. These profiles are grouped and maintained in profile classes. The profile class "object types" is a special one, with the highest priority. 
20 Neither in profile definition nor in assigning to profile classes are restricted. You are free to set it up to your own ideas or business cases.
Dominic Lippmann 4.1 21
Dominic Lippmann 5.1 22 == Requirements ==
Dominic Lippmann 4.1 23
Dominic Lippmann 5.1 24 The access to item management can be booked as option. From this point of time on you can grant access to item management and to activities to each of your users in several right levels.
Dominic Lippmann 4.1 25
Dominic Lippmann 5.1 26 = Functions of Item management =
Dominic Lippmann 4.1 27
Dominic Lippmann 5.1 28 == Item Management ==
Dominic Lippmann 4.1 29
Dominic Lippmann 5.1 30 The Item management lists all the items of your company in a table. You can search and filter this list by items, item groups or assigned profiles.
Dominic Lippmann 4.1 31
Dominic Lippmann 5.1 32 |=(% colspan="3" %)Buttons:
33 |[[image:reload.png]]|//Reload table//|reload the table and refresh the contents
34 |[[image:newInventory.png]]|//Create new item//|opens the assistent guides you throug all steps to create a new item
35 |[[image:tmultiGroupAssign.png]]|//Assign selected items to a group//|assigns all selected items to a group
36 |[[image:multiInventoryDel.png]]|//Delete selected items//|deletes all selected items
YellowFox_RD 1.1 37
Dominic Lippmann 5.1 38 === Create new item ===
Dominic Lippmann 4.1 39
Dominic Lippmann 5.1 40 To create an item, at least one unique name must be defined. In addition, an item can also be connected directly to a NFC tag or a Bluetooth beacon. To do this, either the ID of the NFC tag or the MAC address on the beacon must be entered.
41 Such an item always uses the standard profile. This ensures that the item can always be displayed on the map. You can also change the profile at any time later and assign several profiles with different data.
Dominic Lippmann 4.1 42
Dominic Lippmann 5.1 43 === Inspect item ===
Dominic Lippmann 4.1 44
Dominic Lippmann 5.1 45 With this function you can get an overwiew about all data of this item. Furthermore you can see the latest location on map, if it is set and switch to edit mode directly. About the tab activities you can see the latest 15 activities of this item and switch to activity enquiries from there.
Dominic Lippmann 4.1 46
Dominic Lippmann 5.1 47 === Edit item ===
Dominic Lippmann 4.1 48
Dominic Lippmann 5.1 49 The edit function allows you to add to or correct all item data. The profiles containing the item properties can also be changed.
50 Please note: This function is primarily intended for correcting master data (e.g. size, weight, color, ...). If a new position or status is assigned to an item in this way, there is no driver assignment who set this value.
51 Copy item
52 With this function you can create a new item as a copy of the selected one.
Dominic Lippmann 4.1 53
Dominic Lippmann 5.1 54 === Delete item ===
Dominic Lippmann 4.1 55
Dominic Lippmann 5.1 56 You can delete an item. It's activities stay untouched and are not deleted.
Dominic Lippmann 4.1 57
Dominic Lippmann 5.1 58 == Item groups ==
Dominic Lippmann 4.1 59
Dominic Lippmann 5.1 60 Item groups are used to organize your items by building logical units or groups. One item can be member of several groups, as a regional group "East", as well as a data driven group "red container". The table item objects list all your groups and the assigned items. You can filter this list by group names or group members, means items.
Dominic Lippmann 4.1 61
Dominic Lippmann 5.1 62 |=(% colspan="3" %)Buttons:
63 |[[image:reload.png]]|//Reload table//|reload the table and refresh the contents
64 |[[image:newGroup.png]]|//Create new item group//|opens a window there you can setup a new group and already assign member items
65 |[[image:multiGroupDel.png]]|//Delete selected item groups//|all selected groups are being deleted
Dominic Lippmann 4.1 66
Dominic Lippmann 5.1 67 === Edit group ===
Dominic Lippmann 4.1 68
Dominic Lippmann 5.1 69 You can change the name of the group and add or remove member items
YellowFox_RD 1.1 70
Dominic Lippmann 5.1 71 === Delete group ===
Dominic Lippmann 4.1 72
Dominic Lippmann 5.1 73 This function is used to delete a item group. If this group has still member items you can remove this assignment or add all these items as members of another group. All other assignments of groups and items stay untouched.
Dominic Lippmann 4.1 74
Dominic Lippmann 5.1 75 == Acitivities ==
Dominic Lippmann 4.1 76
Dominic Lippmann 5.1 77 At this page you get an overview about all the acitvities of your items. You can literally view there whole "life". Please be aware that just entries are listed, which have changes in data related to activitiy data. This means changes in standing data does not influence this list. The icons of each activity shows the current state according to the profile and item configuration. When the entry is created by an order, these is linked too and you can view all order data from there.
78 Activities written in //italic //font mark the most current activitiy entry of each item, additionally the duration is starting with the word "since ..".
Dominic Lippmann 4.1 79
Dominic Lippmann 5.1 80 |=(% colspan="3" %)Buttons:
81 |[[image:LadeDaten.png]]|Load Data|trigger reload of table, after you changed filter or you want to reload
82 |[[image:Spaltenkonfiguration.png]]|Configure table columns|You can configure your table and show or hide columns according to your needs
Dominic Lippmann 4.1 83
YellowFox_RD 1.1 84 === Filter ===
Dominic Lippmann 4.1 85
Dominic Lippmann 5.1 86 ==== Time Range ====
Dominic Lippmann 4.1 87
Dominic Lippmann 5.1 88 You can filter your data by using preset data ranges, for instance to view the last 7 days. In addition you can choose your own range by using the calender fields. The first calender date is the date when you start using item management, in maximum 2 years back. The latest usable date is today.
Dominic Lippmann 4.1 89
Dominic Lippmann 5.1 90 ==== Report By ====
Dominic Lippmann 4.1 91
Dominic Lippmann 5.1 92 You can filter your entries by vehicles, drivers and items. These filter are adding each other. This means, if you choose vehicle A and driver B you will get all activities send by driver B while using vehicle A.
Dominic Lippmann 4.1 93
Dominic Lippmann 5.1 94 ==== Item field ====
Dominic Lippmann 4.1 95
Dominic Lippmann 5.1 96 You can filter by specific data of your items. First you choose a profile or item type. Then you get a list of datatypes belonging to them and according to this one, you choose your filter criteria. For a numeric field it could be "<", "<=", "=", ">=" oder ">". In this way you can filter by all items having the color "red" (if there is a detail "color", and you are using it).
Dominic Lippmann 4.1 97
Dominic Lippmann 5.1 98 ==== Load data ====
Dominic Lippmann 4.1 99
Dominic Lippmann 5.1 100 This button triggers the reload of your table using the filter criteria you setup.
Dominic Lippmann 4.1 101
Dominic Lippmann 5.1 102 === Create new activity ===
Dominic Lippmann 4.1 103
Dominic Lippmann 5.1 104 You can create new activities for your items. In this way you can setup entries, if setting it from display failed or has been forgotten to set by driver. The first possible date depends on date of creation of the item in the portal. You also can set up a driver and a vehicle, to assign them to this activity. 
105 If you used the item filter above, the item field is already filled. Otherwise you can choose it from the list. As soon you choose the date for the activity the item details are loaded and already set with the data are valid to this point of time. So you keep all data and change only the necessary one.
Dominic Lippmann 4.1 106
Dominic Lippmann 5.1 107 === Acitivity related actions ===
Dominic Lippmann 4.1 108
Dominic Lippmann 5.1 109 ==== Show on map ====
Dominic Lippmann 4.1 110
Dominic Lippmann 5.1 111 If there are location data available for this activity, you can show it on the map.
Dominic Lippmann 4.1 112
Dominic Lippmann 5.1 113 ==== Edit activity ====
Dominic Lippmann 4.1 114
Dominic Lippmann 5.1 115 You can edit or revise activities. A Revised activity is no new activities, it just replace the revised one. So you can adjust wrong timestamps from display or wrong bookings.
Dominic Lippmann 4.1 116
Dominic Lippmann 5.1 117 ==== Delete activitiy ====
Dominic Lippmann 4.1 118
Dominic Lippmann 5.1 119 Deletes this activity
Dominic Lippmann 4.1 120
Dominic Lippmann 5.1 121 ==== Show order details ====
Dominic Lippmann 4.1 122
Dominic Lippmann 5.1 123 If an activity is linked to an order, and data are booked in relation to this, you can get an overview about the order here and all bookings according to it.
Dominic Lippmann 4.1 124
Dominic Lippmann 5.1 125 ==== Show history ====
Dominic Lippmann 4.1 126
Dominic Lippmann 5.1 127 The history contains all changes and revisions to an item entry. It should answer the question: Who set this entry, at what time?"
Dominic Lippmann 4.1 128
Dominic Lippmann 5.1 129 == Profiles & Profile groups ==
Dominic Lippmann 4.1 130
Dominic Lippmann 5.1 131 Profile groups are at Yellowfox the highest level in item hierarchie. They define what a profile is used for, There is already the group "item types", grouping all profiles which describe item types as "container", "construction machines" or "vehicles". Furthermore there are the profile groups for additions. These can be splitted in several logical groups. You refind this order in the item editor, where each group is shown in an own page.
132 Profiles are the basic structur of your items. In profiles you define the data, representing your item. Each profile can contain as much detail fields as you need. These can be of different data types. Currently following types are possible:
Dominic Lippmann 4.1 133
Dominic Lippmann 5.1 134 |=Data type|=Content|=Options|=Example
135 |List|a list of values| |state -> "Loaded", "Set up", "Ready for loading"
136 |Yes/No|boolean values| |Full -> "Yes", "No"
137 |Text|free text| |checked by -> "F. Smith"
138 |Integer|integer (no floating points)|data unit|weight -> "5", unit -> "lb"
139 |Floating point|floating point with up to 4 decimal places|data unit, decimal places|weight -> "5.5", unit -> "lb", decimals -> "3"
140 |Date|date| |next check -> "01.06.2018"
141 |Time|time| |pause to -> "13:00"
142 |Date/Time|date and time| |last check -> "01.06.2018 16:24"
YellowFox_RD 1.1 143
Dominic Lippmann 5.1 144 === Profile groups ===
Dominic Lippmann 4.1 145
Dominic Lippmann 5.1 146 On this page you can get an overwiew about all your group levels, profile groups and the assigned profiles, as well as the amount of items using the profile.
Dominic Lippmann 4.1 147
Dominic Lippmann 5.1 148 |=(% colspan="3" %)Buttons:
149 |[[image:newProfileGroup.png]]|New profile group|create a new profile group
150 |[[image:reorderProfileGroup.png]]|Reorder profile groups|change the order of your profile groups
YellowFox_RD 1.1 151
Dominic Lippmann 5.1 152 ==== New profile group ====
Dominic Lippmann 4.1 153
Dominic Lippmann 5.1 154 You can create new profile groups, by giving an unique description and defining a group level. You can choose between setting it to a new level or add it to an existing one, for instance "item types". In the table below you see the current order within this level and can reorder by drag and drop the symbol. Your current group is highlighted in "**black**".
Dominic Lippmann 4.1 155
Dominic Lippmann 5.1 156 ==== Reorder profile groups ====
Dominic Lippmann 4.1 157
Dominic Lippmann 5.1 158 With this function you can change the order of all your groups and move them between levels.
Dominic Lippmann 4.1 159
Dominic Lippmann 5.1 160 ==== Edit profile group ====
Dominic Lippmann 4.1 161
Dominic Lippmann 5.1 162 You can use this function to change the group name or move it to another level. In the table below you see the current order within this level and can reorder by drag and drop the symbol. Your current group is highlighted in "**black**".
Dominic Lippmann 4.1 163
Dominic Lippmann 5.1 164 ==== Delete profile group ====
Dominic Lippmann 4.1 165
Dominic Lippmann 5.1 166 If your group still contains profiles you can move them to another one before deleting the group. Deleting a profile group cannot be undone.
Dominic Lippmann 4.1 167
Dominic Lippmann 5.1 168 === Profiles ===
Dominic Lippmann 4.1 169
Dominic Lippmann 5.1 170 On this page you get an overview about all your profiles and the assigned items.
Dominic Lippmann 4.1 171
Dominic Lippmann 5.1 172 |=(% colspan="3" %)Buttons:
173 |[[image:newProfile.png]]|Create new profile|create a new profile
174 |[[image:reorderProfiles.png]]|Reorder profiles|change the order of the profiles within there groups
YellowFox_RD 1.1 175
Dominic Lippmann 5.1 176 ==== Create new profile ====
Dominic Lippmann 4.1 177
Dominic Lippmann 5.1 178 An assistent guides you through all steps for creating a new profiles. Common data as description and profile data are recorded. Furthermore you define your details, by setting an description and a data type.
179 According to this, there are additional data necessary you have to set:
Dominic Lippmann 4.1 180
YellowFox_RD 1.1 181 (((
Dominic Lippmann 5.1 182 * Mandantory: These data have to be set for each item
183 * Standing data: Standing data means these data changes almost never, for instance a weight of an item or the color. If you want to change these data, you enter the item editor. On the opposite there are fields generating activities. Usually these are fields as states or (fluid) levels. Each data change of this data is a new activity. You can change these fields in the item editor too, for instance when creating a new item. In this case the current timestamp is used.
184 * Show on display: Maybe you don't want to share financial data from your "lean" profile. Only fields with this flag will be send to display. If you set this flag at no detail in each profile, the whole item is not displayed there.
185 If the options standing data and show on display are set, you can see them, but not change them there.
YellowFox_RD 1.1 186 )))
Dominic Lippmann 4.1 187
Dominic Lippmann 5.1 188 ==== Reorder profiles ====
Dominic Lippmann 4.1 189
Dominic Lippmann 5.1 190 You can reorder your profiles and order them by relevance. These order is used in item editor for instance. With this function you also can move profiles to another profile group.
Dominic Lippmann 4.1 191
Dominic Lippmann 5.1 192 ==== Edit profiles ====
Dominic Lippmann 4.1 193
Dominic Lippmann 5.1 194 In the profile editor you are guided step by step and can change, delete or revise all data and details of your profile. Data types of already existing details cannot be changed.
Dominic Lippmann 4.1 195
Dominic Lippmann 5.1 196 ==== Move items ====
Dominic Lippmann 4.1 197
Dominic Lippmann 5.1 198 The move items function allows to move all items to another profile. You choose your target and all details of it are loaded. If the target field has the same data type, you can choose which data you want to move to which field in the new profile. 
199 If you have mapped everything you can move all items to the new profile.
Dominic Lippmann 4.1 200
Dominic Lippmann 5.1 201 ==== Delete profiles ====
Dominic Lippmann 4.1 202
Dominic Lippmann 5.1 203 With this function you can delete profiles. If there are still items assigned or using this profile you can move them to a new one in the next step, similiar to the function "Move items"