Add Comment Field to OML Upload
73
Views
0
Comments
New
Service Studio

Overview

OutSystems' 1-Click Publish with comment is a great addition that helps development teams maintain traceability — especially during hotfixes or production changes were knowing why a module was published is just as important as what changed. However, there's a gap in the workflow when publishing through OML upload and Service Center, which undermines this traceability.

The Problem

In regulated or collaborative environments, teams often follow a change management process where a developer must:

  1. Upload the OML file in advance
  2. Wait for approval/permission before going live
  3. Then publish the module once permission is granted

Currently, when uploading an OML via Service Studio, there is no option to attach a comment. This means:

  • If a developer uploads and publishes directly through Service Center (bypassing Service Studio), no publish comment is recorded
  • The permission details, change reason, or hotfix context are permanently lost from the audit trail
  • Teams lose the very traceability that the 1-Click Publish comment feature was designed to provide

The only workaround today is: upload the OML, wait for permission, re-open the uploaded module in Service Studio, and then publish with a comment

The Proposal

Add a Comment Field to the OML Upload Screen: When uploading an OML file via Service Studio, provide an optional comment/reason field. This comment should be associated with the module version and recorded in the publish history if the module is subsequently published.

Why This Matters

  • Audit & Compliance: Many enterprises and regulated industries require documented reasons for every production change. A missing comment on a PROD publish is a compliance gap.
  • Team Collaboration: Other developers monitoring deployments via Service Center have no context for why a module was published — especially critical during incidents or hotfixes.
  • Consistency: The comment feature exists in one publish path but not others, creating an inconsistent and incomplete audit trail.