How to create ToDo-items for the Composer and Deployment

Wiki
1

How to create TODO-items

Todo items allow users to take action on todo items that require action during your composition and/or before installation or after installation. This guides users to make informed decisions at the right moment and prevents unnecessary integration/installation errors.

In this post you can find out more about how the todo items work in the Composer: Composer update Q4 2024

Reasons to add todo items as part of your component revision

Todo items are similar to release notes. They inform users of changes and provide instructions on how to use these changes. The main difference being the place where the user has to perform actions.
And just like release notes, the todo items are PI messages of a certain type.

There are 2 types of todo items:

  • “TODO item before integration (Composer)”
    • Inform users of tasks while composing, before an integration is started.
  • “TODO item after installation (Deployment)”
    • Inform users of tasks after installation.

While release notes are meant for functional explanation of changes in the application itself, after installation.

How to create todo items

There are 2 ways to create todo items. In both ways the todo item is linked to a component revision.

- Create a todo item from the Architect

This is done while saving a component revision. In the issue tracker you can add your note. And also add a new message [1] of type “Todo item” from the message type dropdown [2].

image
image677×441 14 KB

- Create a todo item in NNetwork

Open NNetwork and navigate to your PIxxxxx. Then add a message of either type [1] and select the component revision [2].

image
image838×367 6.71 KB

Examples of todo items

Some examples of todo items that are useful in the Composer:

  • In cases where components have been cut, and in order to keep the same functionality you might need a new component.
  • In cases where a certain combination of components or component revisions is known to not work together.
  • In cases where an NB-plugin version is required in order to use the functionality.

Some examp[les of todo items that are useful in Deployment after installation:

  • In cases where high impact changes have been made (for example big table changes, or process changes) where you want to provide better instructions or at least want to make the application owner aware of the changes.
  • In cases where tasks or checks need to be performed after installation. This could be part of the release note, but the todo item provides a way to give more technical instructions.
1 Like