软件技术规范

软件技术规格一、实施技术规范的目的和适用范围为了使苏州交通系统的各种新的和构建的应用软件有效地实现资源共享和数据交换，实施应用软件技术规范，为应用软件的可持续、可扩展开发和部署奠定了基础，为未来的应用集成做好了准备。本规范的适用范围：2010年以后新建的应用程序必须满足本规范中定义的技术要求，2009年底以前构建的应用程序将在以后的升级转换中达到本规范中定义的技术要求，目前构建的软件系统必须符合本规范中定义的技术要求的条件。二、技术规格实施目标实施本规范后开发的应用软件必须实现本程序中定义的系统接口，编写本程序中规定的数据规范，并能应用本程序的组织结构管理要求。通过实施集成接口技术规范，所有应用程序软件都实现了集成管理，从而实现了应用程序之间的数据交互。使用以特定XML格式设计的数据规范开放数据资源，并允许数据内容、服务方式和实施技术的独立性，从而提高应用程序软件开发和产品组合的灵活性。通过应用统一的组织结构管理要求执行身份验证和角色分配任务，降低了应用程序软件部署的复杂性，简化了用户身份管理任务。通过允许在不同应用程序软件之间共享数据的数据流功能，可以发送作业信息通知。三、接口技术规范所有应用程序软件都可以在基本级别细分为四个任务：添加、删除、修改和查询数据。为此，还制定了统一的接口技术规范，以明确写入、读取和查询三个任务。1.界面的功能说明调用写入操作，使应用程序执行元数据的添加、删除和修改操作。元数据是应用程序软件中最基本的数据，如果一个数据已分解，在整个应用程序软件中不再有其他含义，则称为元数据。元数据以外的数据不调用写入操作。调用读取操作以获取应用程序的特定数据。读取作业可以导入元数据或具有固定数据标识和类型的单个数据。调用查询操作以从应用程序软件中检索相关数据。查询操作可以包含很多查询条件，应用程序从系统中检索符合条件的数据，然后将其返回给调用方。2.界面的参数和返回值说明写操作的主要参数是符合用户id、应用id、数据id、数据类型和数据规范格式的XML数据。参数的含义如下：使用者ID会显示为UserID，使用套用软体介面时会先提供认证资讯，验证后会取得使用者ID，后续存取会指出使用UserID存取介面的使用者id，而使用结束介面则需要执行使用者id登出作业。有关获取和注销用户id的操作，请参阅第v节“身份验证和管理规范”。应用id用TaskGuid表示，由于系统集成实现可能会在未来的应用程序软件中包含多个专业应用程序，因此在调用时，可以区分不同的接口。TaskGuid采用标准Guid格式，TaskGuid的值按系统构建部门统一定义，一个应用程序只能定义一个应用id，如数据规范文档中所述。数据标识符用数据guid表示。每个唯一数据必须具有唯一的id，用于区分不同的数据。添加、删除和修改数据的操作都使用数据guid作为关键字，因此必须按照guid标准统一生成数据GUID，以避免在不同的系统上和work bench中使用不同的数据复盖数据。数据类型显示为DataType。每个数据规范必须定义唯一的数据类型。应用程序根据DataType的相应数据规范解析记录的数据，每个应用的数据类型都可以重复。符合数据规范格式的XML数据显示为XmlData。表示创建的特定数据，如果没有标识为与数据类型对应的数据的元数据，则执行数据增长操作。如果已存在由与数据类型对应的数据标识的元数据，请执行数据更新操作。如果XmlData为null或没有子节点的XML数据，则删除与数据id相对应的元数据。写入操作的返回结果表示数据已写入软件。返回0表示数据写入操作成功，返回-1表示数据格式不符合要求，返回-2表示数据写入逻辑无效。返回-3表示没有数据写入权限，返回其他值表示查询“数据写入操作错误信息”，以获得具体含义，查询时使用读取操作。其中，任务guid参数是应用id，数据guid参数是“c61ed 474-E8 B1-4f B4-8975-74b 356 CAA 22 b”，DataType参数是“ErrorList”。返回数据格式如下：错误消息说明错误消息说明错误信息说明.错误代码必须大于100或小于负值100。正负100之间的错误代码不能用作保留值。读取作业的主要参数包括用户id、应用id、数据id和数据类型。参数的含义如下：用户id显示为UserID，具体含义与写入操作参数相同。应用id由TaskGuid表示，其含义与作业参数相同。数据标识符由数据guid表示，每个唯一数据必须具有用于分隔不同数据的唯一id。在读取操作中，数据id表示必须读取的唯一数据。数据类型显示为DataType。每个数据规范必须定义唯一的数据类型。应用程序根据与DataType相对应的数据规范生成读取的数据，每个应用的数据类型都可以重复。读取操作的返回结果是符合数据规范格式的XML数据。如果该数据不存在，则必须遵守数据规范格式并包含所有节点的空数据。如果返回空值，则没有该数据的读取权限，或者应用程序不支持该类型的数据。查询操作的主要参数是符合用户id、应用id和数据规范格式的XML查询命令。参数的含义如下：用户id显示为UserID，具体含义与写入操作参数相同。应用id由TaskGuid表示，其含义与作业参数相同。符合数据规范格式的XML查询命令显示为XmlTransform。将需要查询的条件包含在查询操作中。查询操作的返回结果是符合查询条件的特定数据。批量数据的返回执行数据分页的查询操作。即使查询结果没有符合条件的数据，也必须返回符合格式的数据。如果返回空值，则表示没有该数据的查询权限，或者应用软件不支持该查询操作。接口实现方法不同级别的坞站需求系统接口实现定义了三种方法：网页、web服务和套接字，应用程序必须至少实现一种接口方法之一，实施哪种接口方法将由建设单位明确。l web方法。调用JaveScript的方法之一，该方法使用浏览器的XMLHttpRequest对象向相应网页发出请求或发送数据，以调用应用程序的写入、读取和查询操作。写操作使用“POST”方法将符合数据规范格式的XML字符串发送到提供写操作的网页。用户id、应用id、数据id、数据类型等参数在网页后面跟随字符串：Userid=.taskguid=.dataguid=.datatype=.以的方式传递，返回值是基于数字的字符串。读取操作使用“GET”方法调用提供读取操作的网页。诸如用户id、应用id、数据id和数据类型等参数在网页后面跟随字符串：Userid=.taskguid=.dataguid=.datatype=.以的方式传递，返回值是符合数据规范格式的XML字符串。查询操作使用“POST”方法将符合数据规范格式的XML查询命令发送到提供查询操作的网页。用户id和应用id等参数在网页后面跟随字符串：Userid=.taskguid=.以的方式传递，返回值是符合数据规范格式的查询结果字符串。提供写、读和查询操作的网页可以通过一个网页文件执行其功能。l web服务方法。此方法是置备函数调用接口，任何能够支持web服务调用的软件都可以使用该接口调用应用程序的写入、读取和查询操作。web服务必须遵循附件1中的WSDL定义，以实现以下三个函数：写入操作调用web服务的SetData函数，参数根据函数传递，返回值是数值。函数基本体包括：Setdata (userid as string，task guid as string，data guid as string，datatype as string，XML data as string) asint读取操作调用web服务的GetData函数，参数以函数方式传递，返回值是遵循数据规范格式的XML字符串。函数基本体包括：Getdata (userid as string，task guid as string，data guid as string，datatype as string) as string查询操作调用web服务的TransformData函数，参数以函数方式传递，返回值是遵循数据规范格式的查询结果字符串。函数基本体包括：Transformdata (userid as string，task guid as string，XML transform as string) as stringl插槽方式。这种方法是使用通信端口工作的接口。将指定格式的数据发送到通信端口，以实现对应用程序软件的写入、读取和查询操作。写入操作将以下格式的数据发送到通信端口：应用用户标识标识数据标识数据类型./符合数据规范格式的XML数据返回值是基于数字的字符串。读取操作将以下格式的数据发送到通信端口：应用用户标识标识数据标识数据类型返回值是遵循数据规范格式的字符串。查询操作将以下格式的数据发送到通信端口：应用用户id应用id./符合数据规范格式的XML查询命令返回值是遵循数据规范格式的查询结果字符串。4.批量数据处理系统接口将XML用作数据传输格式，因此在实际应用程序中数据传输时间比数据处理时间长得多，并且在大型数据交互应用程序中，由于每个写入、读取和查询操作仅写入或反馈一个数据会显着影响系统效率，因此定义了批量数据处理方法以满足大型应用程序的要求。批量数据使用Documents作为根节点，并包含符合数据规范的Document子节点集。数据格式如下：.写入操作中的批量数据使用嵌入的应用id、数据id和数据类型(而不是TaskGuid、DataGuid和DataType参数)，对数据的每个Document执行独立写入操作，并忽略批量写入操作提供的这三个参数。在读取和查找操作中使用批量数据允许根据实际逻辑定义批量数据反馈格式。四、数据格式规范要在不同的软件界面中使用相同的数据，数据必须遵循通用的描述方法。为了便于计算机处理数据，以及帮助人们理解将XML格式用作所有数据的标准格式，定义为特定XML格式的数据描述称为数据规范。通过数据规格，您可以灵活地实施应用程序的功能数据规范将写入和读取操作的“XML数据”、查询操作的“XML查询命令”和“XML查询结果”包含在应用程序软件界面中。大型应用程序的数据规格雇佣专业单位独立设计，小型应用程序的数据规格负责软件开发单位的设计。1.数据规范的基本结构基本数据规范必须符合以下基本格式：属性节点Type=类型其他属性=内容属性值属性节点.将根节点命名为Do