3.2412 (#23)

* SQL管控记录接入coding平台 * oauth2配置更新 * 配置文件中取消插件配置信息 * 流程对接新增coding * Update login_syn.md * Update login_syn.md
actiontech · Jan 15, 2025 · a21749d · a21749d
1 parent 5dc3d28
commit a21749d
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 35 deletions.
diff --git a/docs/deploy-manual/config.md b/docs/deploy-manual/config.md
@@ -36,24 +36,7 @@ dms:
     host: "127.0.0.1"  
     port: 8978
     admin_user: "cbadmin"
-    admin_password: "123456"
-  database_driver_options:
-    - db_type: MySQL
-      logo_path: "/logo/mysql.png"
-      params:  
-    - db_type: PostgreSQL
-      logo_path: "/static/logo/pg.png"
-      params:   
-    - db_type: Oracle
-      logo_path: "/static/logo/oracle.png"
-      params: [
-       {
-        "key":"service_name",
-        "value":"XE",
-        "desc":"service name",
-        "type":"string"
-       },    
-      ]   
+    admin_password: "123456" 
 sqle:
   id: 1
   dms_server_address: "http://127.0.0.1:10000"

diff --git a/docs/user-manual/project/audit_task/sqlmanage.md b/docs/user-manual/project/audit_task/sqlmanage.md
@@ -42,11 +42,22 @@ SQL管控页面集中了用户在SQL审核和扫描任务中生成的SQL，当
 
 除了展示和过滤SQL，平台还提供多种SQL操作方式，帮助用户快捷处理SQL：
 
-* 按指纹查看SQL：支持按SQL指纹做聚合，跳转查看SQL审核列表；
-* 查看SQL执行计划：支持查看SQL分析结果，快速了解SQL的执行计划；
-* 指派负责人：可以将SQL指派给对应负责人处理；
-* 变更状态：可以将表单中的SQL标记为已解决、已忽略或已人工审核的状态；
-* 导出：可以根据当前筛选条件导出SQL管控列表的信息。
+#### 数据查看
+ * **按指纹查看SQL**：支持按SQL指纹做聚合，跳转查看SQL审核列表；
+ * **导出**：用户可根据当前设置的筛选条件，便捷地导出SQL管控列表中的信息。此功能可帮助用户将关键数据保存至本地，便于后续进行离线分析、汇报展示或存档备份等操作。
+ * **查看SQL执行计划**：通过深入分析执行计划，用户可精准定位SQL语句在执行过程中的性能瓶颈，进而针对性地优化SQL，提升数据库操作效率。
+#### 状态变更
+* **变更优先级**：用户可自由修改SQL的优先级状态，根据业务需求和问题紧急程度，灵活调整关注重心，确保关键SQL问题能够得到优先处理，合理分配资源，提高问题解决效率。
+* **变更状态**：平台允许用户将表单中的SQL标记为以下几种状态：
+    * 已解决：当SQL相关问题经过处理并确认得到妥善解决后，可将其标记为“已解决”，从待处理列表中移除，便于后续跟踪问题解决情况。
+    * 已忽略：对于一些非关键或无需处理的SQL，用户可标记为“已忽略”，避免其在后续操作中反复出现干扰正常工作流程。
+    * 已人工审核：当SQL经过人工详细审核后，标记此状态可明确区分已审核与未审核SQL，方便后续对审核结果进行统计与分析。
+* **添加为审核SQL例外**：若用户认为某条SQL无需再进行审核，可将其添加为审核SQL例外。此后，该条SQL将不再进入审核流程，减少不必要的审核工作量，提高整体工作效率。
+* **添加为管控SQL例外**：对于不需要在SQL管控中显示的SQL，用户可将其添加为管控SQL例外。这样，该SQL将从管控列表中排除，使管控列表更加聚焦于需要重点关注的SQL，提升管控效果。
+
+#### 任务分配
+* **指派负责人**：用户可将SQL指派给对应的负责人进行处理。通过明确责任归属，确保每个SQL问题都有专人跟进，提高问题解决的及时性和有效性，同时便于后续对负责人工作情况进行评估与监督。
+* **推送到其他平台**：平台支持将问题SQL同步到Coding等其他开发平台。这样，其他开发人员可以在自己熟悉的开发环境中接收并处理问题SQL，同时进行任务分配与进度追踪，实现跨平台协作，打破信息孤岛，提升团队协作效率。
 
 
 ### 操作结果

diff --git a/docs/user-manual/sys-configuration/img/coding.png b/docs/user-manual/sys-configuration/img/coding.png
diff --git a/docs/user-manual/sys-configuration/img/codingSQL.png b/docs/user-manual/sys-configuration/img/codingSQL.png
diff --git a/docs/user-manual/sys-configuration/img/codingSQLE.png b/docs/user-manual/sys-configuration/img/codingSQLE.png
diff --git a/docs/user-manual/sys-configuration/img/codingconfig.png b/docs/user-manual/sys-configuration/img/codingconfig.png
diff --git a/docs/user-manual/sys-configuration/login_syn.md b/docs/user-manual/sys-configuration/login_syn.md
@@ -48,17 +48,22 @@ SQLE中支持通过配置的方式接入OAuth 2.0系统, 如同其他系统一
 #### 操作步骤
 点击修改，选择启用OAuth 2.0
 
-* 应用ID：应用的唯一标识, 从要对接的平台申请 , 在OAuth2.0认证过程中，appid的值即为oauth_consumer_key的值
-* 应用密钥：appid对应的密钥，访问用户资源时用来验证应用的合法性。在OAuth2.0认证过程中，appkey的值即为oauth_consumer_secret的值
-* 外部访问SQLE的地址：格式为 http(s)://ip:port
-* oauth2登录授权页面地址：格式类似于 http(s)://ip:port/xxx
-* oauth2 access_token 获取地址：格式类似于 http(s)://ip:port/xxx
-* oauth2 user id 获取地址：格式类似于 http(s)://ip:port/xxx
-* 请求资源范围：此范围由验证服务器定义
-* access_token放置位置：SQLE会在获取用户ID时将access_token放在这个key对应的value中, 此参数会作为get请求的参数发送给用户ID获取地址
-* 用户ID保存位置：SQLE会尝试使用此key从第三方平台的响应中解析出用户ID,用户ID应当为唯一ID
-* 登录按钮文字：用于登录页面按钮提示
-* 自动创建并绑定用户：若开启，在通过OAuth2登陆时，若该用户未绑定SQLE用户，SQLE则会根据从OAuth2服务端获取的用户id创建SQLE账户，并且不会跳转到绑定界面，而是进入SQLE主界面
+* **应用ID**：应用的唯一标识, 从要对接的平台申请 , 在OAuth2.0认证过程中，appid的值即为oauth_consumer_key的值
+* **应用密钥**：与应用ID对应的密钥，用于验证应用访问用户资源的合法性。在 OAuth2.0 认证过程中，此密钥用作 oauth_consumer_secret 的值。
+* **外部访问SQLE的地址**：用户通过第三方平台登录后，将被重定向到此地址。格式为 http(s)://ip:port
+* **oauth2.0登录授权页面地址**：用户在此页面授权应用访问其账户信息。格式为 http(s)://ip:port/xxx
+* **oauth2.0 access_token 获取地址**：用于获取访问令牌的地址，该令牌允许用户的应用访问用户资源。格式为 http(s)://ip:port/xxx
+* **oauth2 user id 获取地址**：用于获取用户ID的地址，该ID用于识别用户。格式为 http(s)://ip:port/xxx
+* **注销跳转地址**：用户登出时，系统自动将浏览器重定向至此地址进行注销操作，以关闭第三方平台的会话信息。格式为 http://localhost:8080/logout?id_token_hint=$[id_token]&post_logout_redirect_url=$[sqle_url]
+* **请求资源范围**：定义应用可以访问的资源范围，由验证服务器定义。
+* **access_token Key名称**：指定在获取用户ID时，access_token 存储的键名。此参数会作为 GET 请求的参数发送给用户ID获取地址。
+* **用户UID的JSON路径**：指定从第三方平台响应中解析用户ID的 JSON 路径。用户ID应当为唯一ID。
+* **用户邮箱的JSON路径**：指定从第三方平台响应中解析用户邮箱的 JSON 路径。
+* **用户微信ID的JSON路径**：指定从第三方平台响应中解析用户微信ID的 JSON 路径。
+* **登录按钮文字**：自定义登录页面上 OAuth2.0 登录按钮的显示文字。
+* **自动创建并绑定用户**：若开启，在通过OAuth2登陆时，若该用户未绑定SQLE用户，SQLE则会根据从OAuth2服务端获取的用户id创建SQLE账户，并且不会跳转到绑定界面，而是进入SQLE主界面
+* **默认登录密码**：系统自动创建的新用户将使用此密码作为初始登录密码，请妥善保存，平台将不会明文展示。此外，为保证账户安全，建议用户首次登录后及时修改密码。如果之前配置过该项，更新时不填写该项代表不更新密钥。
+* **跳过请求来源验证**：跳过对请求发送来源的验证，可能增加安全风险。建议仅在可信环境下启用此选项。启用后，SQLE 将不再验证回调中的 state 参数。
 
 :::tip
 当仅允许内网访问SQLE服务时，请确保回调地址的后缀为"/v1/oauth2/callback"。

diff --git a/docs/user-manual/sys-configuration/process_syn.md b/docs/user-manual/sys-configuration/process_syn.md
@@ -68,4 +68,30 @@ title: 流程对接
 
 ### 利用飞书进行审批
 当发生工单变化时，工单关联成员可在对应飞书账号中收到通知，并进行相应的审批操作；
-![dingding-flow](img/feishu-flow.png)
+![dingding-flow](img/feishu-flow.png)
+
+## Coding对接
+
+### 创建Coding API Token
+* 登录Coding平台，进入“个人账户设置”，点击“访问令牌管理”，新建访问令牌。
+* 配置令牌相关权限这些权限将决定Token能够访问的资源和操作。
+* 创建成功后，复制生成的Token，该Token将用于调用Coding Open API。
+
+![codingconfig](./img/codingconfig.png)
+
+### 创建Coding项目
+* 新创建的项目需要进行初始化
+* 其中，sqle对接coding的项目名称为，项目地址的后缀。
+
+![coding.](./img/coding.png)
+
+### SQLE对接Coding
+* 登录SQLE系统。进入`系统设置`-`流程对接`页面。
+* 启用Coding对接，填写Coding服务的地址和之前创建的访问令牌（API Token）。
+  * 测试联通性，确保SQLE能够成功连接到Coding平台。
+
+![codingSQLE](./img/codingSQLE.png)
+
+### 将SQL推送至Coding平台
+* 在SQL管控中，如果使用者想更直观地暴露问题SQL，并进行持续追踪，使用者只需要一键推送，就可以将问题SQL同步到Coding平台，其他开发人员也可以在熟悉的开发环境中进行任务分配与进度追踪。
+![codingSQL](./img/codingSQL.png)