Bureaucrats, editor, Administrators
274
edits
Changes
Jump to navigation
Jump to search
MIB 3.0 Manual page (view source)
Revision as of 10:02, 27 September 2017
, 10:02, 27 September 2017Created page with "Category:O&M __TOC__ = Introduction to MIB 3.0 = MIB is the main management tool in TV Open Platform. It allows the operator to manage the entire platform: configuration..."
[[Category:O&M]]
__TOC__
= Introduction to MIB 3.0 =
MIB is the main management tool in TV Open Platform. It allows the operator to manage the entire platform: configurations, parameters, users, commercial offer, contents and much more.
In this new version, the tool has been completely redesigned in terms of user experience, adding a new design based on Google's material design and new features such as Edit in Lists, Bulk Edit, and more.
'''What's new in this version?'''
* Renewed UI
* Favorite search filters
* Search history
* Bulk Edit
* Clone items
* Edit in lists
* Lists columns management
* Favorite and History menu navigation
<br />
= MIB 3.0 commons =
== User Login page ==
[[File:UserLogin.png|right|thumb|User login page|400px]]
This page that allows you to authenticate in MIB with your credentials before entering in the system. <br />
You will be requested to type the '''username''' and '''password''' fields; If the login and password match, the login will be successful and you will be logged and go to your MIB home page. The login request are sent in a secure way, through POST and HTTPs, hiding the user login and password from a third party. <br />
<br />
There is also a '''Keep me logged in''' checkbox to allow the browser to remember the token and allow you to maintain logged for longer time, until the session expires or you perform logout.
<br clear=all> <br />
[[File:LoginCaptcha.png|400px|left|thumb|Captcha is requested when the user has typed the password wrong several times]]
<big>'''Wrong user/password'''<br /></big>
When you type a wrong username and/or password, MIB will show an an error alert with a message specifying the source of the error. You will be able to try again in case you made a mistake.
<br />
<br />
<br />
<big>'''Captcha validation'''</big><br />
A Captcha will be shown after several unsuccessful login attempts (up to 5). Then you will have then to fill the captcha field with the correct code or the login will continue failing even if the password is correct. This is done to avoid computer brute force attacks.
<br clear=all>
<br />
[[File:LoginPasswordExpired.png|400px|left|thumb|Dialog to type a new password when it has expired]]
<big>'''Password expiration'''<br /></big>
Some users might have configured password expiration (see [[MIB_Users_Page_Manual_3.0|MIB User Management]]) during user provisioning. In that case, you will be requested to change their password every 60 days.
<br /><br />
When your password has expired, you will be prompted upon a correct login request with a dialog to type the new password. Then you will have to provide the '''old password''' and the '''new password''' twice. If the new passwords mismatch or the old password is wrong, MIB will show an error.
<br /><br />
Also, the new password will have to follow a determined regex patter (which is defined in a configuration file). Currently, the password must be at least 8 chars long and must contain at least one capital letter, one number and one special character.
<br clear=all>
<br />
[[File:UserForgotPassword.png|400px|right|thumb|Forgot your password?]]
<big>'''Forgot my password'''</big><br />
In case you have forgotten your password, there is a password retrieval option in the login page, that will allow you to request a recovery email containing a secure link to generate a new password for you. <br />
<br />
To do this, you will have to type in the same email that is associated to your account and press '''Send recovery email button'''. Then a new [File:PasswordRecoveryEmailSent.png|menu] will be shown asking you to type the same email that was associated to his account and a password retrieval email will be sent. <br />
<br />
In the password retrieval email, you will get a link that will take him to a password recovery page where will be able to type in a new password. Once the password has been typed correctly (twice), your password will be changed to this new password provided.
<br clear=all>
<br />
== User Profile page ==
This page allows you to manage the information and settings associated to your account, update your profile picture or change your password.
[[File:UserProfileDropDown.png|left|150px]] To access this page, go to the top-right corner of the page; under the profile picture there is a drop down menu and then select the '''Edit Profile''' option.<br clear=all><br />
In this page, you will be able to perform several actions. Once done, press [[File:SAVEAuthButton.png|middle|40px]] button to apply your changes.<br /><br />
[[File:UserProfilePage.png|right|450px|thumb|User Profile page]]
'''<big>Update profile picture</big>'''<br />
Allows you to provide an updated profile picture. Hover on the current picture to select a new one.
<br />
<br />
'''<big>Update user information</big>'''<br />
Allows you to update your '''Full Name''', '''Email''' (required for password retrieval), '''Company''' and '''Timezone'''.
<br />
<br />
'''<big>Change password</big>'''<br />
Allows you to change your password. For this, you will have to provide your current password and the new password twice.
<br />
<br />
[[File:LogoutButton.png|middle|80px]] Allows you to logout from MIB3.
<br />
<br />
[[File:BackToAppButton.png|middle|80px]] Allows you to go back to MIB3.
<br />
<br clear=all><br />
<br />
<br />
== Main Menu ==
The main menu is a collapsable menu that can be accessed by clicking in the top left corner of the page [[File:MenuIcon.png|middle|25px]]<br />
The menu can be hidden by clicking again in the top left corner of the page [[File:HideIcon.png|middle|25px]]<br />
[[File:LateralMenu.png|left|300px|thumb|Main Menu]]
<br />
Once open, it shows the different menu items. You can navigate over the different menu items and expand [[File:ExpandIcon.png|middle|25px]] or collapse [[File:CollapseIcon.png|middle|25px]] them to access sub-menus that are contained in the main categories. You will only be able to access to those menus where you have permissions<br />
The complete list of menu items can be found in the [[#MIB 3.0 pages|MIB 3.0 pages section]].
<br />
<br />
'''[[File:SearchMenuIcon.png|middle|25px]] <big>Search Menu Bar</big>'''<br />
It allows you to search for specific menu items without having to navigate to them. Just type in the bot the menu name and the different menus that match your search will be returned.
<br />
<br />
'''[[File:HomeIcon.png|middle|25px]] <big>Home</big>'''<br />
The Home menu allows you to easily go to your MIB home page. For now, this page will be a pre-configure page associated to your profile, but in the future will be replaced by a custom home page with some useful information and statistics.
<br />
<br />
'''[[File:HistoryIcon.png|middle|25px]] <big>Navigation History</big>'''<br />
The History menu item allows you to browser over the last five menus that you have recently visited. To navigate back to any of them, just click on them and you will be redirected.
<br />
<br />
'''[[File:FavoritesIcon.png|middle|25px]] <big>Favorite Menus</big>'''<br />
The Favorite Menus item allows you to browser over your favorite menus. The user is able to favorite and unfavorite menus by clicking in the favorite star next to the menu title in the Navigation Bar.
<br />
[[File:NavigationBar.png|200px]]
<br />
<br clear=all><br />
<br />
== List Pages ==
When you access to a menu, you will first arrive to the List Page, where you will be able to browse over the menu items you have access to (for example, the list of movies). The access to the different items on the list is controlled through the Source field. You will only be able to access those items that belong to the Sources where you have access.
[[File:MIB3List.png|center|800px|thumb|Main Menu]]
<br />
In this menu, you are able to do several actions which are described in the following sections.
<br />
=== Paging ===
The items displayed in list are divided in pages. At the bottom of the screen you have different information that allows you to navigate over the different pages:
<br clear=all><br />
[[File:ListTotalNumber.png|300px|left|thumb|Current page and total number of results]]
[[File:ListJumpTo.png|300px|right|thumb|Jump to page action]]
First you can check the total number of items that this page has and the current page you are in.<br />
Also, you are able to select the number of results that will be returned per page, allowing you to select between 10 and 200 results per page.
You can also jump to a specific page number. Just type in the page number and click in the GO button.
<br clear=all>
You can also move between the different pages using the page navigation bar, where will be highlighted the current page number you are in:
* Click on the '''<''' button to go to the previous page
* Click on the '''>''' button to go to the next page
* Click on any of the Page numbers to jump directly to that specific page.
[[File:ListPaging.png|500px|center|thumb|Page Navigation bar]]
<br clear=all><br />
===[[File:EditColumsMib3.png|middle|40px]] Edit columns & reordering ===
[[File:Mib3ColumnsEdit.png|250px|right|thumb|Edit columns menu]]
The [[File:EditColumsMib3.png|middle|30px]] button allows you to select which columns will be displayed and their ordering. You can select up to any number of columns, but the minimum is two. If the number of columns exceeds the width of the page, an horizontal scroll will be added that will allow you to navigate to all the columns of the list<br />
: [[ File:CheckBox_Unchecked_3.png|middle|30px]] Unckeched: The column will not be displayed <br />
: [[ File:Checkbox_Checked_3.png|middle|30px]] Checked: The column will be displayed <br />
: [[ File:Column_Locked_3.png|middle|30px]] Locked: The column is always displayed, cannot be hidden. <br />
: [[ File:ColumnReorder_3.png|middle|30px]] Use this to drag and drop the different columns and define a custom ordering of the columns you want to be displayed.<br />
Once finished, use the [[File:Save3.png|30px]] button to save your selection. Setting are saved in your user profile, so the next time you enter in the page, you will have your preferred ordering.<br />
If you want to select back the default columns, click on the '''Reset to Default button'''.
<br clear=all><br />
=== [[File:SimpleSearchButton.png|middle|40px]] Simple Search ===
The Simple Search allows you to search elements that match one of the columns of the menu. It only allows to search over the columns that are currently displayed.<br />
[[File:MIB3_Search.png|600px|center|thumb|Simple Search Bar]]
In order to perform a search:
# First select the field/column you want to search in
# Second select the operator. The operators available will vary depending on the data type of the column you are searching in.
#* Numeric and date fields have: Equal, Not Equal, Greater Than, Greater or Equal than, Less Than, Less or Equal than.
#* Text fields have: Like, Equal, Not Equal, Starts with, Ends with.
# Introduce the search term and click [[File:SimpleSearchButton.png|middle|20px]] button or press Enter.
To remove the search filter, click on Clear Search [[File:ClearSearchMib3.png|middle|25px]] button.
<br clear=all><br />
=== [[File:AdvancedSearchMib3.png|middle|40px]] Advanced Search ===
[[File:MIB3_AdvancedSearch.png|500px|right|thumb|Advanced Search menu]]
The Advanced Search menu can be accessed clicking the [[File:AdvancedSearchMib3.png|middle|25px]] button. It allows you to create advanced search filters by several search terms over any of the columns available in the menu.<br />
To create an Advanced Search filter:
# Click on the [[File:AddMib3.png|middle|25px]] button to add a new search query.
# First select the Media Type (data table) where you are going to search in. In this version, only the current table can be searched in.
# Second select the Field/Column you want to search in.
# Then select the Condition/Operator. The operators available will vary depending on the data type of the column you are searching in.
#* Numeric and date fields have: Equal, Not Equal, Greater Than, Greater or Equal than, Less Than, Less or Equal than.
#* Text fields have: Like, Equal, Not Equal, Starts with, Ends with.
# Now introduce the search term.
You can add as many search queries as you want. You can also remove any of them by clicking on the [[File:DeleteRed_3.png|middle|25px]] button. <br />
Once finished, you can select if you want to search in '''All (AND)''' or '''Any (OR)'''. Then click in the '''Run Advanced Search button''' to execute the search.
<br clear=all>
[[File:MIB3_AdvancedSearch_History.png|500px|left|thumb|Advanced Search History Menu]]
A new feature in MIB 3 is that you can access to your search filters history for the page and run any of the already execute search filters, favorite a search filter and remove them.<br />
<br />
'''Run past search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Select the filter and press '''Run This Advanced Search''' button. The search will be executed.
'''Favorite search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Click on the favorite icon [[File:FavoriteSearch Icon.png|middle|25px]]
:: 3. Provide a name for the search filter and accept. The filter will be saved in your favorites list.
'''Edit search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Click on the [[File:EditMib3.png|middle|25px]] button. It will take you to the Advanced Search edit area so you can modify the filter.
'''Delete search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Press the [[File:DeleteRed_3.png|middle|25px]] button and the filter will be removed from your history.
<br clear=all>
[[File:MIB3_AdvancedSearch_Favorites.png|500px|right|thumb|Edit columns menu]]
You can manage your favorites from the Advanced Search Favorites menu. Here you can review your favorite filters for the current page and edit your favorites list.
<br />
'''Run Favorite Search'''<br />
# Navigate over the different favorite search filters.
# Select the filter and press '''Run This Advanced Search''' button. The search will be executed.
'''Remove from favorites'''<br />
# Navigate over the different favorite search filters.
# Press the [[File:DeleteRed_3.png|middle|25px]] button and the filter will be removed from your favorites list.
'''Modify favorite filter'''<br />
# Navigate over the different favorite search filters.
# Press the [[File:Copy3png|middle|25px]] button and the search filter will be open and you will be able to modify it, run it or update it.
<br clear=all>
=== [[File:PreviewMib3.png|middle|40px]] Item details Preview===
[[File:Mib3_ViewDetails.png|700px|right|thumb|Item details preview]]
To access the preview for an item from the List view, first you will have to select a row item by clicking in the checkbox [[File:CheckBox_Unchecked_3.png|middle|30px]] <br />
Then click on the preview button [[File:PreviewMib3.png|middle|30px]] to access the item details.
<br clear=all><br />
=== [[File:ExportMib3.png|middle|40px]] Export to TSV ===
[[File:ExportTSVOptions.png|200px|right|thumb|Export to TSV options]]
[[File:Mib3_NotificationResults.png|200px|right|thumb|Notifications panel]]
The [[File:ExportMib3.png|middle|30px]] button allows to export the data being displayed in the list to a TSV file. You can select between two options:
* '''Export current page:''' will generate a TSV file with the current page results.
* '''Export all pages:''' will generate a TSV file with all the pages.
Once selected, the TSV file will start generating in background. <br /><br />
MIB will notify you when the files have been generated through a notification [[File:MIB3 Notification.png|middle|30px]].<br />
Click on the notification to download the TSV file. To clear the notification, please click on the double check button [[File:MIB3_NotificationCheckbox.png|middle|30px]].
<br clear=all>
=== [[File:EditMib3.png|middle|40px]] Edit in list ===
One of the new features in MIB 3.0 version is the possibility of performing edition of data in lists, without having to go to the edit page. Only some of the pages have Edit in list feature enabled. Please visit the different [[#MIB 3.0 pages|MIB 3.0 pages]] to review which pages have this feature enabled. You can also know Edit in List is enabled because you will be able to find a [[File:Save3.png|middle|25px]] button in the right top of the list page.<br /><br />
To edit an item in a list, hover on any of the fields that you want to edit. An edit icon [[File:EditIcon.png|middle|20px]] will appear indicating that the you can edit the field. Otherwise, a forbidden icon will appear, indicating that that you cannot edit that field.
[[File:EditInList1.png|900px|center]]
<br />
Click on the edit icon [[File:EditIcon.png|middle|20px]] and you will be able to edit the field. When finished, press Enter or click outside the edit area.
[[File:EditInList2.png|900px|center]]
<br />
The field will be highlighted, indicating that the field has been modified. Continue editing more entries.<br />
Once finished editing, press [[File:Save3.png|middle|25px]] button and changes will be applied.
[[File:EditInList3.png|900px|center]]
<br />
<br />
=== [[File:AddMib3.png|middle|40px]] Add New item ===
By clicking on the [[File:AddMib3.png|middle|25px]] button, you can create a new item. You will be taken to the [[#Edit Page|Edit page]] to create a new item.
<br />
=== [[File:EditMib3.png|middle|40px]] Edit ===
By clicking on the [[File:EditMib3.png|middle|30px]] button, you can create a new item. You will be taken to the [[#Edit Page|Edit page]] to modify an existing new item.
<br />
=== [[File:EditMib3.png|middle|40px]] Bulk Edit ===
You can also edit several items at the same time, it is called Bulk Edit. To do it, select more than one row and click on the [[File:EditMib3.png|middle|30px]] button. You will be taken to the [[#Bulk Edit Page|Bulk Edit page]] to edit all the selected items at the same time.
[[File:BulkEdit.png|900px|center|thumb|Select several rows for accessing Bulk Edit]]
<br />
=== [[File:DeleteRed_3.png|middle|40px]] Delete item ===
You can also delete any row items by clicking on the [[File:DeleteRed_3.png|middle|30px]]. Once finished, click on the [[File:Save3.png|middle|25px]] button and the items will be deleted.
<br />
=== [[File:RefreshMib3.png|middle|40px]] Refresh list ===
In case you want to refresh the page results, click on the [[File:RefreshMib3.png|middle|30px]] button and the page will be loaded again.
<br />
<br />
== Edit Page ==
In the edit page you will be able to review all the element information as well as related blocks. You can easily navigate over the different blocks using the '''Quick Access menu'''.<br />
'''Note:''' If you are not able to see the Quick Access Menu, zoom out your browser to adjust the screen resolution.
[[File:EditPage.png|center|800px|thumb|Example of an edit page]]
<br />
You can create a new entry or edit an existing one. When editing, some fields are read only and some of them are not.
[[File:EditField.png|left|450px|thumb|Editable Field]]
[[File:EditField_ReadOnly.png|right|450px|thumb|Non-editable Field]]
<br clear=all>
There are several actions that can be done on the edit page.
=== [[File:New3.png|middle|40px]] Create ===
To create a new entry, you will have to fill in all the mandatory data.
<br />
=== [[File:Save3.png|middle|40px]] Save ===
Once you have finished modifying an element, you can use the [[File:Save3.png|middle|25px]] button to apply changes.<br />
MIB will perform some validations before submitting the data, such as:
* Mandatory fields: all the required fields have to be filled in.
* Specific page validations: some pages might have specific validation rules. Example: a movie cannot be saved without medias.
* Specific block validations: some of the relateds blocks might have specific validation rules.
If any of these validations fail, an error will be displayed indicating the reason. You will be able to navigate over the different errors with the up&down arrows in the error notification.
[[File:SaveValidationError.png|center|450px|thumb|Save validation error]]
<br />
Otherwise, the modifications will be applied and the element will be saved. A confirmation message will be displayed after that.
[[File:Saved.png|center|400px|thumb|Save success confirmation]]
<br />
=== [[File:Delete3.png|middle|40px]] Delete ===
In some of the pages, it is possible to use the [[File:Delete3.png|middle|25px]] button to remove an element. MIB will ask you for confirmation before removing the item.
<br />
=== [[File:Copy3.png|middle|40px]] Copy ===
The copy button [[File:Copy3.png|middle|25px]] will create a new entry copying all the basic fields, excluding the related blocks information.
<br />
=== [[File:CopyWithRelateds3.png|middle|40px]] Copy with Relateds ===
The copy with relateds button [[File:CopyWithRelateds3.png|middle|25px]] will create a new entry copying all the basic fields and the related blocks.<br />
For the related blocks, copy with relateds will behave differently depending on the type of block:
* '''Do not copy:''' the related block data will not be copied.
* Use same IDs (Shallow Copy): the related block data will be copied pointing to the same items than the copied one. It will just copy the relationship.
* Copy objects (Deep copy): the related block data will be copied pointing to the new items copied. It will clone the items that were linked to the source element and will link them to the new element.
<br />
<br />
== Bulk Edit Page ==
This page allows you to edit several items at the same time. To do it, you just have to select those fields and block you want to be modified.
<br /><br />
'''Modify a field'''<br />
Once you select a field in Bulk Edit, you will be able to modify it. Take into account that those fields that cannot be Edit in normal Edit mode, it cannot be modified here also.
[[File:BulkEditFieldEmpty.png|border|450px]] [[File:BulkEditField.png|border|450px]]
<br /><br />
'''Modify a related block'''<br />
[[File:BulkEditRelated.png|center|800px]]
1. Select the related block you want to modify for all the Bulk Edit elements.<br />
Note: not all the blocks will be available in the Bulk Edit page because there are some modifications that are not safe.<br /><br />
2. After that, select the elements you want to be added/removed.<br />
<br />
Then select what action you want to do from the drop down list:
* '''Add to existing:''' All the items you select in the block will be added to the existing ones.
* '''Find and remove these:''' All the items you select in the block will be removed if they exist in any of the bulk edit elements.
* '''Clear all:''' It will clear all the related block entries in all the bulk edit elements.
* '''Replace all with:''' It will clear all the related block entries and replace them by the ones that are selected in the block.
<br />
'''Apply changes'''<br />
Once finished editing, press [[File:Save3.png|middle|25px]] button and changes will be applied.
<br />
<br />
= MIB 3.0 pages =
{{:MIB 3.0 pages}}
__TOC__
= Introduction to MIB 3.0 =
MIB is the main management tool in TV Open Platform. It allows the operator to manage the entire platform: configurations, parameters, users, commercial offer, contents and much more.
In this new version, the tool has been completely redesigned in terms of user experience, adding a new design based on Google's material design and new features such as Edit in Lists, Bulk Edit, and more.
'''What's new in this version?'''
* Renewed UI
* Favorite search filters
* Search history
* Bulk Edit
* Clone items
* Edit in lists
* Lists columns management
* Favorite and History menu navigation
<br />
= MIB 3.0 commons =
== User Login page ==
[[File:UserLogin.png|right|thumb|User login page|400px]]
This page that allows you to authenticate in MIB with your credentials before entering in the system. <br />
You will be requested to type the '''username''' and '''password''' fields; If the login and password match, the login will be successful and you will be logged and go to your MIB home page. The login request are sent in a secure way, through POST and HTTPs, hiding the user login and password from a third party. <br />
<br />
There is also a '''Keep me logged in''' checkbox to allow the browser to remember the token and allow you to maintain logged for longer time, until the session expires or you perform logout.
<br clear=all> <br />
[[File:LoginCaptcha.png|400px|left|thumb|Captcha is requested when the user has typed the password wrong several times]]
<big>'''Wrong user/password'''<br /></big>
When you type a wrong username and/or password, MIB will show an an error alert with a message specifying the source of the error. You will be able to try again in case you made a mistake.
<br />
<br />
<br />
<big>'''Captcha validation'''</big><br />
A Captcha will be shown after several unsuccessful login attempts (up to 5). Then you will have then to fill the captcha field with the correct code or the login will continue failing even if the password is correct. This is done to avoid computer brute force attacks.
<br clear=all>
<br />
[[File:LoginPasswordExpired.png|400px|left|thumb|Dialog to type a new password when it has expired]]
<big>'''Password expiration'''<br /></big>
Some users might have configured password expiration (see [[MIB_Users_Page_Manual_3.0|MIB User Management]]) during user provisioning. In that case, you will be requested to change their password every 60 days.
<br /><br />
When your password has expired, you will be prompted upon a correct login request with a dialog to type the new password. Then you will have to provide the '''old password''' and the '''new password''' twice. If the new passwords mismatch or the old password is wrong, MIB will show an error.
<br /><br />
Also, the new password will have to follow a determined regex patter (which is defined in a configuration file). Currently, the password must be at least 8 chars long and must contain at least one capital letter, one number and one special character.
<br clear=all>
<br />
[[File:UserForgotPassword.png|400px|right|thumb|Forgot your password?]]
<big>'''Forgot my password'''</big><br />
In case you have forgotten your password, there is a password retrieval option in the login page, that will allow you to request a recovery email containing a secure link to generate a new password for you. <br />
<br />
To do this, you will have to type in the same email that is associated to your account and press '''Send recovery email button'''. Then a new [File:PasswordRecoveryEmailSent.png|menu] will be shown asking you to type the same email that was associated to his account and a password retrieval email will be sent. <br />
<br />
In the password retrieval email, you will get a link that will take him to a password recovery page where will be able to type in a new password. Once the password has been typed correctly (twice), your password will be changed to this new password provided.
<br clear=all>
<br />
== User Profile page ==
This page allows you to manage the information and settings associated to your account, update your profile picture or change your password.
[[File:UserProfileDropDown.png|left|150px]] To access this page, go to the top-right corner of the page; under the profile picture there is a drop down menu and then select the '''Edit Profile''' option.<br clear=all><br />
In this page, you will be able to perform several actions. Once done, press [[File:SAVEAuthButton.png|middle|40px]] button to apply your changes.<br /><br />
[[File:UserProfilePage.png|right|450px|thumb|User Profile page]]
'''<big>Update profile picture</big>'''<br />
Allows you to provide an updated profile picture. Hover on the current picture to select a new one.
<br />
<br />
'''<big>Update user information</big>'''<br />
Allows you to update your '''Full Name''', '''Email''' (required for password retrieval), '''Company''' and '''Timezone'''.
<br />
<br />
'''<big>Change password</big>'''<br />
Allows you to change your password. For this, you will have to provide your current password and the new password twice.
<br />
<br />
[[File:LogoutButton.png|middle|80px]] Allows you to logout from MIB3.
<br />
<br />
[[File:BackToAppButton.png|middle|80px]] Allows you to go back to MIB3.
<br />
<br clear=all><br />
<br />
<br />
== Main Menu ==
The main menu is a collapsable menu that can be accessed by clicking in the top left corner of the page [[File:MenuIcon.png|middle|25px]]<br />
The menu can be hidden by clicking again in the top left corner of the page [[File:HideIcon.png|middle|25px]]<br />
[[File:LateralMenu.png|left|300px|thumb|Main Menu]]
<br />
Once open, it shows the different menu items. You can navigate over the different menu items and expand [[File:ExpandIcon.png|middle|25px]] or collapse [[File:CollapseIcon.png|middle|25px]] them to access sub-menus that are contained in the main categories. You will only be able to access to those menus where you have permissions<br />
The complete list of menu items can be found in the [[#MIB 3.0 pages|MIB 3.0 pages section]].
<br />
<br />
'''[[File:SearchMenuIcon.png|middle|25px]] <big>Search Menu Bar</big>'''<br />
It allows you to search for specific menu items without having to navigate to them. Just type in the bot the menu name and the different menus that match your search will be returned.
<br />
<br />
'''[[File:HomeIcon.png|middle|25px]] <big>Home</big>'''<br />
The Home menu allows you to easily go to your MIB home page. For now, this page will be a pre-configure page associated to your profile, but in the future will be replaced by a custom home page with some useful information and statistics.
<br />
<br />
'''[[File:HistoryIcon.png|middle|25px]] <big>Navigation History</big>'''<br />
The History menu item allows you to browser over the last five menus that you have recently visited. To navigate back to any of them, just click on them and you will be redirected.
<br />
<br />
'''[[File:FavoritesIcon.png|middle|25px]] <big>Favorite Menus</big>'''<br />
The Favorite Menus item allows you to browser over your favorite menus. The user is able to favorite and unfavorite menus by clicking in the favorite star next to the menu title in the Navigation Bar.
<br />
[[File:NavigationBar.png|200px]]
<br />
<br clear=all><br />
<br />
== List Pages ==
When you access to a menu, you will first arrive to the List Page, where you will be able to browse over the menu items you have access to (for example, the list of movies). The access to the different items on the list is controlled through the Source field. You will only be able to access those items that belong to the Sources where you have access.
[[File:MIB3List.png|center|800px|thumb|Main Menu]]
<br />
In this menu, you are able to do several actions which are described in the following sections.
<br />
=== Paging ===
The items displayed in list are divided in pages. At the bottom of the screen you have different information that allows you to navigate over the different pages:
<br clear=all><br />
[[File:ListTotalNumber.png|300px|left|thumb|Current page and total number of results]]
[[File:ListJumpTo.png|300px|right|thumb|Jump to page action]]
First you can check the total number of items that this page has and the current page you are in.<br />
Also, you are able to select the number of results that will be returned per page, allowing you to select between 10 and 200 results per page.
You can also jump to a specific page number. Just type in the page number and click in the GO button.
<br clear=all>
You can also move between the different pages using the page navigation bar, where will be highlighted the current page number you are in:
* Click on the '''<''' button to go to the previous page
* Click on the '''>''' button to go to the next page
* Click on any of the Page numbers to jump directly to that specific page.
[[File:ListPaging.png|500px|center|thumb|Page Navigation bar]]
<br clear=all><br />
===[[File:EditColumsMib3.png|middle|40px]] Edit columns & reordering ===
[[File:Mib3ColumnsEdit.png|250px|right|thumb|Edit columns menu]]
The [[File:EditColumsMib3.png|middle|30px]] button allows you to select which columns will be displayed and their ordering. You can select up to any number of columns, but the minimum is two. If the number of columns exceeds the width of the page, an horizontal scroll will be added that will allow you to navigate to all the columns of the list<br />
: [[ File:CheckBox_Unchecked_3.png|middle|30px]] Unckeched: The column will not be displayed <br />
: [[ File:Checkbox_Checked_3.png|middle|30px]] Checked: The column will be displayed <br />
: [[ File:Column_Locked_3.png|middle|30px]] Locked: The column is always displayed, cannot be hidden. <br />
: [[ File:ColumnReorder_3.png|middle|30px]] Use this to drag and drop the different columns and define a custom ordering of the columns you want to be displayed.<br />
Once finished, use the [[File:Save3.png|30px]] button to save your selection. Setting are saved in your user profile, so the next time you enter in the page, you will have your preferred ordering.<br />
If you want to select back the default columns, click on the '''Reset to Default button'''.
<br clear=all><br />
=== [[File:SimpleSearchButton.png|middle|40px]] Simple Search ===
The Simple Search allows you to search elements that match one of the columns of the menu. It only allows to search over the columns that are currently displayed.<br />
[[File:MIB3_Search.png|600px|center|thumb|Simple Search Bar]]
In order to perform a search:
# First select the field/column you want to search in
# Second select the operator. The operators available will vary depending on the data type of the column you are searching in.
#* Numeric and date fields have: Equal, Not Equal, Greater Than, Greater or Equal than, Less Than, Less or Equal than.
#* Text fields have: Like, Equal, Not Equal, Starts with, Ends with.
# Introduce the search term and click [[File:SimpleSearchButton.png|middle|20px]] button or press Enter.
To remove the search filter, click on Clear Search [[File:ClearSearchMib3.png|middle|25px]] button.
<br clear=all><br />
=== [[File:AdvancedSearchMib3.png|middle|40px]] Advanced Search ===
[[File:MIB3_AdvancedSearch.png|500px|right|thumb|Advanced Search menu]]
The Advanced Search menu can be accessed clicking the [[File:AdvancedSearchMib3.png|middle|25px]] button. It allows you to create advanced search filters by several search terms over any of the columns available in the menu.<br />
To create an Advanced Search filter:
# Click on the [[File:AddMib3.png|middle|25px]] button to add a new search query.
# First select the Media Type (data table) where you are going to search in. In this version, only the current table can be searched in.
# Second select the Field/Column you want to search in.
# Then select the Condition/Operator. The operators available will vary depending on the data type of the column you are searching in.
#* Numeric and date fields have: Equal, Not Equal, Greater Than, Greater or Equal than, Less Than, Less or Equal than.
#* Text fields have: Like, Equal, Not Equal, Starts with, Ends with.
# Now introduce the search term.
You can add as many search queries as you want. You can also remove any of them by clicking on the [[File:DeleteRed_3.png|middle|25px]] button. <br />
Once finished, you can select if you want to search in '''All (AND)''' or '''Any (OR)'''. Then click in the '''Run Advanced Search button''' to execute the search.
<br clear=all>
[[File:MIB3_AdvancedSearch_History.png|500px|left|thumb|Advanced Search History Menu]]
A new feature in MIB 3 is that you can access to your search filters history for the page and run any of the already execute search filters, favorite a search filter and remove them.<br />
<br />
'''Run past search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Select the filter and press '''Run This Advanced Search''' button. The search will be executed.
'''Favorite search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Click on the favorite icon [[File:FavoriteSearch Icon.png|middle|25px]]
:: 3. Provide a name for the search filter and accept. The filter will be saved in your favorites list.
'''Edit search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Click on the [[File:EditMib3.png|middle|25px]] button. It will take you to the Advanced Search edit area so you can modify the filter.
'''Delete search filter'''<br />
:: 1. Navigate over the different search filters in your history.
:: 2. Press the [[File:DeleteRed_3.png|middle|25px]] button and the filter will be removed from your history.
<br clear=all>
[[File:MIB3_AdvancedSearch_Favorites.png|500px|right|thumb|Edit columns menu]]
You can manage your favorites from the Advanced Search Favorites menu. Here you can review your favorite filters for the current page and edit your favorites list.
<br />
'''Run Favorite Search'''<br />
# Navigate over the different favorite search filters.
# Select the filter and press '''Run This Advanced Search''' button. The search will be executed.
'''Remove from favorites'''<br />
# Navigate over the different favorite search filters.
# Press the [[File:DeleteRed_3.png|middle|25px]] button and the filter will be removed from your favorites list.
'''Modify favorite filter'''<br />
# Navigate over the different favorite search filters.
# Press the [[File:Copy3png|middle|25px]] button and the search filter will be open and you will be able to modify it, run it or update it.
<br clear=all>
=== [[File:PreviewMib3.png|middle|40px]] Item details Preview===
[[File:Mib3_ViewDetails.png|700px|right|thumb|Item details preview]]
To access the preview for an item from the List view, first you will have to select a row item by clicking in the checkbox [[File:CheckBox_Unchecked_3.png|middle|30px]] <br />
Then click on the preview button [[File:PreviewMib3.png|middle|30px]] to access the item details.
<br clear=all><br />
=== [[File:ExportMib3.png|middle|40px]] Export to TSV ===
[[File:ExportTSVOptions.png|200px|right|thumb|Export to TSV options]]
[[File:Mib3_NotificationResults.png|200px|right|thumb|Notifications panel]]
The [[File:ExportMib3.png|middle|30px]] button allows to export the data being displayed in the list to a TSV file. You can select between two options:
* '''Export current page:''' will generate a TSV file with the current page results.
* '''Export all pages:''' will generate a TSV file with all the pages.
Once selected, the TSV file will start generating in background. <br /><br />
MIB will notify you when the files have been generated through a notification [[File:MIB3 Notification.png|middle|30px]].<br />
Click on the notification to download the TSV file. To clear the notification, please click on the double check button [[File:MIB3_NotificationCheckbox.png|middle|30px]].
<br clear=all>
=== [[File:EditMib3.png|middle|40px]] Edit in list ===
One of the new features in MIB 3.0 version is the possibility of performing edition of data in lists, without having to go to the edit page. Only some of the pages have Edit in list feature enabled. Please visit the different [[#MIB 3.0 pages|MIB 3.0 pages]] to review which pages have this feature enabled. You can also know Edit in List is enabled because you will be able to find a [[File:Save3.png|middle|25px]] button in the right top of the list page.<br /><br />
To edit an item in a list, hover on any of the fields that you want to edit. An edit icon [[File:EditIcon.png|middle|20px]] will appear indicating that the you can edit the field. Otherwise, a forbidden icon will appear, indicating that that you cannot edit that field.
[[File:EditInList1.png|900px|center]]
<br />
Click on the edit icon [[File:EditIcon.png|middle|20px]] and you will be able to edit the field. When finished, press Enter or click outside the edit area.
[[File:EditInList2.png|900px|center]]
<br />
The field will be highlighted, indicating that the field has been modified. Continue editing more entries.<br />
Once finished editing, press [[File:Save3.png|middle|25px]] button and changes will be applied.
[[File:EditInList3.png|900px|center]]
<br />
<br />
=== [[File:AddMib3.png|middle|40px]] Add New item ===
By clicking on the [[File:AddMib3.png|middle|25px]] button, you can create a new item. You will be taken to the [[#Edit Page|Edit page]] to create a new item.
<br />
=== [[File:EditMib3.png|middle|40px]] Edit ===
By clicking on the [[File:EditMib3.png|middle|30px]] button, you can create a new item. You will be taken to the [[#Edit Page|Edit page]] to modify an existing new item.
<br />
=== [[File:EditMib3.png|middle|40px]] Bulk Edit ===
You can also edit several items at the same time, it is called Bulk Edit. To do it, select more than one row and click on the [[File:EditMib3.png|middle|30px]] button. You will be taken to the [[#Bulk Edit Page|Bulk Edit page]] to edit all the selected items at the same time.
[[File:BulkEdit.png|900px|center|thumb|Select several rows for accessing Bulk Edit]]
<br />
=== [[File:DeleteRed_3.png|middle|40px]] Delete item ===
You can also delete any row items by clicking on the [[File:DeleteRed_3.png|middle|30px]]. Once finished, click on the [[File:Save3.png|middle|25px]] button and the items will be deleted.
<br />
=== [[File:RefreshMib3.png|middle|40px]] Refresh list ===
In case you want to refresh the page results, click on the [[File:RefreshMib3.png|middle|30px]] button and the page will be loaded again.
<br />
<br />
== Edit Page ==
In the edit page you will be able to review all the element information as well as related blocks. You can easily navigate over the different blocks using the '''Quick Access menu'''.<br />
'''Note:''' If you are not able to see the Quick Access Menu, zoom out your browser to adjust the screen resolution.
[[File:EditPage.png|center|800px|thumb|Example of an edit page]]
<br />
You can create a new entry or edit an existing one. When editing, some fields are read only and some of them are not.
[[File:EditField.png|left|450px|thumb|Editable Field]]
[[File:EditField_ReadOnly.png|right|450px|thumb|Non-editable Field]]
<br clear=all>
There are several actions that can be done on the edit page.
=== [[File:New3.png|middle|40px]] Create ===
To create a new entry, you will have to fill in all the mandatory data.
<br />
=== [[File:Save3.png|middle|40px]] Save ===
Once you have finished modifying an element, you can use the [[File:Save3.png|middle|25px]] button to apply changes.<br />
MIB will perform some validations before submitting the data, such as:
* Mandatory fields: all the required fields have to be filled in.
* Specific page validations: some pages might have specific validation rules. Example: a movie cannot be saved without medias.
* Specific block validations: some of the relateds blocks might have specific validation rules.
If any of these validations fail, an error will be displayed indicating the reason. You will be able to navigate over the different errors with the up&down arrows in the error notification.
[[File:SaveValidationError.png|center|450px|thumb|Save validation error]]
<br />
Otherwise, the modifications will be applied and the element will be saved. A confirmation message will be displayed after that.
[[File:Saved.png|center|400px|thumb|Save success confirmation]]
<br />
=== [[File:Delete3.png|middle|40px]] Delete ===
In some of the pages, it is possible to use the [[File:Delete3.png|middle|25px]] button to remove an element. MIB will ask you for confirmation before removing the item.
<br />
=== [[File:Copy3.png|middle|40px]] Copy ===
The copy button [[File:Copy3.png|middle|25px]] will create a new entry copying all the basic fields, excluding the related blocks information.
<br />
=== [[File:CopyWithRelateds3.png|middle|40px]] Copy with Relateds ===
The copy with relateds button [[File:CopyWithRelateds3.png|middle|25px]] will create a new entry copying all the basic fields and the related blocks.<br />
For the related blocks, copy with relateds will behave differently depending on the type of block:
* '''Do not copy:''' the related block data will not be copied.
* Use same IDs (Shallow Copy): the related block data will be copied pointing to the same items than the copied one. It will just copy the relationship.
* Copy objects (Deep copy): the related block data will be copied pointing to the new items copied. It will clone the items that were linked to the source element and will link them to the new element.
<br />
<br />
== Bulk Edit Page ==
This page allows you to edit several items at the same time. To do it, you just have to select those fields and block you want to be modified.
<br /><br />
'''Modify a field'''<br />
Once you select a field in Bulk Edit, you will be able to modify it. Take into account that those fields that cannot be Edit in normal Edit mode, it cannot be modified here also.
[[File:BulkEditFieldEmpty.png|border|450px]] [[File:BulkEditField.png|border|450px]]
<br /><br />
'''Modify a related block'''<br />
[[File:BulkEditRelated.png|center|800px]]
1. Select the related block you want to modify for all the Bulk Edit elements.<br />
Note: not all the blocks will be available in the Bulk Edit page because there are some modifications that are not safe.<br /><br />
2. After that, select the elements you want to be added/removed.<br />
<br />
Then select what action you want to do from the drop down list:
* '''Add to existing:''' All the items you select in the block will be added to the existing ones.
* '''Find and remove these:''' All the items you select in the block will be removed if they exist in any of the bulk edit elements.
* '''Clear all:''' It will clear all the related block entries in all the bulk edit elements.
* '''Replace all with:''' It will clear all the related block entries and replace them by the ones that are selected in the block.
<br />
'''Apply changes'''<br />
Once finished editing, press [[File:Save3.png|middle|25px]] button and changes will be applied.
<br />
<br />
= MIB 3.0 pages =
{{:MIB 3.0 pages}}
