Configuring Alerts for the Publication Hub

We're trying to figure out where the Publication Hub fits in our organization and one of the surprising aspects so far is that it does not appear to alert authors in any way when they have been added to a review. Is there a way of adding email alerts? We use the  Review Space for managing reviews with SMEs and other occasional users, so if users have to log in and check to see if they have work, they're never seeing their work. 

emoji
Parents
  • Hello Jeff,

    It is valid to mention here that Publication Hub is not only the place where publication captains can create the project, assemble the team, and track the progress. Publication Hub is also a landing page where writers and reviewers can easily access the assignments they need to work on and quickly navigate to the respective applications (Collective Spaces, Publication Manager) to do their work.

    So users can land in Organize Space and see their assignments, with a due date on the project that helps to set the priorities, unless they are communicated externally, and can easily navigate to the appropriate application to perform their work.

     

    IWrite plugins can be used to enable email notifications for the project-level updates in the Publication Hub.

    We do have one out-of-the-box plugin that is disabled by default.

    It allows customers to validate if the project description is filled in.

    This plugin can be useful for customers who require the storage of project information in the system.

    For example, instructions or deadlines for each project phase that are needed to meet the project due date.

    To enable it, you should uncomment the plugin configuration in XML Settings > IWrite plugins area

    <write ishcondition="ISHType='ISHProject'">
    
      <body>
    
         <sequence>
    
          <plugin name="CHECKFDESCRIPTION" handler="CheckMandatoryField" ishcondition="CurrentAction in ('Create', 'Update') and (ISHLevel='project')">
    
             <description>Checks that the assignee message is filled</description>
    
              <workingset>
    
               <ishfields>
    
                 <ishfield name="FDESCRIPTION" level="project" />
    
               </ishfields>
    
             </workingset>
    
             <initialize>
    
              <parameters>
    
                 <parameter name="MetadataField">FDESCRIPTION</parameter>
    
                 <parameter name="MetadataFieldLevel">project</parameter>
    
              </parameters>
    
             </initialize>
    
          </plugin>
    
         </sequence>
    
      </body>
    
     </write>

     

    You can write your custom IWrite plugin to track the progress of the projects. For example, by tracking project status or the number of approved and total number of assignees for the project.

    This can be achieved by subscribing to changes on FISHPROJECTSTATUS, FISHAPPROVEDASSIGNEESCOUNT, FISHTOTALASSIGNEESCOUNT fields.

    Another use case is to track changes for Due dates, either review or general for the project.

    Respective fields are FISHREVIEWDUEDATE and FISHDUEDATE.

    The event data from custom plugins can be used by the Mailer application (it is part of IshCD and can be used for email broadcasting) that is executed in the context of a custom BackgroundTask.

     
    Regarding your particular case, which was raised in the question.

    For your case, it comes to the projectAssignee level.

     

    We are looking for an option to include an out-of-the-box plugin in the upcoming release.

    That plugin will be able to create event data for the case when projectAssignee level data was created or updated.

    This can be useful in such cases:

    • Track when a new assignee was added to the project
    • Track when the assignee signed off the project, and with what sign-off message.

     

    The event data from this plugin can be used by the Mailer application (it is part of IshCD and can be used for email broadcasting) that is executed in the context of a custom BackgroundTask.

     

    Although it is also possible to implement your use case using existing APIs.

     Again custom IWrite plugin can be used to enable email notifications.

    I will mention the required steps on a high level, and in case you are interested in details, please let me know, and I will share.


    So in your IWrite plugin code:

    1. You subscribe to updates for the Project object on the FISHASSIGNEES field and process the events.
    2. In order to know which assignees are added or removed, you need to compare the original and current values
    3. Get the value with valuetype ID of the project assignees in the field FISHASSIGNEES using the information on IWriteMetadataContext
    4. Do the conversion from project assignees in the field FISHASSIGNEES on the project to the FISHASSIGNEE on the project assignee level, which is the user. For this, such an endpoint can be used /v3/Projects/ByAssigneeCardId/{AssigneeCardId} 
    5. The user can then be passed to /v3/Users/{Id} to retrieve the field FISHEMAIL to get the email address of the user

    Before doing step 4 in your code, you need to authorize in Tridion Docs OpenAPI using the clientID and clientSecret of the service account.

    Your plugin code should trigger a custom BackgroundTask and pass the required event data and email to it.

    That BackgroundTask will process the data and execute the Mailer application (that can be found on IshCd\Applications\Utilities\Mailer). Mailer application will send email notifications.

    Hope that helps, and please let me know if you need more details

      emoji
    Reply
    • Hello Jeff,

      It is valid to mention here that Publication Hub is not only the place where publication captains can create the project, assemble the team, and track the progress. Publication Hub is also a landing page where writers and reviewers can easily access the assignments they need to work on and quickly navigate to the respective applications (Collective Spaces, Publication Manager) to do their work.

      So users can land in Organize Space and see their assignments, with a due date on the project that helps to set the priorities, unless they are communicated externally, and can easily navigate to the appropriate application to perform their work.

       

      IWrite plugins can be used to enable email notifications for the project-level updates in the Publication Hub.

      We do have one out-of-the-box plugin that is disabled by default.

      It allows customers to validate if the project description is filled in.

      This plugin can be useful for customers who require the storage of project information in the system.

      For example, instructions or deadlines for each project phase that are needed to meet the project due date.

      To enable it, you should uncomment the plugin configuration in XML Settings > IWrite plugins area

      <write ishcondition="ISHType='ISHProject'">
      
        <body>
      
           <sequence>
      
            <plugin name="CHECKFDESCRIPTION" handler="CheckMandatoryField" ishcondition="CurrentAction in ('Create', 'Update') and (ISHLevel='project')">
      
               <description>Checks that the assignee message is filled</description>
      
                <workingset>
      
                 <ishfields>
      
                   <ishfield name="FDESCRIPTION" level="project" />
      
                 </ishfields>
      
               </workingset>
      
               <initialize>
      
                <parameters>
      
                   <parameter name="MetadataField">FDESCRIPTION</parameter>
      
                   <parameter name="MetadataFieldLevel">project</parameter>
      
                </parameters>
      
               </initialize>
      
            </plugin>
      
           </sequence>
      
        </body>
      
       </write>

       

      You can write your custom IWrite plugin to track the progress of the projects. For example, by tracking project status or the number of approved and total number of assignees for the project.

      This can be achieved by subscribing to changes on FISHPROJECTSTATUS, FISHAPPROVEDASSIGNEESCOUNT, FISHTOTALASSIGNEESCOUNT fields.

      Another use case is to track changes for Due dates, either review or general for the project.

      Respective fields are FISHREVIEWDUEDATE and FISHDUEDATE.

      The event data from custom plugins can be used by the Mailer application (it is part of IshCD and can be used for email broadcasting) that is executed in the context of a custom BackgroundTask.

       
      Regarding your particular case, which was raised in the question.

      For your case, it comes to the projectAssignee level.

       

      We are looking for an option to include an out-of-the-box plugin in the upcoming release.

      That plugin will be able to create event data for the case when projectAssignee level data was created or updated.

      This can be useful in such cases:

      • Track when a new assignee was added to the project
      • Track when the assignee signed off the project, and with what sign-off message.

       

      The event data from this plugin can be used by the Mailer application (it is part of IshCD and can be used for email broadcasting) that is executed in the context of a custom BackgroundTask.

       

      Although it is also possible to implement your use case using existing APIs.

       Again custom IWrite plugin can be used to enable email notifications.

      I will mention the required steps on a high level, and in case you are interested in details, please let me know, and I will share.


      So in your IWrite plugin code:

      1. You subscribe to updates for the Project object on the FISHASSIGNEES field and process the events.
      2. In order to know which assignees are added or removed, you need to compare the original and current values
      3. Get the value with valuetype ID of the project assignees in the field FISHASSIGNEES using the information on IWriteMetadataContext
      4. Do the conversion from project assignees in the field FISHASSIGNEES on the project to the FISHASSIGNEE on the project assignee level, which is the user. For this, such an endpoint can be used /v3/Projects/ByAssigneeCardId/{AssigneeCardId} 
      5. The user can then be passed to /v3/Users/{Id} to retrieve the field FISHEMAIL to get the email address of the user

      Before doing step 4 in your code, you need to authorize in Tridion Docs OpenAPI using the clientID and clientSecret of the service account.

      Your plugin code should trigger a custom BackgroundTask and pass the required event data and email to it.

      That BackgroundTask will process the data and execute the Mailer application (that can be found on IshCd\Applications\Utilities\Mailer). Mailer application will send email notifications.

      Hope that helps, and please let me know if you need more details

        emoji
      Children
      No Data