sartography
/
cr-connect-workflow
mirror of https://github.com/sartography/cr-connect-workflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

WIP: Adds Camunda property for retrieving enum field options from task data.

This commit is contained in:
Aaron Louie 2020-07-10 14:48:38 -04:00
parent 1f454536e3
commit b7920989ed
3 changed files with 60 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
crc/models/api_models.py
View File

@ -32,15 +32,36 @@ class NavigationItem(object):
class Task(object):
##########################################################################
# Custom properties and validations defined in Camunda form fields #
##########################################################################
# Repeating form section
PROP_OPTIONS_REPEAT = "repeat"
PROP_OPTIONS_FILE = "spreadsheet.name"
PROP_OPTIONS_VALUE_COLUMN = "spreadsheet.value.column"
PROP_OPTIONS_LABEL_COL = "spreadsheet.label.column"
# Read-only field
PROP_OPTIONS_READ_ONLY = "read_only"
# LDAP lookup
PROP_LDAP_LOOKUP = "ldap.lookup"
VALIDATION_REQUIRED = "required"
# Autocomplete field
FIELD_TYPE_AUTO_COMPLETE = "autocomplete"
# Required field
VALIDATION_REQUIRED = "required"
# Enum field options values pulled from a spreadsheet
PROP_OPTIONS_FILE_NAME = "spreadsheet.name"
PROP_OPTIONS_FILE_VALUE_COLUMN = "spreadsheet.value.column"
PROP_OPTIONS_FILE_LABEL_COLUMN = "spreadsheet.label.column"
# Enum field options values pulled from task data
PROP_OPTIONS_DATA_NAME = "data.name"
PROP_OPTIONS_DATA_VALUE_COLUMN = "data.value.column"
PROP_OPTIONS_DATA_LABEL_COLUMN = "data.label.column"
##########################################################################
def __init__(self, id, name, title, type, state, form, documentation, data,
multi_instance_type, multi_instance_count, multi_instance_index, process_name, properties):

49
crc/services/lookup_service.py
View File

@ -76,29 +76,30 @@ class LookupService(object):
@staticmethod
def create_lookup_model(workflow_model, field_id):
"""
This is all really expensive, but should happen just once (per file change).
Checks to see if the options are provided in a separate lookup table associated with the
workflow, and if so, assures that data exists in the database, and return a model than can be used
to locate that data.
Returns: an array of LookupData, suitable for returning to the api.
This is all really expensive, but should happen just once (per file change).
Checks to see if the options are provided in a separate lookup table associated with the workflow, and if so,
assures that data exists in the database, and return a model than can be used to locate that data.
Returns: an array of LookupData, suitable for returning to the API.
"""
processor = WorkflowProcessor(workflow_model) # VERY expensive, Ludicrous for lookup / type ahead
spiff_task, field = processor.find_task_and_field_by_field_id(field_id)
if field.has_property(Task.PROP_OPTIONS_FILE):
if not field.has_property(Task.PROP_OPTIONS_VALUE_COLUMN) or \
not field.has_property(Task.PROP_OPTIONS_LABEL_COL):
if field.has_property(Task.PROP_OPTIONS_FILE_NAME):
if not (field.has_property(Task.PROP_OPTIONS_FILE_VALUE_COLUMN) or
field.has_property(Task.PROP_OPTIONS_FILE_LABEL_COLUMN)):
raise ApiError.from_task("invalid_emum",
"For enumerations based on an xls file, you must include 3 properties: %s, "
"%s, and %s" % (Task.PROP_OPTIONS_FILE,
Task.PROP_OPTIONS_VALUE_COLUMN,
Task.PROP_OPTIONS_LABEL_COL),
"%s, and %s" % (Task.PROP_OPTIONS_FILE_NAME,
Task.PROP_OPTIONS_FILE_VALUE_COLUMN,
Task.PROP_OPTIONS_FILE_LABEL_COLUMN),
task=spiff_task)
# Get the file data from the File Service
file_name = field.get_property(Task.PROP_OPTIONS_FILE)
value_column = field.get_property(Task.PROP_OPTIONS_VALUE_COLUMN)
label_column = field.get_property(Task.PROP_OPTIONS_LABEL_COL)
file_name = field.get_property(Task.PROP_OPTIONS_FILE_NAME)
value_column = field.get_property(Task.PROP_OPTIONS_FILE_VALUE_COLUMN)
label_column = field.get_property(Task.PROP_OPTIONS_FILE_LABEL_COLUMN)
latest_files = FileService.get_spec_data_files(workflow_spec_id=workflow_model.workflow_spec_id,
workflow_id=workflow_model.id,
name=file_name)
@ -110,14 +111,30 @@ class LookupService(object):
lookup_model = LookupService.build_lookup_table(data_model, value_column, label_column,
workflow_model.workflow_spec_id, field_id)
elif field.has_property(Task.PROP_OPTIONS_DATA_NAME):
if not (field.has_property(Task.PROP_OPTIONS_DATA_VALUE_COLUMN) or
field.has_property(Task.PROP_OPTIONS_DATA_LABEL_COLUMN)):
raise ApiError.from_task("invalid_emum",
"For enumerations based on task data, you must include 3 properties: %s, "
"%s, and %s" % (Task.PROP_OPTIONS_DATA_NAME,
Task.PROP_OPTIONS_DATA_VALUE_COLUMN,
Task.PROP_OPTIONS_DATA_LABEL_COLUMN),
task=spiff_task)
# Get the enum options from the task data
data_model = spiff_task.data.__getattribute__(Task.PROP_OPTIONS_DATA_NAME)
value_column = field.get_property(Task.PROP_OPTIONS_DATA_VALUE_COLUMN)
label_column = field.get_property(Task.PROP_OPTIONS_DATA_LABEL_COLUMN)
lookup_model = LookupService.build_lookup_table(data_model, value_column, label_column,
workflow_model.workflow_spec_id, field_id)
elif field.has_property(Task.PROP_LDAP_LOOKUP):
lookup_model = LookupFileModel(workflow_spec_id=workflow_model.workflow_spec_id,
field_id=field_id,
is_ldap=True)
else:
raise ApiError("unknown_lookup_option",
"Lookup supports using spreadsheet options or ldap options, and neither "
"was provided.")
"Lookup supports using spreadsheet options or ldap options, and neither was provided.")
db.session.add(lookup_model)
db.session.commit()
return lookup_model

4
crc/services/workflow_service.py
View File

@ -394,7 +394,7 @@ class WorkflowService(object):
# If this is an auto-complete field, do not populate options, a lookup will happen later.
if field.type == Task.FIELD_TYPE_AUTO_COMPLETE:
pass
elif field.has_property(Task.PROP_OPTIONS_FILE):
elif field.has_property(Task.PROP_OPTIONS_FILE_NAME):
lookup_model = LookupService.get_lookup_model(spiff_task, field)
data = db.session.query(LookupDataModel).filter(LookupDataModel.lookup_file_model == lookup_model).all()
if not hasattr(field, 'options'):
@ -467,7 +467,7 @@ class WorkflowService(object):
@staticmethod
def extract_form_data(latest_data, task):
"""Removes data from latest_data that would be added by the child task or any of it's children."""
"""Removes data from latest_data that would be added by the child task or any of its children."""
data = {}
if hasattr(task.task_spec, 'form'):