Anpassa granskningsappen

För att göra det enklare att anpassa granskningsappen har vi tagit fram några krokar som listas och förklaras nedan:

Review-Comment

Som nämndes här hamnar alla nya attribut som läggs till under anpassningen under this.model.extraProps. Med metoden updateExtraProps kan du lägga till attribut i en granskningskommentar och även hantera uppdateringen och lagringen av det tillagda attributet på servern.

Exempel på användning

Du vill till exempel lägga till fält commentRationale och severity i dina kommentarer.
Låt oss uppdatera commentRationale till"This is an important sentence." och severity till"CRITICAL".
Detta kan göras med syntaxen:

  this.next('updateExtraProps', {
    'commentRationale': 'This is an important sentence.',
    'severity': 'CRITICAL'
  })

Ovanstående kodfragment hanterar uppdatering och sparande av värdena. De sparade värdena kan återges i användargränssnittet genom att definiera vyn.

{
    "component" : "label",
    "label": "@extraProps.commentRationale"
}

Panelen Textbunden granskning

Den här kroken är bra om du vill utöka en event och skicka extraProps från den interna granskningspanelen. Vi kommer att förklara användningen av de här två krokarna nedan.

Exempel på intern granskningspanel

Anta att vi vill skicka en extraProp, userInfo, varje gång en ny kommentar eller ett nytt svar skickas. Detta görs nu via den interna granskningspanelen, men vi har inte en referens till commentId för den nyligen genererade kommentaren, och därför kan vi skriva följande kod för att uppnå detta.

    onNewCommentEvent(args){
      const events = _.get(args, "events")
      const currTopicIndex = tcx.model.getValue(tcx.model.KEYS.REVIEW_CURR_TOPIC) || this.getValue('currTopicIndex') || "0"
      const event = _.get(_.get(events, currTopicIndex), '0')
      const newComment = _.get(args, 'newComment')
      const newReply = _.get(args, 'newReply')
      if ((newComment || newReply) && event) {
        this.next('setUserInfo', event)
      }
    },

I ovanstående kodfragment kontrollerar vi om den skickade händelsen var en ny kommentar eller ett nytt svar. Om det finns en ny kommentar eller ett nytt svar anropar vi metoden setUserInfo

    const getUserInfo = (userId) => {
      return $.ajax({
        url: '/bin/dxml/xmleditor/userinfo',
        data: {
          username: userId,
        },
        success: (data) => {
          return data
        }
      })
    }

    setUserInfo(event) {
      getUserInfo(event.user).done(userData => {
        const extraProps = {
          "userFirstName": userData?.givenName || '',
          "userLastName": userData?.familyName || '',
          "userTitle": userData?.title || '',
          "userJobTitle": userData?.jobTitle || '',
          'userEmail': userData?.email || '',
        }
        const data = {... event, extraProps}
        this.next(
          'sendExtraProps',
          data
        )
      })
    },

I ovanstående metod utökar vi händelsen till att skicka extraProps som innehåller användarens förnamn, e-postadress, titel osv. Genom att utöka händelsen på det här sättet ser du till att extraProps skickas med rätt commentId och ser till att de bifogas till rätt kommentar.

Haken updateExtraProps anropar automatiskt kroken sendExtraProps, så när ska du använda vad?

Vi använder updateExtraProps i kontrollenheten review_comment som redan har kommentarens id och därför behöver du bara ange extraProps.

inline_review_panel har dock inte åtkomst till kommentarens ID. Därför kommer sendExtraProps att vara användbart varje gång du behöver skicka en händelse från den interna granskningspanelen.