通用消息实施
ABAP RESTful 应用程序编程模型 › 学习 › 业务对象 › 消息 › 通用消息实施
通用消息实施
通常,对于每个场景,消息创建和到报告结构的分配都相同:
APPEND VALUE #(
%tky = instance-%tky
%msg = NEW message_exception(
textid = message_exception=>message_exception_constant
severity = if_abap_behv_message=>severity-severity
message_variable = instance-field )
%element-field1 = if_abap_behv=>mk-on
%element-field2 = if_abap_behv=>mk-on
%element-_association = if_abap_behv=>mk-on
%op-%create = if_abap_behv=>mk-on
%op-%action-action1 = if_abap_behv=>mk-on
%state_area = 'state_area'
%path = VALUE #( <root>-%is_draft = <child>-%is_draft
<root>-<key> = <child-<parent_key_in_child_entity> )) TO reported-business_object_entity.
APPEND:将消息附加到报告的结构%tky:%TKY可以唯一标识消息所属的实例。状态消息始终需要%TKY- 如果通过 EML 访问状态消息,则仅当实例的%TKY已知时才能返回相应的消息。对于转换消息,框架需要%TKY来解析%element-field1目标分配。如果转换消息没有%TKY,则不会在 OData 响应中解析目标,并且框架会将消息解释为未绑定转换消息。Message_Exception:在此示例中,消息异常类用于封装存储在消息类中的消息,以通过异常类处理日期或金额等消息变量类型的格式。如有必要,您可以调整消息异常类以满足特定消息要求。有关示例实施,请参阅创建消息异常类。
Message_Exception_Constant:为消息类中包含的每个消息实施消息常量。常量包含从中提取消息的消息类,以及用于标识一条特定消息及其变量的消息编号。Severity:严重性指定消息是成功、信息、警告还是错误消息。根据严重性,消息在 UI 上以不同的图标和颜色显示。可以在以下选项中进行选择:
成功:成功消息通知用户流程或操作已成功完成。用户方无需执行任何操作。请注意,在某些情况下会忽略成功消息。
信息:信息消息提供有关流程或操作的附加信息。用户方无需执行任何操作。
警告:警告指示可能需要在用户端执行操作。
错误:发生错误,需要在用户界面上执行操作。
Message_Variable:如果要显示的消息需要一个或多个消息变量,则可以传递。建议在消息异常类中尽可能声明所有 CDS 视图字段,但声明可选输入参数,以便您可以根据需要将所有字段用作变量。%element-field1/field2:引用的字段用作消息的目标。这样可以改善用户体验,因为它支持导航并在存在多个错误消息时清除错误分配。%element还可以包含与子节点的关联(例如,销售订单抬头 -> 销售订单项目)。如果目标引用关联,则消息将引用关联的所有子实例。例如,如果没有子实例发出消息,表示父级别必须至少存在一个子项目,这将非常有用。有关如何在 UI 用例中显示目标分配的详细信息,请参阅 UI 上的状态消息。
%op-create/%action-action1:引用的标准操作或非标准操作用于指示reported中的消息所指的操作。如果在一个 EML 或 OData 调用中为同一实体实例执行了多个操作,则%op-indicator 与将消息映射到相应操作相关。还通过组件%op-%action处理功能。此组件仅与转换消息相关。状态消息不属于 操作。
%state_area(仅与状态消息相关):由于已填充此组件,因此将此消息标识为状态消息。对于转换消息,未填充此组件。有关状态消息的详细信息,请参见状态消息。
%path(仅与子实体相关):路径组件将子实体映射到其父项。如果存在具有多个子实体的业务对象,则会扩展%PATH组件以将子实体映射到其父实体和业务对象根。REPORTED-BUSINESS_OBJECT_ENTITY:由于此消息已分配到特定业务对象实体,因此将其绑定。未绑定的消息分配到%other组件,而不是特定实体。长文本:如果消息具有长文本,则长文本将与消息一起自动显示在 UI 上,无需附加实施。
来源:SAP Help Portal · 2025 FPS02 (Oct 2026) · 中文为 SAP 官方机器翻译