0305.导入导出介绍

{"action": "COMMON_IMPORT",
        "left": true,
        "data": {},
        "key": "common_import",
        "label": "标准导入"
    },
{"action": "COMMON_EXPORT",
        "left": true,
        "data": {},
        "key": "common_export",
        "label": "标准导出"
    }

{
  "action": "COMMON_IMPORT",  #【必填】按钮调用的方法，COMMON_IMPORT是框架通用导入。
  "label" : "模版型导入",  #【必填】按钮名称。
  "key" : "common_import",  #【必填】按钮的key，即唯一键，与其他按钮区分的唯一标识。
  "data":{  #【选填】导入按钮的一些个性设置，以下均为选填。
    "is_from_config": false,  # 是否使用个性化模板，false为否。
    "category": "whatever",  # 模型名或者个性化模板的common_imp_setting.json映射名称。不用个性化模板最好别设置。
    "file_name": "自己想怎么命名怎么命名.xlsx",  # 自定义下载的导入模板文件名
    "import_class": "",  # 使用的导入类。业务老师提供了，则使用业务老师提供的，否则不写。是固定的，不要自己瞎写。
    "role": "",  # 导入角色。
    "use_column_defs": false,  # 多表头导入
    "data_row": "3",  # 导入时，数据从excel文件的哪一行开始读取。默认是：导入文件有描述行，则从第三行开始读取，否则从第二行开始。
    "imp_tips": ["1、今天简单说以下几点", "。", "。。"],  # 自定义导入提示
    "show_business_key": false,   # 显示导入依据
    "choose_method": false,  # 是否展示导入模式选择
    "imp_method": 0,  # 默认导入模式（0:仅新增，1:仅编辑，2:有则编辑无则新增）
   "empty_selector": false,  # 是否展示选择器（默认为true） false: 不展示, true: 展示
    "empty_mode": 1,  # 默认值（默认为1） 0: 正常导入(编辑时覆盖)， 1： 跳过
    "action_state": "",  # 弹窗内部按钮的场景，修改ImpActionVirtual不同场景的list元数据来配置不同的弹窗内按钮，详见【导入导出小案例-9】
    "filter_org": [],  # 过滤组织（需要配合charge_role使用，进一步控制权限范围内的部门）
    "extend_property": {
        "map_warn": false,  # 当导入文件中的列名与info元数据中的列名不匹配时，是否直接拦截导入。默认为否（false）。
        "data_plugins": {},  # 自定义导入插件，详见【3.自定义配置导入插件】
      "charge_role": [{  # 用于校验权限。
            "field": "dept_id",   # 需要校验部门权限的字段
            "role": "cm-org-emp",  # 权限范围
            "type": "dept"  # 类型（部门校验）
        }, {
            "field": "employee",  # 需要校验人员权限的字段
            "role": "cm-org-emp",  # 权限范围
            "type": "emp"  # 类型（人员校验）
        }],
        "extra_property": {
            "field_state": {"字段1的key": "想要的场景"},  # 字典类型。当一个字段为关联对象类型时，可以设置他关联对象的场景进行下拉选项的过滤。详见【导入导出案例】
            "state": "imp",  # 导入场景。自定义是以哪个场景的info元数据为依据。
        }
    }
  }
},

{
    "key": "common_import",
    "label": "标准导入按钮",
    "action": "COMMON_IMPORT",
    "data": {
        "is_from_config": true,
        "category": "可以不填，不填时默认取当前模型名。填的话想写啥就写啥，但是要记下来，下面要用。"
}

{
...
    "AttendLocation": {  // 冒号前面的东西，叫“映射名”或者“key”。按钮里的category没写的话，就用模型名，否则category写了啥就用啥。
        "name": "考勤点",  // 文件名
        "imp": "AttendLocation_import.json",  // 导入使用的个性化模板的公司级模板名（等会你要新建另一个公司级模板，名字就叫这个）
        "exp": "AttendLocation_import.json",  // 导出使用的个性化模板的公司级模板名（等会你要新建另一个公司级模板，名字就叫这个），导入导出可以用同一个。
        "role": "cm-org-emp"  // 下载模板所需的权限
    },
...
},

{
    "alias": "考勤点",  #【选填】备注
    "category": "AttendLocation",  #【必填】注意，这个要写要导入的模型名，即按钮中配置的category是什么。
    "import_class": "core.base.imp_exp.services_dynamic_model.CommonDynamicImport",  #【必填】标准导入配置，不需要改直接复制
    "export_class": "core.base.imp_exp.services_dynamic_model.CommonDynamicExport",  #【必填】标准导出配置。注意，和导入的不一样。
    "filters": [],
    "orders": [],
    "fields": [{  # 【必填】模板中展示的列
        "key": "address",  #【必填】
        "name": "名称",  #【必填】
        "width": 20,  #【选填】旧版列宽，要使用的话需要特别配置，否则控制不了。
        "excel_width": 10,  #【选填】新版列宽，配置了就可以直接控制列宽。
        "comment": "请输入考勤点名称",  #【选填】描述行
        "require": true  #【选填】是否必填
    }, {
        "key": "number",
        "name": "编号",
        "width": 20,
        "comment": "请输入考勤点编号",
        "require": true
    }, {
        "key": "province",
        "name": "省份",
        "width": 20,
        "comment": "\n关联型，请选择考勤点所在省份",
        "drop_down_filter": {
            "enabled": true
        },
        "require": true
    }, {
        "key": "city",
        "name": "市(区)",
        "width": 20,
        "comment": "\n关联型，请选择考勤点所在市(区)",
        "require": true
    }, {
        "key": "address_note",
        "name": "详细地址",
        "width": 20,
        "comment": "请输入考勤点详细地址",
        "require": true
    }, {
        "key": "depart_id",
        "name": "所属组织",
        "width": 20,
        "comment": "文本型，请输入考勤点所属组织",
        "require": true
    }, {
        "key": "area_type",
        "name": "区域类型",
        "width": 20,
        "comment": "参照型，选择考勤点区域类型"
    }, {
        "key": "radius",
        "name": "有效打卡距离（米）",
        "width": 20,
        "comment": "文本型，请输入考勤点有效打卡距离（米）",
        "require": true
    }, {
        "key": "location_usable",
        "name": "可用范围",
        "width": 20,
        "comment": "参照型，选择考勤点可用范围（适用于哪个组织）"
    }, {
        "key": "enabled",
        "name": "是否启用",
        "width": 20,
        "comment": "请输入该考勤点是否可用",
        "require": true
    }],
    "charge_role": [{  #【选填】用于校验权限。
        "field": "dept_id",   # 需要校验部门权限的字段
        "role": "cm-org-emp",  # 权限范围
        "type": "dept"  # 类型（部门校验）
    }, {
        "field": "employee",  # 需要校验人员权限的字段
        "role": "cm-org-emp",  # 权限范围
        "type": "emp"  # 类型（人员校验）
    }],
    "check_items": {  #【选填】
        "imp": [],
        "exp": []
    },
    "data_plugins":[{  #【选填】
        "key": "before_imp_data_xxx",  // 【必填】注: 作为before_imp_data的插件须以before_imp_data开头，after_imp_data的插件则以after_imp_data开头。
        "name": "",  // 【必填】云函数名
        "plugin_type": "standard"  // 【选填】不填时使用云函数。填写为standard时为使用标准代码，上面的name也应为对应class路径。
    }]
}

{
    。。。
    "fields": [{
        "comment": "员工姓名",
        "width": 20,
        "require": true,
        "name": "员工姓名",
        "key": "employee_id",
        "parser":"emp_primary_key",
        "column_config":[
                {
                    "name": "姓名",
                    "key": "name"
                },
                {
                    "name": "编号",
                    "key": "number"
                }]
         
    },
    。。。
}

{
    "default": false,
    "action": "SUB_IMPORT",
    "left": true,
    "data": {
     
    },
    "key": "sub_import",
    "label": "导入"
}

{
    "default": false,
    "action": "SUB_IMPORT",
    "left": true,
    "data": {
    "is_from_config":true,
    "category":"子表模型名称"
    },
    "key": "sub_import",
    "label": "导入"
}

{
    "label": "主子集导入",
    "key": "common_import",
    "action": "BASE_IMPORT",
    "data": {
        "imp_type": "MULTI_IMPORT",  # 导入类型【必填】。可选项有COMMON_IMPORT, SUB_IMPORT, MULTI_IMPROT。MULTI_IMPROT即为主子集导入。
        "business_key_list": [  # 主集的字段【必填】。填写要求：1.具有唯一性；2.能通过填写的字段锁定到具体某一条主集数据。
            "number",
            "name"
         ],
        "extend_property": {  # 额外参数【选填】。但是如果要写导入场景，state参数必须写在其内。
            "extra_property": {
                "state": ""  # 主集的导入场景【选填】。
            }
        },
        "childs":[  # 自定义要下载的子集模板【选填】。要求与base元数据中的childs写法一致。
         {
            "key": "IconSales",  # 【必填】。
            "model": "IconSales",  # 子集对应的模型【必填】。
            "label": "专辑销量",  # 作为模板文件名【必填】。
            "parent_id": "icon_id",  # 子集存储主集id的字段【必填】。
            "meta_state": ""  # 子集的导入场景【选填】。
        },
        {
            "key": "xxx",
            "model": "xxx",
            "label": "xxx",
            "parent_id": "icon_id"
        },
        ]
    }
}

{
    "label": "附件导入",
    "key": "common_import",
    "action": "BASE_IMPORT",
    "data": {
        "imp_type": "UPLOAD_FILES",  # 导入类型【必填】。UPLOAD_FILES为附件导入。
        "model_index": "u_file",  # 附件字段的key【必填】。       
        "business_list": [  # 主集的字段【必填】。
            "employee_id",
            "dept_id"
         ],
 
        "split_str": "-",  # 文件名分隔符【选填】。如为"-"，则文件名为"0001-张三"。不填默认为"-"。
        "file_convert": true,  # 是否覆盖原有附件【选填】。覆盖原来的已有附件，配置后每次导入都会将原来的全部覆盖掉。不填默认每次追加附件。
        "is_insert": true,  # 是否新增不存在数据【选填】。在找不到与业务主键对应的数据时，新增一条数据，并将附件导入改条数据。
        "state": "xxxx",  # 导入导出元数据场景【选填】。选择是哪一个场景的导入导出元数据，不填用当前场景。导入导出元数据新建方式请看下文。
        "tips": "xxxxx"  # 上传附件提示语【选填】。
    }
 }

{
"fields":[
        ...,
        {
            "name": "employee_id",
            "key": "employee_id",
            "parser": "emp_primary_key",
            "column_config": [
                {
                    "name": "编号",
                    "key": "number"
                },
                {
                    "name": "姓名",
                    "key": "name"
                }
            ]
        },
        {
            "name": "所属组织",
            "key": "dept_id",
            "parser": "department_number",
            "column_config": [
                {
                    "name": "编号",
                    "key": "number"
                },
                {
                    "name": "名称",
                    "key": "name"
                }
            ]
        },
        ...
}

{"action": "COMMON_EXPORT",
        "left": true,
        "data": {},
        "key": "common_export",
        "label": "标准导出"
    }

{
    "hide": false,
    "action": "SUB_EXPORT",
    "data": {
        "celery_mode": true
            },
    "key": "sub_export",
    "label": "导出"
}

{
    "label": "主子集导出",
    "key": "common_export",
    "action": "BASE_EXPORT",
    "data": {
        "exp_type": "MULTI_EXPORT",  # 导出类型【必填】。可选项有COMMON_EXPORT, SUB_EXPORT, MULTI_EXPROT。MULTI_EXPROT即为主子集导出。
 
        "category": "BaseModel",  # 导出主集【选填】。默认为当前模型。
        "celery_mode": false,  # 是否需要异步【选填】。默认否。开启的话可以看到导出过程。
        "message": "send",  # 导出完成后是否发消息【选填】。默认"send"，即会发消息。"no send" 即不发消息。
        "is_from_config": false,  # 是否使用imp_exp导入导出元数据的配置【选填】。默认否。
        "export_class": "",  # 主集的导出类【选填】。默认框架导出。
        "file_name": "",  # zip文件名【选填】。
 
        "extend_property": {  # 额外参数【选填】。但是如果要写导入场景，state参数必须写在其内。
            "extra_property": {
                "state": ""  # 主集的导出场景【选填】。
            }
        },
        "childs":[  # 自定义要导出的子集【选填】。要求与base元数据中的childs写法一致。
         {
            "key": "IconSales",  # 【必填】。
            "model": "IconSales",  # 子集对应的模型【必填】。
            "label": "专辑销量",  # 导出文件名【必填】。
            "parent_id": "icon_id",  # 子集存储主集id的字段【必填】。
            "meta_state": "",  # 子集的导出场景【选填】。
            "file_name": "",  # 导出文件名【选填】。 配置file_name则不使用label。
            "extend_property": {
                "filter_dict": {
                    "xxx": ""  # 自定义过滤条件【选填】
                }
            }
        },
        {
            "key": "xxx",
            "model": "xxx",
            "label": "xxx",
            "parent_id": "icon_id"
        },
        ]
    }
}