简单值帮助

ABAP RESTful 应用程序编程模型 › 开发 › 开发 UI 特定 › 添加值帮助 › 简单值帮助

如果要显示输入字段值帮助提供者中的值,简单的值帮助非常方便。

上下文

您想要为 UI 上的输入字段提供值帮助。

以下步骤使用预订 CDS 视图作为示例,为客户标识字段实施值帮助。

过程

  1. 为用作值帮助提供者的 CDS 视图创建数据定义。它必须包含具有源视图中输入字段的可用值的字段。

    示例

    值帮助提供者视图包含客户标识和用于标识客户标识的字段,例如客户名称或地址。然后,最终用户可以按这些字段进行筛选以查找正确的客户标识。

    define view entity /DMO/I_Customer_VH as select from /dmo/customer
    {
    key customer_id,
    first_name,
    last_name,
    title,
    street,
    postal_code,
    city,
    country_code,
    phone_number,
    email_address
    }
    

    要在调用值帮助时检索完整的值列表,请使用注释 @Consumption.valueHelpDefault.fetchValues: #AUTOMATICALLY_WHEN_DISPLAYED 注释值帮助视图。要显式禁用加载完整列表,请使用 @Consumption.valueHelpDefault.fetchValues: #ON_EXPLICIT_REQUEST。

  2. 在 CDS 源视图中,将以下注释添加到要在 UI 上提供值帮助的元素。

          @Consumption.valueHelpDefinition: [{  entity: {   name: 'entityRef' ,
                                                            element: 'elementRef'  }     }]
    

    注释定义值帮助到提供实体的值帮助的绑定。您必须指定实体名称和为注释元素提供可能值的元素。

    示例

    以下代码示例显示如何在 /DMO/I_Booking 中的元素 CustomerID 上使用注释。它参考客户标识的值帮助提供者视图 (/DMO/I_CUSTOMER_VH) 以及在值帮助提供者视图中提供可能值 (customer_id) 的元素。

    define view /DMO/I_Booking as select from /dmo/booking
    {…
            @Consumption.valueHelpDefinition: [{entity: { name: '/DMO/I_CUSTOMER_VH',
                                                          element: 'customer_id'  }}]
    customer_id as CustomerID,
    … }
    

结果

如果在 OData 服务中公开源视图,则值帮助提供者视图将自动与其公开。您不必在服务定义中列出值帮助提供者视图。

在 Fiori UI 上,在选择字段中选择 F4 会打开搜索掩码,最终用户可以按值帮助提供者视图中的任何字段进行过滤。选择条目会将 注释中引用的元素的值传输到源视图中的注释元素。

OData 服务的元数据显示以下属性的值帮助实施:

  • 为其实施值帮助的 CDS 源视图中的属性 (sap:value-list="standard")

  • 值帮助提供者实体类型 (sap:value-list="true")

  • 值帮助提供者实体在 Annotations 属性中标记为 Target。值列表枚举值帮助提供者中为值帮助 (Annotation Term="Common.ValueList") 公开的每个属性。

  • 在映射条件中定义的元素标记为入站和出站参数 Record Type="Common.ValueListParameterInOut"。

展开以查看公开预订 CDS 视图的服务的元数据文档提取和元素 CustomerID 的值帮助提供者。

限制

如果将值帮助提供者与源视图相关联,则值帮助提供者视图的元数据不具有 sap:value-list="true"。因此,请求 <service_url>/$metadata?sap-value-list=<service_namespace>.<entity>Type/<element>(其中 <element> 是在 CDS 视图的注释 @Consumption.ValueHelpDefinition 中引用的元素)不起作用。调用值帮助时这可能会导致问题。

为避免此冲突,请分离值帮助提供者视图中与其他相关视图(例如文本提供者视图)不一致的值帮助信息。

其他值帮助选项

值帮助提供者的其他功能

评估在值帮助提供者中维护的任何注释。这意味着以下功能可用于值帮助:

  • *关联:*如果关联的目标包含在 OData 服务中,则与值帮助提供者相关联的实体的元素也会显示为附加输入字段。

  • *搜索功能:*将搜索功能包括在值帮助提供者中,使最终用户能够在输入字段中搜索任何详细信息。

  • *值帮助:*值帮助本身可以包含值帮助。

  • *文本:*还会显示为值帮助提供者提供的文本。

值帮助作为下拉列表

如果只想将输入字段的可能值显示为下拉列表,而不是使用值帮助提供者的所有其他元素的搜索掩码,请在视图级别使用 @ObjectModel : { resultSet.sizeCategory: #XS } 注释值帮助提供者。

对于下拉列表值列表,OData $metadata 文档在已为其实施值帮助的源视图中的 属性上包含注释 sap:value-list= "fixed-values" 而不是 standard。

下拉菜单值帮助

选择字段中的值帮助预先输入

在选择字段中输入内容时可显示值帮助提供者视图的条目。从打开的清单中,您可以选择一个条目,用所需值填充选择字段:

输入帮助预先输入

要应用提前输入功能,必须首先启用具有搜索功能的值帮助提供者实体。此操作通过使用注释 @Search.searchable: true 在值帮助级别完成。值帮助提前键入仅从值帮助提供者中查找使用 @Search.defaultSearchElement: true 注释的值。

示例

如果要显示客户的客户信息,其中名字、姓氏和城市以 V 开头,则必须使用 @Search.defaultSearchElement: true 对值帮助提供者实体中的相应元素进行注释。

要将值帮助列表限制为特定元素,请使用 @UI.lineItem.importance: #HIGH 对要显示的元素进行注释。然后,值帮助清单不会考虑重要性较低的其他元素。

通过关联的值帮助

如果值帮助提供者已与源实体相关联,则可以使用关联 @Consumption.valueHelpDefinition.association: 'Assoc' 并引用关联 而不是实体 。然后,绑定条件已在关联的 on 条件中提供。

示例

以下代码示例显示如何在 /DMO/I_Booking 中的元素 CustomerID 上使用 注释。它参考值帮助提供者视图 (_Customer) 的关联。

define view /DMO/I_Booking as select from /dmo/booking
association [0..1] to /DMO/I_Customer_VH as _Customer on $projection.CustomerID = _Customer.customer_id
{…
        @Consumption.valueHelpDefinition.association: '_Customer'
customer_id as CustomerID,
…
_Customer
}

备注

通过关联使用值帮助选项时,无法确保值帮助正常工作,请参阅限制。

来源:SAP Help Portal · 2025 FPS02 (Oct 2026) · 中文为 SAP 官方机器翻译

← 添加值帮助 · 含附加绑定的值帮助 →