Guidelines for creating, revising or updating a component

[Q&A] Components, Datasets and Plug-ins
,
1

When editing or creating a component, you can use the following steps to ensure your work is complete and of good quality:

Before the change:

  • Research the functionality you want to add – does a similar functionality already exist? Check features in Application Server and check the components.

  • Design your functionality. This should include the questions displayed below:

afbeelding
afbeelding805×891 62.1 KB

  • When creating new components or features, consider the name. For general use, use: N_ and Novulo, for customer specific use, use the name of the customer: Customername_

  • Consider creating a PI before starting on the changes. Creating a PI beforehand has certain advantages:

    • You can create a main PI with subPI’s for multiple parts of your functionality (for instance when cutting functionality from a component)

    • You can add screenshots in the messages

    • When the PI is connected to an SR with a contract line, you can write your time on the PI when saving your work.

    • When creating a new component, you can’t select the new component when creating the PI. In that case it’s better to create a PI from the Architect, and link it to the SR later. You can add to the PI later in Novulo Network.

In the Architect:

  • When changing/revising an existing component, before you start:

    • Inspect previous revisions for status. If any recent work has been done on the component which still has WIP or NB status, ask the one who’s done the changes if their work is ready for additional changes.

    • If previous versions happen to contain any problems, ask the last person who worked on this to fix them. If this not possible, try to fix the problems yourself. Track your changes to add descriptions of your changes to the work item later.

    • Update all plugins. Copy the plugin text to add to the work item later.

    • Update all icon packs. Copy the icon pack text to add to work item later.

    • Synchronize the concept manager: load reference architecture.

  • When adding your changes be mindful of:

    • Adding translations

    • Tracking your changes for adding to the work item later

    • Check whether your consumes and produces have approved status.

When your component and/or changes are done:

  • Save changes using the issue tracker

    • Add all your notes, including plugin and icon pack updates, to the work item

    • If data conversion is necessary, then add data conversion. If you’re not in the opportunity to add this right away, at least add: //watch out: needs data conversion. If you’re not sure: ask someone. If you’ve added/revised a cached function data conversion is always needed.

    • Add release notes in English with impact for user (or add message type ‘no user impact’ in case of no impact).

  • Set status to NB once you’re ready to test the changes. Test your work on a representative test environment and add the test report to the PI (and to the related SR, if any).

  • Add to PI:

    • Test report

    • Specific configuration (ToDo after release)

    • Change status to fixed/released

  • After successful testing, change status to CTP (so the revision can go to the QA scanner). If the QA scanner finds any issues, try to solve these in order to get your component to Beta status. Find FAQ about the QA scanner here.

1 Like