def import_options(request, extra_context={}):
"""
This view allows the user to specify options for how the system should
attempt to import the data in the uploaded Excel spreadsheet.
There are two types of options: those that govern the process as a whole
(whether to stop on errors, whether to update duplicates, etc) and options
for mapping a given model field to a given spreadsheet column (as well as
some other items about that model field.
For Import of Object Data:
In the case of a straight data import (of new objects as opposed to
an import of relationship mapping information -- see below) the
following options are available to the user for each field in the model:
field_name: This is a simple label showing the name of the specific
model field. If it has an asterisk, that field is required in
the underlying model.
Spreadsheet Column: This is a drop-down list of columns from the
spreadsheet. If no column headers are present, then each option
shows the value in that column's cell.
Is Identity: This allows the user to specify this specific spreadsheet
value as being part of potentially multi-part "key" to identify
whether or not this row in the spreadsheet refers to an object
already in the database.
Default Value: This is the value to use if the spreadsheet contains
no data for that specific field.
Mapping Field: For those fields that represent a related model, this
item represents a list of fields on THAT (related) model. The
user will select from these fields and the system will use that
selection in trying to grab the appropriate object from the
database using the value in the spreadsheet.
For Import of Relationship/Mapping Data:
In the case of the user uploading relationship data between models, the
following options are presented to the user for each field in each
(source and target) model.
model_name: This is a simple label showing the name of the source or
target model.
field_name: This is a simple label showing the name of the specific
model field.
Spreadsheet Column: This is a drop-down list of columns from the
spreadsheet. If no column headers are present, then each option
shows the value in that column's cell.
Is Identity: This allows the user to specify this specific spreadsheet
value as being part of potentially multi-part "key" to identify
whether or not this row in the spreadsheet refers to an object
already in the database.
Customize template used by setting the BATCH_IMPORT_OPTIONS_TEMPLATE
setting.
**Required arguments**
none.
**Optional arguments**
``extra_context``
A dictionary of variables to add to the template context. Any
callable object in this dictionary will be called to produce
the end result which appears in the context.
"""
try:
save_file_name = request.session['save_file_name']
model_for_import = request.session['model_for_import']
except KeyError:
# Either we don't have a file or we don't know what we're importing.
# So restart the process with a blank form (which will show the
# model list).
form = UploadImportFileForm()
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_START_TEMPLATE,
{'form': form},
context_instance=context)
# Process the request.
if request.method == 'POST':
# Add the various options to the session for use during execution.
form = ImportOptionsForm(model_for_import, save_file_name, request.POST, request.FILES)
if form.is_valid():
# Put the list of models and the various user-specified options in the session
# for use during execution.
request.session['process_options'] = {}
for option in form.get_process_options_dict().keys():
request.session['process_options'][option] = form.cleaned_data[option]
model_field_value_dict = {}
for field_name in form.model_field_names:
model_field_value_dict[field_name] = form.cleaned_data[field_name]
model_import_info = ModelImportInfo(model_for_import, model_field_value_dict, form.relation_info_dict)
request.session['model_import_info'] = model_import_info
else:
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_OPTIONS_TEMPLATE, {'form': form, 'model_for_import':model_for_import},
context_instance=context)
# Redirect to the Processing template which displays a "processing,
# please wait" notice and immediately fires off execution of the import.
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_EXECUTE_TEMPLATE, {}, context_instance=context)
else:
form = ImportOptionsForm(model_for_import, save_file_name)
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_OPTIONS_TEMPLATE, {'form': form, 'model_for_import':model_for_import},
context_instance=context)
def import_options(request, extra_context={}):
"""
This view allows the user to specify options for how the system should
attempt to import the data in the uploaded Excel spreadsheet.
There are two types of options: those that govern the process as a whole
(whether to stop on errors, whether to update duplicates, etc) and options
for mapping a given model field to a given spreadsheet column (as well as
some other items about that model field.
For Import of Object Data:
In the case of a straight data import (of new objects as opposed to
an import of relationship mapping information -- see below) the
following options are available to the user for each field in the model:
field_name: This is a simple label showing the name of the specific
model field. If it has an asterisk, that field is required in
the underlying model.
Spreadsheet Column: This is a drop-down list of columns from the
spreadsheet. If no column headers are present, then each option
shows the value in that column's cell.
Is Identity: This allows the user to specify this specific spreadsheet
value as being part of potentially multi-part "key" to identify
whether or not this row in the spreadsheet refers to an object
already in the database.
Default Value: This is the value to use if the spreadsheet contains
no data for that specific field.
Mapping Field: For those fields that represent a related model, this
item represents a list of fields on THAT (related) model. The
user will select from these fields and the system will use that
selection in trying to grab the appropriate object from the
database using the value in the spreadsheet.
For Import of Relationship/Mapping Data:
In the case of the user uploading relationship data between models, the
following options are presented to the user for each field in each
(source and target) model.
model_name: This is a simple label showing the name of the source or
target model.
field_name: This is a simple label showing the name of the specific
model field.
Spreadsheet Column: This is a drop-down list of columns from the
spreadsheet. If no column headers are present, then each option
shows the value in that column's cell.
Is Identity: This allows the user to specify this specific spreadsheet
value as being part of potentially multi-part "key" to identify
whether or not this row in the spreadsheet refers to an object
already in the database.
Customize template used by setting the BATCH_IMPORT_OPTIONS_TEMPLATE
setting.
**Required arguments**
none.
**Optional arguments**
``extra_context``
A dictionary of variables to add to the template context. Any
callable object in this dictionary will be called to produce
the end result which appears in the context.
"""
try:
save_file_name = request.session['save_file_name']
model_for_import = request.session['model_for_import']
except KeyError:
# Either we don't have a file or we don't know what we're importing.
# So restart the process with a blank form (which will show the
# model list).
form = UploadImportFileForm()
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_START_TEMPLATE,
{'form': form},
context_instance=context)
# Process the request.
if request.method == 'POST':
# Add the various options to the session for use during execution.
form = ImportOptionsForm(model_for_import, save_file_name, request.POST, request.FILES)
if form.is_valid():
# Put the list of models and the various user-specified options in the session
# for use during execution.
request.session['process_options'] = {}
for option in form.get_process_options_dict().keys():
request.session['process_options'][option] = form.cleaned_data[option]
model_field_value_dict = {}
for field_name in form.model_field_names:
model_field_value_dict[field_name] = form.cleaned_data[field_name]
model_import_info = ModelImportInfo(model_for_import, model_field_value_dict, form.relation_info_dict)
request.session['model_import_info'] = model_import_info
else:
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_OPTIONS_TEMPLATE, {'form': form, 'model_for_import':model_for_import},
context_instance=context)
# Redirect to the Processing template which displays a "processing,
# please wait" notice and immediately fires off execution of the import.
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_EXECUTE_TEMPLATE, {}, context_instance=context)
else:
form = ImportOptionsForm(model_for_import, save_file_name)
context = RequestContext(request)
for key, value in extra_context.items():
context[key] = callable(value) and value() or value
return render_to_response(BATCH_IMPORT_OPTIONS_TEMPLATE, {'form': form, 'model_for_import':model_for_import},
context_instance=context)
