网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
本文导读

工业软件接入ISCDesk

更新时间:2024-03-08 GMT+08:00
分享
  1. 下载安装ISCDesk

    访问工业软件云专区,将工业软件SaaS服务中心提供的ISCDesk安装包下载到本地,安装、启动并登录ISCDesk客户端。

  2. 工业软件接入ISCDesk

    工业软件SaaS服务中心提供的SDK集成到您的开发环境(例如:Visual Studio)中,根据所需功能模块,调用对应SDK接口进行功能开发。

前提条件

在gitee中将SDK开源源码下载至本地,代码仓地址为https://gitee.com/HuaweiCloudDeveloper/huaweicloud-dme-iscdesk-cpp/tree/master-dev/

当前提供两种方式获取SDK开源源码(注意:请选择“master-dev”分支代码):

  • “huaweicloud-DME-ISCDesk-cpp”代码仓克隆至本地。
  • “huaweicloud-DME-ISCDesk-cpp”代码压缩包下载至本地。

操作步骤

  1. 在您编译应用程序的电脑上使用Visual Studio打开SDK源码工程。
  2. 根据您的项目的编译器/工具集版本以及Windows SDK版本编译SDK工程。
  3. “IscdeskSdk\SdkApi\include”文件夹复制到您的项目中。
  4. 根据系统版本,将“IscdeskSdk\SdkApi\bin\x64\Release”或者“IscdeskSdk\SdkApi\bin\win32\Release”中的“.dll”文件复制到您的项目库文件夹中。

    说明:

    如果工业软件同时拥有x86和x86_64版本,您需要将win32和x64中的“.dll”文件复制到相应的库文件夹中。

  5. 添加“SdkInvoker.h”“IscdeskSdkIdl.h”头文件。

    在应用代码工程中,复制如下代码段:
    #include "SdkInvoker.h所在相对路径"
    #include "IscdeskSdkIdl.h所在相对路径"
    说明:

    “SdkInvoker.h”所在路径:SDK包解压后,“SdkInvoker.h”文件所在的指定目录的相对路径。例如:“ISCDesk-PC-SDK\Sdk\Include\interface\SdkInvoker.h”

    “IscdeskSdkIdl.h”所在路径:SDK包解压后,“IscdeskSdkIdl.h”文件所在的指定目录的相对路径。例如:“ISCDesk-PC-SDK\Sdk\Include\sdk\IscdeskSdkIdl.h”

  6. 调用对应API来设置SDK。

    1. 加载“IscdeskApi.dll”或者“IscdeskApi64.dll”文件。
      // 使用时需要包含如下头文件
      #include "IscdeskApi\Sdk\Include\interface\SdkInvoker.h" 
      #include "IscdeskApi\Sdk\Include\sdk\IscdeskSdkIdl.h"
      HMODULE sdkHandle = LoadLibraryA("IscdeskApi.dll所在相对路径");
      if (sdkHandle == NULL) {
          // 加载失败需要退出
      }
      说明:

      “IscdeskApi.dll”所在路径:SDK源码编译后,“IscdeskApi.dll”文件所在的指定目录的相对路径。例如,“IscdeskSdk\SdkApi\bin\Win32\Release\IscdeskApi.dll”

    2. 调用“IscdeskSdkCheckingEnvironment”接口,检查ISCDesk客户端是否启动。
      // 使用IscdeskSdk.h
      SDK::SdkInvoker invoker(SdkHandle);
      ResultStatus ret = invoker.IscdeskSdkCheckingEnvironment();
      if (ret != STATUS_SUCCESS) { 
          // 检查失败需要退出
      }
    3. 初始化SDK。
      ResultStatus ret = invoker.IscdeskFactory()->Init()
      if (ret != ResultStatus::STATUS_SUCCESS) {
          // 初始化失败需要退出
      }

  7. 根据SDK的接口功能,开发所需的SDK功能模块,功能模块详情请参见改造功能模块说明

    注意:

    工业软件调用SDK函数时,入参必须使用UTF-8编码格式。SDK产生回调事件时,通知工业软件的消息也为UTF-8编码格式。若存在编码格式冲突,请工业软件做好编码格式转换,避免因为编码格式不同导致的问题。

    1. 基础SDK接口功能。此处为Demo示例,请您根据实际情况在应用代码工程中进行开发。
      Example example; 
        /* Sdk初始化 */
        ResultStatus resutStatus_1 = invoker.IscdeskFactory()->Init(); 
        /* 将用户工业软件类的事件接收函数注册到Sdk中 */
        invoker.IscdeskFactory()->RegisterEventRecall(&example, &Example::EventRecall);
        ResultStatus resultStatus_2 = invoker.IscdeskFactory()->ShutOut();
    2. 管理在云SDK接口功能。此处为Demo示例,请您根据实际情况在应用代码工程中进行开发。
       /* 用户工业软件调用试用到期通知并获取license函数接口(如果有试用期) */
      ResultStatus resultStatus_3 = invoker->TrialExpirationAndGetLicense(LicenseType::LICENSE_TYPE_FILE,
           "devInfo", "license.lic");
      /* 用户工业软件调用获取License文件请求函数接口 */
        ResultStatus resultStatus_4 = invoker->GetLicenseFileRequest(fileName, devInfo);
       /* 用户工业软件调用获取License字符串请求函数接口 */
        ResultStatus resultStatus_5 = invoker->GetLicenseStringRequest(devInfo); 
        /* 用户工业软件调用License验证结果通知接口 */
        ResultStatus resultStatus_6 = invoker.IscdeskFactory()->invoker->LicenseVerifyNotify(verifyResult, errorMsg);
        /* 用户工业软件调用升级信息查询接口 */
        ResultStatus resultStatus_7 = invoker.IscdeskFactory()->invoker->CheckNewVersions();
        /* 用户工业软件调用升级通知接口 */
        ResultStatus resultStatus_8 = invoker.IscdeskFactory()->invoker->UpgradeNotify(bUpgrade);
    3. 数据在云SDK接口功能。此处为Demo示例,请您根据实际情况在应用代码工程中进行开发。
      /* 用户工业软件调用打开云端文件接口 */  
        ResultStatus resultStatus_9 = invoker.IscdeskFactory()->OpenCloudFile(filePath);    
      /* 用户工业软件调用另存普通文件至云端文件接口 */
        ResultStatus resultStatus_10 = invoker.IscdeskFactory()->SelectSaveAsPath(filePath);  
      /* 用户工业软件调用另存装配体文件至云端文件接口 */
        ResultStatus resultStatus_11 = invoker.IscdeskFactory()->SelectSaveAsPath(filePath, true);  
      /* 用户工业软件调用保存普通文件至云端文件接口 */
        ResultStatus resultStatus_12 = invoker.IscdeskFactory()->Save(saveFilePath);
      /* 用户工业软件调用保存装配体文件至云端文件接口 */
        ResultStatus resultStatus_13 = invoker.IscdeskFactory()->Save(saveFilePath, true);
    4. (可选)计算在云SDK接口功能。此处以Demo示例,请根据实际情况在您的应用代码工程中进行开发。
        ResultStatus resultStatus_14 = invoker.IscdeskFactory()->GetSolution(filePath);
    说明:

    SDK回调事件产生说明:

    • “EVENT_OPENCLOUDFILE_RESULT”:打开云端文件事件。工业软件调用“OpenCloudFile”打开云端文件接口并选择云端文件后,SDK产生此事件。此事件触发时,SDK会将云端文件路径信息连同事件一起告知工业软件,工业软件可根据此事件进行打开文件操作。
    • “EVENT_SAVE_RESULT”:保存结果回复事件。工业软件调用“Save”保存至云端接口、“SelectSaveAsPath”另存为云端接口后产生此事件。此事件触发时,SDK会将保存文件结果连同事件一起告知工业软件。
    • “EVENT_UPDATE”:升级事件。工业软件调用“CheckNewVersions”接口后,通知ISCDesk检查版本信息,查看是否存在升级版本。如果存在升级信息,则SDK产生升级事件。升级事件触发时,SDK会将升级事件告知工业软件,工业软件可自行决定是否退出升级或继续使用。
    • “EVENT_UPGRADENOTICE”:升级信息通知事件。工业软件调用“CheckNewVersions”接口后,通知ISCDesk检查版本信息,查看是否存在升级版本。ISCDesk查询版本信息后通知SDK,SDK产生升级信息通知事件。SDK将升级信息通知事件连同升级信息一起告知工业软件。
    • “EVENT_CLIENT_EXIT”:ISCDesk客户端关闭事件。工业软件与ISCDesk客户端正常连接时,ISCDesk客户端关闭后,SDK会产生客户端关闭事件。客户端关闭事件触发时,SDK会将客户端关闭事件告知工业软件,工业软件根据此事件可自行决定是否退出、是否降级处理或其他自定义操作。
    • “EVENT_LICENSE_VERIFY”:License验证事件。工业软件调用“GetLicenseFileRequest ”“GetLicenseStringRequest”接口后需要等待,直到SDK产生此事件。此事件触发时SDK会将License路径信息或License字符串信息连同事件一起告知工业软件,工业软件可根据此事件进行License验证操作。

      SDK告知工业软件的信息字符串中包含:“LicenseFilePath”字段(License路径),“LicenseContent”字段(License字符串内容),“LicenseType”字段(License类型,包含License文件和License字符串两种类型。),以及“Status”字段(License获取状态)。

      当License文件验证时:“LicenseType”字段值为“file”“LicenseFilePath”字段为License文件路径,“LicenseContent”字段不存在;当License字符串验证时:“LicenseType”字段值为“string”“LicenseContent”字段为License字符串内容,“LicenseFilePath”字段不存在。当License请求获取成功时,“Status”字段为“success”;失败时为“failed”;取消获取License时为“cancel”

    • EVENT_SHORTCUT_SAVETOCLOUD:保存云端文件的快捷键事件。用户在ISCDesk上设置并启用保存云端文件快捷键后,当用户在工业软件窗口输入对应快捷键后,SDK产生保存云端文件的快捷键事件,并通知工业软件,工业软件可根据此事件进行保存云端文件操作。
    • EVENT_SHORTCUT_SAVEASTOCLOUD:另存为云端文件的快捷键事件。用户在ISCDesk上设置并启用另存为云端文件快捷键后,当用户在工业软件窗口输入对应快捷键后,SDK产生另存为云端文件的快捷键事件,并通知工业软件,工业软件可根据此事件进行另存为云端文件操作。
    • EVENT_UPLOAD_START:文件上传云端开始事件。当工业软件进行保存云端文件或另存为云端文件操作后,文件上传云端开始时,SDK产生文件上传云端开始事件并通知工业软件,建议工业软件在收到此事件后,对上传中的文件禁止保存,避免在上传过程中由于文件修改导致与预期上传结果不一致。
    • EVENT_UPLOAD_END:文件上传云端结束事件。当工业软件进行保存云端文件或另存为云端文件操作后,文件上传云端结束时,SDK产生文件上传云端结束事件并通知工业软件,建议工业软件在收到此事件后,对上传中的文件解除禁止保存。
    • “EVENT_UNKONW”:未知事件。

    注:“RegisterEventRecall”函数注册的回调函数为事件接收函数,事件接收函数获得的参数仅为事件类型及不同事件对应的信息,具体业务逻辑需要工业软件自行添加。且事件接收函数中禁止调用ShutOut函数,否则会造成死锁。

  8. 检查函数返回的错误码。如果为失败状态,则请检查调用方式或运行环境等是否有问题。

    说明:

    错误码说明:

    • STATUS_SUCCESS:成功
    • STATUS_FAILURE:普通错误
    • ERROR_CLIENT_OFFLINE:ISCDesk客户端未登录
    • ERROR_CLIENT_NOINSTALL:ISCDesk客户端未安装
    • ERROR_INTERFACE_INVALID:接口不可用
    • ERROR_SHM_READ_FAILED:共享内存读取失败
    • ERROR_NETWORK_INITIALIZE_FAILED:网络初始化失败
    • ERROR_NETWORK_ERROR:网络不可用
    • ERROR_NETWORK_UNREACHBLE:网络不可达
    • ERROR_LICENSE_EXPIRE:软件许可过期
    • ERROR_LICENSE_NOEXIST:软件许可不存在
    • ERROR_UNKNOWN:未知错误

  9. 当您关闭客户端工业软件应用时,需要释放SDK。

      // 当不需要IscdeskSdk时,您需要结束IscdeskSdk
      ResultStatus resultStatus = invoker.IscdeskFactory()->ShutOut();
      invoker.DestoryIscdesk();
      // 释放该SDK库
      FreeLibrary(handle);

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容