Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
bank_copy [2017/01/12 14:54]
127.0.0.1 external edit
bank_copy [2017/02/28 11:52] (current)
steveclarke
Line 1: Line 1:
-====== ​Concepts ​======+====== ​Bank Copy ====== 
 +Bank Copy allows the user to Copy object records from one Bank to another Bank.  Object records are records like Items and Exams, Attachments,​ Authors, Competencies,​ Copyrights and References. ​ These objects are logically divided into [[concepts#​banks and bank level|Banks]]. ​ Bank Copy copies the object record to the new Bank so the record will exist in the original source Bank as well as the destination Bank.
  
-FIXME Status ​and Status rules (interaction of objectsstatus life cycle)+Items, Item Groups ​and Exams exist at the Item and Exam Bank level. ​ On a Level 1 Bank system, these records can be copied only from a source level 1 Bank to a different destination level 1 Bank.  On a Level 3 Bank systemthese records can be copied from a source level 3 Bank to a different destination level 3 Bank.
  
-FIXME Glossary ​for Expiry Effective Expiry Dates and not deleting ​records+Banks for Attachments,​ Authors, Copyrights ​and References are shared Banks. ​ On a Level 1 Bank system, there is only one shared Bank so, Bank copy is not available. ​ On a Level 3 Bank system, these records ​exist in shared banks at level 2.  These records can be copied from a source level 2 Bank to a different destination level 2 Bank.
  
-FIXME web.config discussion - Under support and installation+^Bank System^Object^Source^Destination^ 
 +|Level 1|Exam|1|1| 
 +|Level 1|Item|1|1| 
 +|Level 1|Item Group|1|1| 
 +|Level 1|Attachment|n/​a|n/​a| 
 +|Level 1|Author|n/​a|n/​a| 
 +|Level 1|Copyright|n/​a|n/​a| 
 +|Level 1|Reference|n/​a|n/​a| 
 +|Level 3|Exam|3|3| 
 +|Level 3|Item|3|3| 
 +|Level 3|Item Group|3|3| 
 +|Level 3|Attachment|2|2| 
 +|Level 3|Author|2|2| 
 +|Level 3|Copyright|2|2| 
 +|Level 3|Reference|2|2|
  
-FIXME concept Roles vs Users and how inherited rights work.+==== Copying a Record ==== 
 +To copy a record or records, select the records to copy in the selection grid by clicking, ctrl-clicking or shift clicking the rows.  See [[general_navigation_grids#​selecting_records|Selecting Records]] for more.  Once the row or rows are selected, click **Bulk Action → Copy** from the toolbar.
  
-FIXME Stats sets+{{:​bulkactioncopy.png?​600|}}
  
 +If no row or rows are selected a warning message will appear:
 +**Please select a record or records in order to Bulk Copy.**
  
 +If a row or rows were selected then a Bank Copy popup page will appear. ​ Select the destination Bank you want to copy the record or records to.  Then click the **Submit** button.
  
-==== Authentication Modes ==== +{{:bankcopy.png?600|}}
-**Item Writing** supports two authentication modes, Forms and Windows+
  
-**Forms Authentication** mode uses a login page to prompt users for their Login ID and password in order to access **Item Writing**. ​ All users in the system are required to have a Login ID and Password setup through [[security_edit_user_general|Security Entry]]. +When the records are finished copying, a success ​message is displayed.
- +
-**Windows Authentication** mode uses the users network credentials to validate their access to **Item Writing**.  ​When navigating to the **Item Writing** web application,​ the user is prompted for their network login and password. ​ If correct they are allowed access to the **Item Writing** application. ​ All users in the system are required to have a Login ID that matches their network Login ID.  No password is required to be setup for these users. ​ Login ID is setup through [[security_edit_user_general|Security Entry]]. +
- +
- +
-===== Banks and Bank Level ===== +
-CE Supports two types of Item Banking. ​ Level 1 Banking where there are multiple Exam and Item Banks and a single shared Bank for Attachments,​ Authors, Competencies etc.  Or Level 3 Banking where there are multiple Exam and Item Banks and multiple shared Banks. +
- +
-CE has many different types of objects. ​ An object can be an Item, Exam, Candidate, Address Type, User, etc.  Item Banking separates these objects into smaller groups of records.  Reasons for segregating the Banks are+
-  * Different Clients/​Departments - some records might be used only specific clients or departments. ​ To prevent their use by other departments or clientsthey are kept in separate Banks. +
-  * Security - To limit exposure to records, [[security_edit_banks|Bank Security]] can be setup to limit User access to certain Banks. +
-  * Legacy Data - Legacy data might be migrated into CE that users will want to keep separate from production data. +
-  * Import Data - Data that is imported into CE users might want to keep separate until it is vetted or fully checked. +
- +
-Users can have Bank access restricted:​ +
-  * None - No access to the Bank. +
-  * Browse - The user has read only rights to the Bank.  Meaning they can view records and maintenance pages but cannot create new records, expire records or make any changes to records. +
-  * Full - The user has full rights to the Bank, meaning they can view records, create new records, expire records or update existing records. +
- +
-=== Shared Object Types === +
-Regardless of Bank Level 1 or Bank Level 3 Item Banking, certain object types are always Shared. When an object type is **Shared** it means, regardless of [[security_edit_banks|Bank Security]], Users can access and maintain records. ​ It also means regardless of what Bank the user has selected to work with, these object type records are avaialable to work with.  Shared object types are found on the System menu and are: [[address_type_entry|Address Type]], [[bank_entry_level_1|Bank]],​ [[competency_type_entry|Competency Type]],​[[contact_type_entry|Contact Type]], [[country_entry|Country]],​ [[country_region_entry|Country Region]], [[email_type_entry|Email Type]], [[ethnicity_entry|Ethnicity]],​ [[gender_entry|Gender]],​ [[item_meta_type_entry|Item Meta Type]], [[reference_type_entry|Reference Type]], [[security_entry_role|Security Roles]] and [[security_entry_user|Security Users]]. +
- +
- +
-=== Level 1 Banks vs. Level 3 Banks === +
-The difference between Level 1 Banks and Level 3 Banks is in the data that is separated by Item Banking. ​ Object records are either **Shared** or they are **Banked**. ​ When an object type is **Shared** it means, regardless of [[security_edit_banks|Bank Security]], Users can access and maintain records. ​ When an object type is **Banked** it means that the data is segregated by Bank and it is affected by [[security_edit_banks|Bank Security]]. +
- +
-In Level 1 Bank most object types are shared and not controlled by Item Banking. ​ Only Item and Exam type records are affected by Item Banking. ​  +
- +
-^ State ^ Object Type ^ +
-| Shared| [[attachment_entry|Attachment]],​ [[author_entry|Author]],​ [[candidate_entry|Candidate]],​ [[competency_entry|Competency]],​ [[copyright_entry|Copyright]] and [[reference_entry|Reference]] | +
-| Banked| [[item_entry|Item]],​ [[item_group_entry|Item Group]], [[exam_entry|Exam]] and [[term_entry|Term]] | +
- +
-In a Level 3 Bank most object types are Item Banked. ​ Even though some object types are shared across multiple Exam/Item Banks, they are not shared throughout all Banks. Each Exam/Item Bank (at level 3) has a parent bank at level 2 which is a shared bank.  This shared bank shares all of its object records amongst all of the child Banks underneath it. +
- +
-^ State ^ Object Type ^ +
-| Shared among child Exam/Item banks| [[attachment_entry|Attachment]],​ [[author_entry|Author]],​ [[candidate_entry|Candidate]],​ [[competency_entry|Competency]],​ [[copyright_entry|Copyright]] and [[reference_entry|Reference]] | +
-| Banked| [[item_entry|Item]],​ [[item_group_entry|Item Group]], [[exam_entry|Exam]] and [[term_entry|Term]] | +
- +
-In the sample below, the **Shared** bank (in red) is shared by its child banks underneath it **Import** and **Production** (in orange). The **Client 3** bank (in blue) is shared by its child banks underneath it **Production** (in green). +
- +
-{{:​level3banks.png?​200|}} +
- +
-=== User Bank Security === +
-User Bank Security is maintained using [[security_edit_banks|Security Edit Banks]]. ​  +
- +
-In Level 1 Banking, the security is maintained for the Banks at Level 1 in the tree.  User rights are managed by Bank only for the [[item_entry|Item]],​ [[item_group_entry|Item Group]], [[exam_entry|Exam]] and [[term_entry|Term]] ​ entry tools. ​ All other object type data is shared and not affected by Bank Security. +
- +
-In Level 3 Banking, the security is maintained for the Banks at Level 3 in the tree.  The security shared data in the parent bank ([[attachment_entry|Attachment]],​ [[author_entry|Author]],​ [[candidate_entry|Candidate]],​ [[competency_entry|Competency]],​ [[copyright_entry|Copyright]] and [[reference_entry|Reference]]) is inherited from the Level 3 Banks. ​ Meaning if a level 3 Bank has **Full** rights, then the shared parent bank at level 2 has **Full** rights. ​ User rights are managed for the shared parent bank and for the [[item_entry|Item]],​ [[item_group_entry|Item Group]], [[exam_entry|Exam]] and [[term_entry|Term]] entry tools. +
- +
- +
-===== Custom Fields ===== +
-**Item Writing** maintains many different types of object records. ​ Examples are: [[item_entry|Items]],​ [[exam_entry|Exams]] or [[candidate_entry|Candidates]]. ​ These different objects have many fields to describe the data.  For example Candidates have Last Name and First Name, while Items have Answer, Value and Competency. ​ While many fields are explicitly defined, many clients require their own custom fields tracked for the various object records. ​ As these fields are not defined within the stock **Item Writing** system, **Item Writing** uses **Custom Fields** to track this information. +
- +
-On every **Item Writing** object there are custom entry screens where information that was not specifically tracked in **Item Writing** can be maintained. ​ See [[attachment_edit_notes|Attachment Edit Notes and Custom]], [[author_edit_notes|Author Edit Notes and Custom]], [[candidate_edit_notes|Candidate Edit Notes and Custom]], [[copyright_edit_notes|Copyright Edit Notes and Custom]], [[exam_edit_notes|Exam Edit Notes and Custom]], [[item_edit_text|Item Edit Text and Notes]] and [[reference_edit_notes|Reference Edit Notes and Custom]]. ​ These pages give the user the ability to maintain the data stored in these **Custom Fields**. +
- +
-TDA (FIXME link) can further customize the entry pages to have specific names for the fields (instead of Custom 01, Custom 02, ...) as well as validate entries to numeric, date or selected lists of valid values. +
- +
- +
- +
-===== Record Locking ===== +
-CE supports record locking. ​ Record locking is the technique of preventing multiple users from editing a record at the same time.  This is to prevent inconsistent results. ​ An example would be User 1 opens an Item to change the Competency from "​A"​ to "​B"​. ​ User 2 opens the same Item after user 2 started editing it.  User 2 attempts to change the Angoff to 0.5.  User 1 saves their change then User 2 saves their change. ​ Because User 2 retrieved their data before User 1 committed their change, their screen shows the Competency as "​A"​ instead of "​B"​. ​ When User 2 saves their Item, the Competency then reverts back to "​A"​. +
- +
-To prevent this CE locks a record the moment a user begins editing the record. ​ Every time the user navigates to another edit page for the record or saves their work, they refresh their lock on that record. ​ When the user starts to edit or view another record or navigates to another tool in the system or logs off the record lock is released. +
- +
-When a user selects a record that is locked, a warning ​message ​appears on their screen, all of the entry controls are disabled and the **Save** button in hidden. +
- +
-{{:​recordlocked.png?​600|}} +
- +
-Record Locks are specific to the users session not the User ID.  This means two people can log in as "​Administrator"​ and CE will track their locks separately. +
- +
-The default duration of a record lock before automatic release ​is 30 minutes. ​ This is configurable in the web.config file. +
- +
-There are circumstances where a user might persist their lock of a record inadvertently. ​ These include closing their browser, instead of logging off.  Having their computer shut down or having their network connection drop.  In order to clear their Record Locks use the [[Record_Lock|Record Lock]] tool. +
- +
-===== Versioning ===== +
-[[attachment_entry|Attachments]],​ [[item_entry|Items]] and [[exam_entry|Exams]] can be reversioned.  By default, all new Attachments,​ Items and Exams are created as **Version** 1 with a **Version 1 ID** value pointing to their ID.  Reversioning an object, creates a copy of that object in the same [[concepts#​Banks and Bank Level |Bank]]. ​ The new object has a **Version** = Version + 1 with its **Version 1 ID** still pointing to the original version 1 record. +
- +
-Example: Attachment "​Eiffel Tower " ID=25, Version=1 is reversioned. ​ The original Attachment has 25 is Version1ID=25 because it is the first version of the Attachment. ​ The reversioned record will get the next available Attachment ID automatically generated by the system. ​ For sake of this example, lets assume it is 201.  So the new Attachment record would by ID=201, Version=2, Version1ID=25. ​ If the version 2 record is reversioned,​ then lets assume the next available ID=320, so the new record would be ID=320, Version=3, Version1ID=25. +
- +
-^ID^Version^Version1ID^ +
-|25|1|25| +
-|201|2|25| +
-|320|3|25| +
- +
-All three versions of this Attachment are tied together by their Version1ID value being the same. +
- +
-==== Selection Grids ==== +
-The Attachment, Item and Exam grids by default only show the most recent version of the records. ​ To display prior versions of the records, click the **Include Prior Versions** check box in the title bar. +
- +
-{{:​examentryspecialfilters.png?​600|}} +
- +
-==== Viewing Prior Versions while Editing ==== +
-When editing Attachments,​ Items or Exams, users can navigate to other versions of the records by using the **Select Version** drop down on the blue info bar on the edit page.  If there is only one version of the records, the **Select Version** drop down is disabled. +
- +
-{{:​examversion1.png?​400|}} +
-{{:​examversion2.png?400|}}+
  
 +{{:​bankcopysuccess.png?​600|}}