All pages
Powered by GitBook
1 of 6

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Task - Rebase and Promotion

How do I... ?

  • Rebase my task from the project (synchronize with changes made in its parent project since task creation)

  • Promote my (non-complex) task changes to their parent project (share with other authors)

  • Promote my (complex) task changes to their parent project (share with other authors)

  • Promote my (batch) task changes to their parent project (share with other authors)

Automatically Promote my task changes to their parent project (share with other authors)
Provide Feedback

Automatically Promote my task changes to their parent project (share with other authors)

Steps
References

After making the desired content changes, press Begin Promotion Automation in the Task View - Task Details panel actions button list.

A "Preparing for task promotion automation..." notification is presented in the page header bar.

The automated promotion process first checks to see if the task has been reviewed.

If a review has not yet been completed the Promote Task dialogue presents a warning message with calls to action to either continue or return to task editing and cancel the promotion.

Press Promote Anyway to continue the promotion process.

Press Return To Task to close the dialogue and stop the promotion process.

Following the review check, the task is then placed in a promotion automation queue.

A notification panel showing "Automated promotion in progress: Status Queued" is presented between Edit Task Details and Classify in the Task View - Task Details panel actions button list.

An "Automated promotion: Queued" status icon is also presented in the page header bar.

When picked up from the queue, the task is checked to see if needs to be rebased.

If the task content is diverged from its parent project content, the process initiates a task rebase, and the notification panel changes to "Automated promotion in progress: Status: Rebasing".

If rebase completes with no conflicts, the auto-promotion process continues.

After confirming that the task does not have any rebase conflicts, classification is invoked to ensure all content changes are classified prior to promotion.

The process notification panel changes to "Automated promotion in progress: Status Classifying"

The page header bar icon changes to "Classification Running".

Once the promotion automation invokes the classification process, the My Tasks view task Status column entry changes to Auto Classifying.

If classification detects results (unclassified task content), a header notification states that classification completed successfully with changes found.

If classification does not detect any changes, a header notification states that classification completed successfully with no changes found.

The automation process proceeds with task promotion, following which a header notification states that automated promotion completed for the task.

At this point task actions become inactive, and the process notification panel changes to inform that the task has been promoted and no further changes are allowed.

Promoted tasks are hidden by default in the My Tasks view, however they can be brought into the view listing by checking the Show Promoted checkbox.

Their task status shows Promoted, with a blue background.

All historical promoted tasks are shown when the box is checked, not just the most recently promoted.

Unmet SAC items block automatic promotion

If the task has any Service Acceptance Criteria (SAC) items, task promotion will be blocked and the Begin Promotion Automation action button will not be enabled until all mandatory task-level SAC are met.

Role-based access controls apply to automatic promotion

If the user's authenticated account session roles do not include permissions for task promotion (such as when viewing another author's task), the Begin Promotion Automation action button will not be enabled.

Task review check

The warning is only presented if a review has not been completed.

Task status

After pressing Begin Promotion Automation, the My Tasks view task Status column remains In Progress until the review check is completed.

Provide Feedback

Task review check

If merge conflicts are found during rebase, the automatic promotion process is stopped, and the process notification changes to state that rebase conflicts must be resolved before restarting automatic promotion.

Unclassified content blocks auto-promotion

If classification results are found, the auto-promotion process is stopped, and the process notification panel changes to inform that classification results were detected, with an instruction to review and accept classification results before restarting the auto-promotion process.

Promote my (complex) task changes to their parent project (share with other authors)

Steps
References

The Complex slider control in the upper-right of the Task View - Task Details panel defines whether or not a task is Complex.

Move the Complex slider to the right to set the task as Complex.

This activates any task-level >Service Acceptance Criteria (SAC)> which are defined within the parent project SAC configuration.

Task-level SAC are presented in two lists, between the Task Details section and the Edit Task Details button in the Task View - Task Details panel, and are common to all Complex tasks within the project.

Automatic Task-level SAC are listed to the left, with >Manual Task-level SAC to the right.

Automatic SAC have a yellow warning triangle icon if not yet met, and a green tick if their automated system checks confirm they are satisfied.

Manual SAC are presented initially as open checkboxes, each of which can be interactively checked (green-ticked) when the user's role-based access permissions match those configured for that SAC control.

Once task promotion is enabled, follow the non-complex task steps (included below) to complete promotion of the task.Although the screenshots show simple tasks without task-level SAC, the steps to promote once it is enabled are the same for all tasks.

Steps
References

A "Promoting task..." notification is presented in the page header whilst branch content changes are merged to the project level.

During promotion, the task content branch is locked to prevent any further changes, and a warning notification is presented below the Edit Task Details action button in the Task Details panel.

Whilst this is present, changes cannot be made to the content saved in the task branch, and action buttons other than Edit Task Details and Submit for Review become inactive.

Once task promotion is completed, a "Task successfully promoted for <task-identifer>" notification is presented in the page header.

Following promotion no further changes are allowed on the task content branch, all action buttons in the Task Details panel become inactive, and a warning notification is presented below the now inactive Edit Task Details action button.

Until all mandatory task-level SAC are met, task promotion will be blocked and Promote This Task to the Project in the Task View - Task Details panel actions button list will not be enabled.

Role-based access controls apply to manual task-level SAC

  • Early Visibility Notice if Required

  • Manual spell check

International Authoring - Task SAC - Examples

If the user's authenticated account session roles do not include edit permissions for the task (such as when viewing another author's task), the current manual SAC status will be shown, but cannot be set.

Press a manual SAC checkbox to toggle its status.

It will show a green ticked box when checked, indicating its condition is met.

When all mandatory task-level SAC conditions are met for a Complex task then promotion is enabled and Promote This Task to the Project in the Task View - Task Details will become active.

The example shown in the screenshot shows a Complex task which requires a review to be completed ("Review complete" mandatory automated Task-level SAC) and also for the author to confirm that the task validation report has no task-level RVF assertion failures ("RVF Report Clean" mandatory manual Task-level SAC).

Press Promote This Task to the Project in the Task View - Task Details panel actions button list

A "Preparing for task promotion" notification is presented in the page header, and the Promote This Task to the Project button is disabled.

Task promotion has implicit checks for the following conditions:

  • No content changes made in the task.

  • Classification has been run in the task.

  • Classification was started but either failed to complete or has not completed.

  • Classification is current.

  • Classification has no results to accept.

  • Classification results have been accepted.

  • Review has been completed.

If no content has been changed on the task when promotion is initiated, a Promote Task pop-up notification states the there are no changes to promote.

Press Return to Task (or press the X in the upper right corner) to close the pop-up.

If content changes have been made but any of the other conditions are not yet satisfied when promotion is initiated, a Promote Task pop-up notification shows their statuses, with action options to cancel the promotion, or to continue if task changes are considered sufficiently safe to update the project level content without satisfying these conditions.

Press Return to Task (or press the X in the upper right corner) to close the pop-up and cancel the promotion without changing project content or the task status.

Press Promote Anyway to continue promotion.

Provide Feedback
Review complete
  • RVF Report Clean

  • Promoting tasks with warnings

    Pressing Promote Anyway is tacit acceptance of any warning statuses, with implied responsibility for by-passing these safeguards and the consequent unclassified and/or unreviewed content changes that will be promoted from the task to the project level.

    Promoting unclassified content changes is a quality assurance risk that can be avoided relatively easily, since it typically takes less than ten minutes to run classification (if only to confirm no results).

    However, there are occasions when it is clear that inferred classification results won't change, such as a description-only content change, in which case this option may be acceptable.

    By-passing review may also be acceptable under particular circumstances, for instance if the author is also the project manager / project lead.

    This scenario can be prevented by setting the task as Complex and also having Review Completed set as a mandatory task-level SAC requirement within its parent project configuration, since task promotion in this case will not be enabled without a completed review.

    Promote my (non-complex) task changes to their parent project (share with other authors)

    Steps
    References

    Press Promote This Task to the Project in the Task View - Task Details panel actions button list.

    A "Preparing for task promotion" notification is presented in the page header, and the Promote This Task to the Project button is disabled.

    Task promotion has implicit checks for the following conditions:

    • No content changes made in the task.

    • Classification has been run in the task.

    • Classification was started but either failed to complete or has not completed.

    • Classification is current.

    • Classification has no results to accept.

    • Classification results have been accepted.

    • Review has been completed.

    If no content has been changed on the task when promotion is initiated, a Promote Task pop-up notification states the there are no changes to promote.

    Press Return to Task (or press the X in the upper right corner) to close the pop-up.

    If content changes have been made but any of the other conditions are not yet satisfied when promotion is initiated, a Promote Task pop-up notification shows their statuses, with action options to cancel the promotion, or to continue if task changes are considered sufficiently safe to update the project level content without satisfying these conditions.

    Press Return to Task (or press the X in the upper right corner) to close the pop-up and cancel the promotion without changing project content or the task status.Press Promote Anyway to continue promotion.

    A "Promoting task..." notification is presented in the page header whilst branch content changes are merged to the project level.

    During promotion, the task content branch is locked to prevent any further changes, and a warning notification is presented below the Edit Task Details action button in the Task Details panel.

    Whilst this is present, changes cannot be made to the content saved in the task branch, and action buttons other than Edit Task Details and Submit for Review become inactive.

    Once task promotion is completed, a "Task successfully promoted for <task-identifier>" notification is presented in the page header.

    Following promotion no further changes are allowed on the task content branch, all action buttons in the Task Details panel become inactive, and a warning notification is presented below the now inactive Edit Task Details action button.

    Provide Feedback

    Promote my (batch) task changes to their parent project (share with other authors)

    Steps
    References

    Batch upload tasks are identified as such during the upload and task creation process.

    When identified as a batch task, the Batch label appears in the upper-right of the Task View - Task Details panel.

    The batch task identification activates the task-level Service Acceptance Criteria (SAC) item Validation Report Clean which is defined within the parent project SAC configuration, as a mandatory manual acceptance item.

    Manual SAC are presented initially as open checkboxes, each of which can be interactively checked (green-ticked) when the user's role-based access permissions match those configured for that SAC control.

    Once task promotion is enabled, follow the non-complex task steps (included below) to complete promotion of the task. Although the screenshots show simple tasks without theBatch label or task-level SAC, the steps to promote once it is enabled are the same for all tasks.

    Steps
    References

    Promoting tasks with warnings

    Pressing Promote Anyway is tacit acceptance of any warning statuses, with implied responsibility for by-passing these safeguards and the consequent unclassified and/or unreviewed content changes that will be promoted from the task to the project level.

    Promoting unclassified content changes is a quality assurance risk that can be avoided relatively easily, since it typically takes less than ten minutes to run classification (if only to confirm no results).

    However, there are occasions when it is clear that inferred classification results won't change, such as a description-only content change, in which case this option may be acceptable.

    By-passing review may also be acceptable under particular circumstances, for instance if the author is also the project manager / project lead.

    This scenario can be prevented by setting the task as Complex and also having Review Completed set as a mandatory task-level SAC requirement within its parent project configuration, since task promotion in this case will not be enabled without a completed review.

    A "Promoting task..." notification is presented in the page header whilst branch content changes are merged to the project level.

    During promotion, the task content branch is locked to prevent any further changes, and a warning notification is presented below the Edit Task Details action button in the Task Details panel.

    Whilst this is present, changes cannot be made to the content saved in the task branch, and action buttons other than Edit Task Details and Submit for Review become inactive.

    Once task promotion is completed, a "Task successfully promoted for <task-identifier>" notification is presented in the page header.

    Following promotion no further changes are allowed on the task content branch, all action buttons in the Task Details panel become inactive, and a warning notification is presented below the now inactive Edit Task Details action button.

    Until all mandatory task-level SAC> are met, task promotion will be blocked and Promote This Task to the Project in the Task View - Task Details panel actions button list will not be enabled.

    Validation Report Clean must be satisfied to allow batch task promotion

    For batch tasks this means as a minimum Validation Report Clean must be interactively checked (green-ticked) before the task can be promoted.

    Role-based access controls apply to manual task-level SAC

    If the user's authenticated account session roles do not include edit permissions for the task (such as when viewing another author's task), the current manual SAC status will be shown, but cannot be set.

    Press the Validation Report Clean manual SAC checkbox to toggle its status. It will show a green ticked box when checked, indicating its condition is met.

    When all mandatory task-level SAC conditions are met for the batch task, promotion is enabled, and both Promote This Task to the Project and Begin Promotion Automation in the Task View - Task Details action buttons list become active.

    Press Promote This Task to the Project in the Task View - Task Details panel actions button list.

    A "Preparing for task promotion" notification is presented in the page header, and the Promote This Task to the Project button is disabled.

    Task promotion has implicit checks for the following conditions:

    • No content changes made in the task.

    • Classification has been run in the task.

    • Classification was started but either failed to complete or has not completed.

    • Classification is current.

    • Classification has no results to accept.

    • Classification results have been accepted.

    • Review has been completed.

    If no content has been changed on the task when promotion is initiated, a Promote Task pop-up notification states that there are no changes to promote.

    Press Return to Task (or press the X in the upper right corner) to close the pop-up.

    If content changes have been made but any of the other conditions are not yet satisfied when promotion is initiated, a Promote Task pop-up notification shows their statuses, with action options to cancel the promotion, or to continue if task changes are considered sufficiently safe to update the project level content without satisfying these conditions.

    Press Return to Task (or press the X in the upper right corner) to close the pop-up and cancel the promotion without changing project content or the task status.

    Press Promote Anyway to continue promotion.

    Additional SAC already defined for tasks within the project

    If any other Task-level SAC are defined for the project, these are also presented as described for Complex tasks.

    Provide Feedback

    Rebase my task from the project (synchronize changes in its parent project since task creation)

    Steps
    References

    Promoting tasks with warnings

    Pressing Promote Anyway is tacit acceptance of any warning statuses, with implied responsibility for by-passing these safeguards and the consequent unclassified and/or unreviewed content changes that will be promoted from the task to the project level.

    Promoting unclassified content changes is a quality assurance risk that can be avoided relatively easily, since it typically takes less than ten minutes to run classification (if only to confirm no results).

    However there are occasions when it is clear that inferred classification results won't change, such as a description-only content change, in which case this option may be acceptable.

    By-passing review may also be acceptable under particular circumstances, for instance if the author is also the project manager / project lead.

    This scenario can be prevented by setting the task as Complex and also having Review Completed set as a mandatory task-level SAC requirement within its parent project configuration, since task promotion in this case will not be enabled without a completed review.

    A "Task details loaded" header notification is presented, and the main display panel changes to show a blue "Comparing task to project, please wait just a moment..." full display panel notice (with an animated timer indication that the comparison process is taking place).

    If the rebase comparison shows that merging can be completed with no content conflicts, the main display panel changes to show a green "Task and project can be merged without issues, pulling changes in from project..." full display panel notice (with an animated timer indication that the merge process is taking place).

    Once the merges are completed, the main display panel changes to show a green "Success! Switching to task view in five seconds..." full display panel notice, which closes automatically after five seconds have elapsed (during which the merges are finalized in the task branch content).

    If the merge comparison detects conflicting changes in the task branch and the project branch content, then the Concept Merges screen appears when the comparison screen closes.

    This presents a list of the concepts that need merge conflicts to be reviewed and resolved in a context tab navigation panel to the left, with a Conflict Resolution display panel to the right (initially this will be blank).

    In the Merges To Review tab Press the blue "pencil" icon button to the right of a concept FSN in the concepts list.

    The display panel shows a 3-panel Concept Merge Resolution view, with the Project Version to the left, the Task Version to the right, and between them a Merged Version of the concept needing review for merge resolution.

    Pick one of the three versions by pressing the small purple Accept This Version icon button in its concept header action icons menu.

    A "Saving accepted merged concept..." header notification is presented and the version being saved is greyed out.

    An "Accepting merged version for concept <SCTID>" header notification is presented.

    On merge completion, a "Merge accepted for concept <SCTID>" header notification is presented, the display panel is cleared, the concept FSN is removed from the Merges To Review list, and it is added to the Merges Accepted list in the context tab navigation panel.

    Repeat the concept merge resolution steps for every concept in the Merges To Review list, until the list is empty.

    On accepting the final concept merge, the context tab navigation switches to the Merges Accepted list, and a Finalize Merges action button is presented below the list of accepted concepts.

    At this stage the Merges To Review list is empty (although still available as a context panel tab).

    Press Finalize Merges to complete the rebase concept merges process and persist the changes in the task branch content.

    An "Applying merged changes..." header notification is presented whilst all the accepted merge changes are saved to the task branch content.

    Once the merges are completed, the main display panel changes to show a green a green "Success! Resolved merges applied. Switching to task view in five seconds..." full display panel notice, which closes automatically after five seconds have elapsed (during which the merges are finalized in the task branch content).

    The Task View is reloaded, with the LH menu panel Pull new changes from project (rebase task) button now disabled (greyed out).

    Any concepts loaded into the edit panel which were updated during the merge process now show the newly merged version of their content.

    The Dashboard - My Tasks view REBASE column icon for this task will also now be inactive.

    At this point the task branch status has been returned to Forward, and changes made within the task are once again eligible for promotion to the project.

    Provide Feedback

    Task rebase eligibility is indicated in two places:

    • In the Dashboard - My Tasks entry, as an active (yellow) Rebase this task from project icon button in its task row.

    • In an open task, as an active (yellow) Pull new changes from project icon button in the LH action button panel of the Edit Task view.

    Either

    From Dashboard - My Tasks, press the Rebase this task from project icon button in the task row REBASE column.

    Or

    From the Edit Task view, press the Pull new changes from project icon button in the LH action button panel.

    A "Loading task details..." header notification is presented and the main display panel is cleared.

    Task divergence and rebasing

    A task becomes diverged from its project when the project content gets updated after content has been modified within the task.<>br />

    This may happen through other tasks being promoted to the project, and also through project rebase from its mainline.<>br />

    A task may also fall behind its parent branch, when the parent content changes before any changes are made to content within the task.<>br />

    This may happen when a task is created but no changes are made within it or some time whilst other changes occur in project content for instance via a subsequent project level rebase, and/or another task being promoted to the project.<>br />

    When either of these situations occur the task becomes eligible for rebasing from the project, to synchronize its content with the parent branch changes since the task was created.

    Diverged tasks cannot be promoted

    Task promotion is not possible whilst a task is diverged, so periodic rebasing is an important aspect of project and task management - ideally as soon as possible following divergence (fewer differences make for simpler content merges).

    Attempting to promote a task which is diverged (indicated by an active rebase action button for that task) will trigger a _Promote Task_ pop-up notification that the task and project are not synchronized. The only available action on that notification is to return to the task - the promotion request is blocked.

    Silent merging

    Although this sequence indicates content can be automatically merged without user intervention, any differences are still saved in the task branch to bring it back in synchronization with the project content.

    This path simply means that none of the content changes in the project since the task was first created are in conflict with the changes made in the task since then.

    All subsequent concept changes at the project level that were not directly related to the concepts being changed within the task become available within the task after rebasing.

    Silent merging also occurs for changes within a concept being modified within the task if the changes do not conflict - for instance new descriptions may be added that were brought into the project concept version from another task or from the project's mainline.

    Saving a merged concept is usually very rapid

    These two stages usually happen quickly, so these header notifications may be very brief!