experimental.rst 7 KB
Newer Older
1
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
2
3
   pair: Administration; Experimental features
   single: Site administrator; Experimental features
4
5
6
7

Experimental features
------------------------

8
As site administrator you have three experimental features available to you:
9
10
11

* bulk export of Leap2A files
* bulk import of Leap2A files
12
* usersuniquebyusername variable
13

14
You cannot access these features from any navigation, but you must type the URL directly in the case of the bulk options or set up a config.php variable.
15
16
17
18

.. warning::
   The export and import of portfolios uses quite a lot of computing power. Therefore, these bulk options require even more memory. Please try them first out on a test installation or export / import only a small number of users instead of an entire institution at once.

19
.. index:: Leap2A export
20
   pair: Experimental features; Bulk export
Kristina Hoeppner's avatar
Kristina Hoeppner committed
21
   single: Site administrator; Bulk export
22

23
24
.. _bulk_export:

25
26
27
28
29
30
31
Bulk export of Leap2A files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*[your regular Mahara URL]/admin/users/bulkexport.php*

If you need to export the portfolios of multiple users at once, you can do so from the bulk export page. Please remember that this is an experimental feature at the moment.

32
.. figure:: /images/administration/bulk_export.*
33
34
35
36
37
   :alt: Experimental feature: Bulk export

   Experimental feature: Bulk export

#. **Institution**: Choose the institution from the drop-down menu for which you want to export **all** user portfolios in the Leap2A format.
38
#. **Usernames to export**: Alternatively, choose this option if you only wish to export some users' portfolios. Each username must be on a separate line.
39
40
41
#. Click the *Export users* button to start the export process. This might take a while.

.. note::
42
   You can look up the usernames on the :ref:`user search <user_search>` page or if you :ref:`exported a CSV file of users <user_details_report>`, you have the usernames in there as well.
43

44
.. index:: Leap2A import
45
   pair: Experimental features; Bulk import
Kristina Hoeppner's avatar
Kristina Hoeppner committed
46
   single: Site administrator; Bulk import
47

48
49
.. _bulk_import:

50
51
52
53
54
55
56
57
58
59
60
61
Bulk import of Leap2A files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*[your regular Mahara URL]/admin/users/bulkimport.php*

If you need to import the portfolios of multiple users at once, you can do so from the bulk import page. Please remember that this is an experimental feature at the moment. You must have Leap2A files to import. The import of HTML files is not possible.

The easiest option to import user portfolios in bulk is to use the bulk export file as all information is contained therein. If that is not possible, you can create the necessary ZIP file manually.

Bulk import using a bulk export file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

62
.. figure:: /images/administration/bulk_import.*
63
64
65
66
   :alt: Experimental feature: Bulk import

   Experimental feature: Bulk import

67
68
Ideally, you have exported the users you wish to import using the bulk export functionality on the other Mahara instance. Then the bulk export file already contains all necessary files and mappings.

69
70
71
.. note::
   Before importing these new user accounts, you can change the usernames for these new accounts in the *usernames.csv* file that is included in the bulk export file.

72
73
#. **Institution**: Choose the institution in which the users shall become members.
#. **Bulk export file**: Choose the bulk export ZIP file which contains all users that shall be created. A new user account will be created for each of them.
74
#. **Email users about their account**: Check this option if the new users shall receive an email about their new account. This is especially important if they do not know that their account has been moved or if you want to change their username. Don't use this option if you want to use an external authentication method for their account. They would be emailed their internal Mahara account details but then not be able to use them.
75
76
77
78
79
80
81
#. Click the *Import* button to start the process. Please be patient as the import may take some time.

Bulk import from scratch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you want to import user portfolios into one institution using their Leap2A files that you did not receive via the bulk export functionality, you can still import them in bulk.

82
83
#. Create a folder, e.g. ``mahara-bulk-import``.
#. Create the CSV file ``usernames.csv`` in the folder ``mahara-bulk-import``.
84
#. Create a line for each user that you are importing that contains the username and the name of the ZIP file that contains the corresponding Leap2A file.
85
86
87
#. Create the sub folder ``users`` in it. Do not choose a different name.
#. Place all Leap2A files that you wish to import into one institution into the ``users`` sub folder. Make sure that each ZIP file has a corresponding entry in ``usernames.csv``.
#. Create a ZIP file from the folder ``mahara-bulk-import`` once you have all users in it.
88
89
90
91
92
93
94
#. Go to *[your regular Mahara URL]/admin/users/bulkimport.php*.
#. **Institution**: Choose the institution in which the users shall become members.
#. **Bulk export file**: Choose the bulk export ZIP file which contains all users that shall be created. A new user account will be created for each of them.
#. **Email users about their account**: Check this option if the new users shall receive an email about their new account. This is especially important if you change their username and if they do not know that their account has been moved.
#. Click the *Import* button to start the process. Please be patient as the import may take some time.

.. note::
95
   The CSV file ``usernames.csv`` should look like this and does not have a header row:
96

97
98
99
   | ``"petra","mahara-export-leap-user4-1334451885.zip"``
   | ``"polly","mahara-export-leap-user5-1334451888.zip"``

100
101
.. index::
   pair: Experimental features; usersuniquebyusername
Kristina Hoeppner's avatar
Kristina Hoeppner committed
102
   single: Site administrator; usersuniquebyusername
103
104
105
106
107
108

.. _usersuniquebyusername:

usersuniquebyusername variable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

109
*usersuniquebyusername* is a :ref:`config.php setting <config_variable_usersuniquebyusername>` that should be used with extreme caution as it could be misused.
110
111
112
113

Below is the documentation that can be found in the code. This feature is discussed for example in the discussion topics `Mahara Moodle integration and bug? <https://mahara.org/interaction/forum/topic.php?id=1118>`_ and `SSO: Mahara to Moodle <https://mahara.org/interaction/forum/topic.php?id=2022>`_.

.. note::
114
   When turned on, this setting means that it does not matter which other application the user SSOs from, they will be given the same account in Mahara.
115

116
   This setting is one that has security implications unless only turned on by people who know what they are doing. In particular, every system linked to Mahara should be making sure that same username == same person. This happens for example if two Moodles are using the same LDAP server for authentication.
117

118
   If this setting is on, it must NOT be possible to self register on the site for ANY institution - otherwise users could simply pick usernames of people's accounts they wished to steal. That is why you should not see the registration checkboxes in any institution if you have this feature turned on.