# Ganweisoft.IoTCenter.Module.PlanManage

**Repository Path**: ganweicloud/ganweisoft.iotcenter.module.planmanage

## Basic Information

- **Project Name**: Ganweisoft.IoTCenter.Module.PlanManage
- **Description**: 一个基于webapi开发框架的单表增删改查项目，使用前请认真阅读仓库中的开源声明。
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-07-15
- **Last Updated**: 2024-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 说明

基于IoTCenter 应用插件开发脚手架构建的独立项目，【预案管理】。

### 文件目录

```
.
+-- ReadMe.MD  自述文件
+-- docs 
|   +-- sql
|   	+-- plan-manage-mysql.sql  mysql脚本
|   	+-- plan-manage-sqlite.sql sqlite脚本
|   +-- 预案管理功能设计.xls
+-- src
|   +-- .NET 后端代码
|   +-- VUE  前端代码
```

### 功能说明

用于实现对预案信息的增删改查，具体功能参见《docs\预案管理功能设计.xls》文档。

### 使用说明

可与预案管理前端仓库中打包的前端包配合使用，插件安装步骤(不经过应用商店)如下：

1. 在\IoTCenterWeb\publish\plugins目录下创建文件夹Ganweisoft.IoTCenter.Module.PlanManage。注意文件夹的名字应与插件项目名称一致。如下图所示
![新建文件夹](media/createDir.png)

2. 将仓库中的后端代码生成的文件复制到上一步骤创建的文件夹中，如下图所示
![复制文件](media/copyFile.png)

3. 启动服务登录IoT平台即可使用预案管理的相关功能，如下如所示
![planManage](media/planManage.png)
  
   新增预案功能：
   操作步骤：
   - 填入“预案名称”、“预案内容”，若有相关附件可以点击“附件上传”按钮进行上传。
   - 点击“发布”按钮直接发布，或者点击“存草稿”按钮保存草稿，需要发布时再通过“编辑”功能进行发布。
     ![新增预案](media/create.png)

   编辑预案功能：
   操作步骤：
   - 编辑“预案名称”、“预案内容”，若有相关附件可以点击“附件上传”按钮进行上传。
   - 点击“发布”按钮直接发布，或者点击“存草稿”按钮保存草稿，需要发布时再通过“编辑”功能进行发布。

     ![编辑预案](media/edit.png)

   删除预案功能
   操作步骤：
   - 点击“删除”图标
   - 点击“确定”按钮
     ![删除预案](media/delete.png)

### 代码结构

1. 目录结构
   ![目录结构](media/dir.png)

2. 常用功能说明
   - OperateResult类：已封装的标准接口返回结果类，其中主要包含Failed和Successed两类方法分别用于不同情形下接口失败或成功时返回结果。
   ![OperateResult](media/operatorresult.png)

   - PagedResult类：用于查询结果的分页，使用示例如下：
   ![PagedResult](media/pagedresult.png)

   - 服务注册：在Startup类中进行服务注册，示例代码如下：
   ![startup](media/startup.png)

   - Entity实体类：主键尽量命名为Id，若不为Id需在数据上下文的OnModelCreating方法中定义主键，示例如下：
   ![tableKey](media/tablekey.png)

   -