This documentation supports the 20.02 version of BMC Helix Platform. 
To view an earlier version, select 19.11 from the Product version menu.

Guidelines to define scope for the definitions

This topic lists the guidelines for defining scope for the definitions available in BMC Helix Platform. You must follow these guidelines when you create or modify a definition in a Digital Service application or library.

Guidelines to define scope for definitions

The information in the following table helps you to decide when to define the scope for the definitions.

Definition ScopeTo be used when...
Application/Library
  • You want to limit the usage of your definitions within an application or library.
  • You need to modify the definitions in the later versions of the BMC Helix Platform application without affecting any other applications.
  • You do not want users to customize the definitions.
Public
  • You want other applications or libraries to use these definitions.
  • You do not need to modify the definitions in the later versions of the BMC Helix Platform application.
  • You want users to customize the definitions.
    Note: BMC recommends that if you allow customizations for the definitions, ensure that you do not modify the definitions in the future versions.

Guidelines to change the scope of the definition

The information in the following section helps you to decide when to change the scope of the definition:

  • You can always change the scope of the definition from Application/Library to Public.
  • After you release your application or library, ensure that you do not change the scope of the released Public definitions in the next version of your application or library.
  • If you have not released your application or library, you can change the scope of a definition from Public to Application/Library. However, in this case you must export and redeploy the application (or library) and any other dependent application (or library) after the development to ensure:
    • No other definitions outside the deployed application or library have used the Application/Library scoped definitions. The deployment fails, if the Application/Library scoped definitions are used by definitions outside the deployed application/library.
    • Customization option is set to "Not allowed" for all the Public scope definitions that used definitions for which you changed the scope from Public to Application/Library.
Was this page helpful? Yes No Submitting... Thank you

Comments