使用协作草稿功能开发事务应用

ABAP RESTful 应用程序编程模型 › 开发 › 开发应用程序 › 使用协作草稿功能开发事务应用

通过协作草稿功能,您可以邀请用户同时编辑同一草稿实例。

前提条件

协作草稿的实施前提条件与专用草稿的实施前提条件相同。更多信息,请参阅草稿启用被管理业务对象。

您还可以使用 OData UI 服务 从头开始为启用草稿的业务对象 (BO) 生成必要部件。有关详细信息,请参阅从头开始的 OData UI 服务。

上下文

业务对象的协作草稿功能在行为定义中定义。您可以从头开始构建协作性草稿业务对象,也可以将协作功能添加到具有两种实施类型 managed 或 unmanaged 中已实施独占草稿功能的业务对象中,以便多个用户可以同时编辑同一草稿实例。业务对象只能使用独占草稿或协作草稿启用草稿。草稿功能适用于整个业务对象。无法为业务对象中的单个实体实施草稿功能。有关草稿概念的详细信息,请参阅草稿和草稿处理。

本主题介绍如何在 ABAP RESTful Application Programming Model (RAP) 的上下文中实施协作草稿,以及如何邀请用户加入 SAP Fiori UI 上业务对象的草稿实例。以下代码示例基于托管业务对象,您可以下载并导入到开发环境中。有关详细信息,请参阅下载 ABAP 航班参考场景。

过程

要为业务对象启用协作草稿功能,请执行以下操作:

  1. 在基础层行为定义的标头中,添加语法元素 with collaborative draft。

    备注

    如果使用具有独占草稿的已启用草稿的业务对象,请将语法元素 with draft 更改为 with collaborative draft。

    示例代码

    managed implementation in class /DMO/BP_R_TravelTP_CD unique;
    strict ( 2 );
    with collaborative draft;
    extensible;
    

    备注

    最初,出现警告是因为您尚未实施草稿操作 Share。

  2. 将 draft action Share 添加到基础层的行为定义。

    示例代码

    draft action Activate optimized;
      draft action Discard;
      draft action Edit;
      draft action Resume;
      draft determine action Prepare;
      draft action Share;
    
  3. 在投影层行为定义的标头中,添加语法元素 use collaborative draft。如果已使用接口层,则还必须在此使用 语句。

    备注

    如果使用具有独占草稿的已启用草稿的业务对象,请将语法元素 use draft 更改为 use collaborative draft。

    示例代码

    projection implementation in class /DMO/BP_C_TravelTP_CD unique;
    strict ( 2 );
    extensible;
    use collaborative draft;
    use side effects;
    

    备注

    最初,出现警告是因为您尚未声明草稿操作 Share 的使用。

  4. 将语句 use action Share 添加到行为定义的投影层。如果已使用接口层,则还必须在此使用 语句。

    示例代码

    use action Activate;
    use action Discard;
    use action Edit;
    use action Resume;
    use action Prepare;
    use action Share;
    

    备注

    仍会出现警告,因为您尚未实施必要的查询草稿视图。

    产生的映射行为定义如下所示:

    展开以下代码示例以查看行为定义的源代码 /DMO/C_TRAVELTP_CD。

    示例代码

    projection implementation in class /DMO/BP_C_TravelTP_CD unique;
    strict ( 2 );
    extensible;
    use collaborative draft;
    use side effects;
    
    define behavior for /DMO/C_TravelTP_CD alias Travel
    extensible
    use etag
    {
      use create;
      use update;
      use delete;
    
      use action Activate;
      use action Discard;
      use action Edit;
      use action Resume;
      use action Prepare;
      use action Share;
    
      use association _Booking { create; with draft; }
    }
    
    define behavior for /DMO/C_BookingTP_CD alias Booking
    extensible
    use etag
    {
      use update;
      use delete;
    
      use association _Travel { with draft; }
    }
    
  5. 对于协作草稿,authorization master 实体需要草稿查询视图。草稿查询视图允许您根据数据控制语言 (DCL) 定义草稿数据的 READ 访问限制。创建新的视图实体作为草稿查询视图,并将草稿数据库表作为参考对象。

    有关草稿查询视图的详细信息,请参阅草稿查询视图。

    在此场景中,草稿查询视图从根实体 /DMO/D_TRAVEL_CD 的草稿数据库表 /DMO/R_TravelTP_CD 中进行选择。草稿查询视图必须具有从根实体的相应 DCL 继承其访问条件的 DCL:

    展开以下代码示例以查看草稿查询视图 /DMO/R_TRAVELTPDRAFT_CD 的源代码。

    示例代码

    @AccessControl.authorizationCheck: #MANDATORY
    @Metadata.allowExtensions: true
    @EndUserText.label: 'Draft Query View /DMO/D_TRAVEL_CD'
    define view entity /DMO/R_TRAVELTPDRAFT_CD
      as select from /dmo/d_travel_cd
    {
      key traveluuid as TravelUuid,
      travelid as TravelId,
      begindate as BeginDate,
      enddate as EndDate,
      bookingfee as BookingFee,
      currencycode as CurrencyCode,
      description as Description,
      localcreatedby as LocalCreatedBy,
      localcreatedat as LocalCreatedAt,
      locallastchangedby as LocalLastChangedBy,
      locallastchangedat as LocalLastChangedAt,
      lastchangedat as LastChangedAt,
      draftentitycreationdatetime as draftentitycreationdatetime,
      draftentitylastchangedatetime as draftentitylastchangedatetime,
      draftadministrativedatauuid as draftadministrativedatauuid,
      draftentityoperationcode as draftentityoperationcode,
      hasactiveentity as hasactiveentity,
      draftfieldchanges as draftfieldchanges
    }
    

    确保删除为您生成的注释 @Metadata.ignorePropagatedAnnotations 或将其值设置为 false。如果将值设置为 true,请注意,您必须自己在草稿查询视图中维护注释。

    备注

    如果您的活动业务对象视图实体受 DCL 保护,则必须使用数据控制语言 (DCL)。

  6. 通过添加 query 关键字将草稿查询视图添加到行为定义中的草稿表声明:

    示例代码

    define behavior for /DMO/R_TravelTP_CD alias Travel
    persistent table /dmo/a_travel_cd
    extensible
    draft table /dmo/d_travel_cd query /DMO/R_TravelTPDraft_CD
    

    在投影 BDEF 中,草稿查询视图自动从基本 BDEF 继承。因此,对草稿数据的所有访问限制都在映射 BDEF 中重用。

    生成的基本 BDEF 如下所示:

    展开以下代码示例以查看**行为定义的源代码 /DMO/R_TRAVELTP_CD。

    示例代码

    managed implementation in class /DMO/BP_R_TravelTP_CD unique;
    strict ( 2 );
    with collaborative draft;
    extensible;
    
    define behavior for /DMO/R_TravelTP_CD alias Travel
    persistent table /dmo/a_travel_cd
    extensible
    draft table /dmo/d_travel_cd query /DMO/R_TravelTPDraft_CD
    etag master LocalLastChangedAt
    lock master total etag LastChangedAt
    authorization master ( global, instance )
    {
      field ( readonly )
      TravelUuid,
      LocalCreatedBy,
      LocalCreatedAt,
      LocalLastChangedBy,
      LocalLastChangedAt,
      LastChangedAt;
    
      field ( numbering : managed )
      TravelUuid;
    
      field ( readonly : update, mandatory : create )
      TravelId;
    
      create ( authorization : global );
      update;
      delete;
    
      draft action Activate optimized;
      draft action Discard;
      draft action Edit;
      draft action Resume;
      draft determine action Prepare;
      draft action Share;
    
      association _Booking { create; with draft; }
    
      mapping for /dmo/a_travel_cd corresponding extensible
        {
          BeginDate          = begin_date;
          BookingFee         = booking_fee;
          CurrencyCode       = currency_code;
          Description        = description;
          EndDate            = end_date;
          LastChangedAt      = last_changed_at;
          LocalCreatedAt     = local_created_at;
          LocalCreatedBy     = local_created_by;
          LocalLastChangedAt = local_last_changed_at;
          LocalLastChangedBy = local_last_changed_by;
          TravelId           = travel_id;
          TravelUUID         = travel_uuid;
        }
    
    }
    
    define behavior for /DMO/R_BookingTP_CD alias Booking
    persistent table /dmo/a_book_cd
    extensible
    draft table /dmo/d_book_cd
    etag dependent by _Travel
    lock dependent by _Travel
    authorization dependent by _Travel
    {
      field ( readonly )
      BookingUuid,
      TravelUuid;
    
      field ( numbering : managed )
      BookingUuid;
    
      field ( readonly : update, mandatory : create )
      BookingId;
    
      update;
      delete;
    
      association _Travel { with draft; }
    
      mapping for /dmo/a_book_cd corresponding extensible
        {
          BookingDate  = booking_date;
          BookingId    = booking_id;
          BookingUUID  = booking_uuid;
          CurrencyCode = currency_code;
          FlightDate   = flight_date;
          FlightPrice  = flight_price;
          TravelUUID   = parent_uuid;
        }
    }
    
  7. 为草稿查询视图创建新的 DCL。确保数据控制语言从业务对象的根视图实体继承条件。在此场景中,它从实体 /DMO/R_TravelTP_CD 继承条件。

    展开以下代码示例以查看**草稿查询视图的访问控制源代码 /DMO/R_TRAVELTPDRAFT_CD。

    示例代码

    @EndUserText.label: 'Mapping role for /DMO/R_TravelTPDraft_CD'
    @MappingRole: true
    define role /DMO/R_TravelTPDraft_CD {
      grant
        select
          on
            /DMO/R_TravelTPDraft_CD
              where
                inheriting conditions from entity /DMO/R_TravelTP_CD;
    
    }
    

结果

激活所有部件后,将立即为业务对象启用协作草稿功能。现在,已创建草稿实例的业务用户可以借助用户清单邀请其他业务用户加入草稿实例。业务用户可以通过从清单报表导航到草稿实例,然后单击添加用户图标来访问用户清单。

“帮助用户列表”的用户邀请视频

在新窗口中打开此视频