data-dictionary-creator
Web icon

Data Dictionary Creator

Stable version 3.2.4 (Compatible with OutSystems 11)
Uploaded
 on 06 December 2022
 by 
5.0
 (5 ratings)
data-dictionary-creator

Data Dictionary Creator

Documentation
3.2.4

This application creates data dictionaries, and some reports for the Modules published in the environment, you will be able to have a more in depth look of each module that is published in the environment.

Setup:

  1. Download and install in the environment;
  2. Grant the role DataDictionaryArchitect to the user that you want to have access; 
  3. Grant the role DataDictionaryUserManager to a user that you want to have access to the UsersInEnvironment and DeveloperOperationsStatistics Screens, granting this role alone, only gives access to the UsersInEnvironment and DeveloperOperationsStatistics Screens, these are sensitive information screens, with information about the names and usernames of the Users table of all the Tenants and developer operations, hence being separated from the other screens;
  4. Open in your environment  with the endpoint /DataDictionaryCreator to access the application;
  5. Please note that all the info is retrieved by DataDictionaryCreatorProbe from the currently published Modules of the Environment, and that they update on refreshing/entering the page, and does not store it anywhere, so it maintains a light size in the environment, but depending on the information required, it can take a bit to generate the page;
  6. Also Note that Exporting Screens for pdf generating have an internal Guid system that is controlled internally and authenticated that can be controlled by the Site Property, ExportExpirationMinutes in the DataDictionaryCreatorProbe module, since they have an anonymous role authentication. 
  7. The timer RemoveExportGuids in the DataDictionaryCreatorProbe module runs every day at 00:00 to erase Guids that have expired, so that the table is kept light; 
  8. Footer pagination (Page x of y) can be activated in the Site property HasPDFPagination in the DataDictionaryCreator module, changing it to True (show footer), False (show no footer);


You will have four Menu Items to choose, Module, Application, Espace, Solution and Environment depending on the scope.

  • In the Module Menu Item, you can choose between the following pages:
    • Module Info: Shows the information for a single Module(Espace or Extension);
    • Single Entity: Shows an Entity and the Module Info from a single Module(Espace or Extension);
    • All Entities: Shows all the Entities and the Module Info from a single Module(Espace or Extension);
    • All Public Elements: Show all the Public Elements and the Module Info from a single Module(Espace or Extension);


  • In the Espace Menu Item, you can choose between the following pages:
    • All Consumed Elements: Shows all of the elements, separated by each consumed Module Info, that an Espace consumes/references;
    • All Screens: Shows all the Screens that an Espace has, with the input parameters it has;
    • All Integrations: Shows all the REST/SOAP/SAP groups that an Espace has, with the parameters they have;
    • All Processes: Show all the Processes that an Espace has, with the parameters it has; 
    • All Timers: Show all the Timers that an Espace has;
    • All Circular References: Shows the Circular references between the Espace and other Espaces; 


  • In the Application Menu Item, you can choose between the following pages:
    • All Entities: Shows all Entities, separated by each Module Info, that belongs to that Application;
    • All Modules: Shows all the Modules Info, that belong to that Application;
    • All Timers: Application based version of the All Timers of Espace (Extensions don't appear);
    • All Processes: Application based version of the All Processes of Espace (Extensions don't appear);
    • All Circular References: Shows the Circular references between the Application's Espaces and other Espaces;


  • In the Solution Menu Item, you can choose between the following pages:
    • All Entities: Shows all Entities, separated by each Module Info, that belongs to that Solution;
    • All Modules: Shows all the Modules Info, that belong to that Solution;
    • All Timers: Solution based version of the All Timers of Espace (Extensions don't appear);
    • All Processes: Solution based version of the All Processes of Espace (Extensions don't appear);
    • All Circular References: Shows the Circular references between the Solution's Espaces and other Espaces;


  • In the Environment Menu Item, you can choose between the following pages:
    • Unused Public Elements: Shows all Unused Public Elements from all the Modules in the Environment;
    • Size Of Modules: Shows the size of the binary of each module (note that it may not correspond to the size when downloading, since it doesn't factor in the Manifest.xml and the zip compression);
    • Users: Shows the Users in the various tenants, their Developer Service Center Roles (if they are a developer user in the Service Center Tenant) with the security access levels divided by areas and transversal authorizations, Effective Roles (Sum of the Users Application Roles and Group derived Roles), Users Application Roles, and the Groups and the Roles belonging in those Groups. (only active Users, Espaces, Tenants, Roles, Groups will appear)
    • DeveloperOperationsStatistics: Shows the operations By Module, By Operation, By User, By Tenant, By Interval Date of the developers in the environment;

3.2.1

This application creates data dictionaries, and some reports for the Modules published in the environment, you will be able to have a more in depth look of each module that is published in the environment.

Setup:

  1. Download and install in the environment;
  2. Grant the role DataDictionaryArchitect to the user that you want to have access; 
  3. Grant the role DataDictionaryUserManager to a user that you want to have access to the UsersInEnvironment and DeveloperOperationsStatistics Screens, granting this role alone, only gives access to the UsersInEnvironment and DeveloperOperationsStatistics Screens, these are sensitive information screens, with information about the names and usernames of the Users table of all the Tenants and developer operations, hence being separated from the other screens;
  4. Open in your environment  with the endpoint /DataDictionaryCreator to access the application;
  5. Please note that all the info is retrieved by DataDictionaryCreatorProbe from the currently published Modules of the Environment, and that they update on refreshing/entering the page, and does not store it anywhere, so it maintains a light size in the environment, but depending on the information required, it can take a bit to generate the page;
  6. Also Note that Exporting Screens for pdf generating have an internal Guid system that is controlled internally and authenticated that can be controlled by the Site Property, ExportExpirationMinutes in the DataDictionaryCreatorProbe module, since they have an anonymous role authentication. 
  7. The timer RemoveExportGuids in the DataDictionaryCreatorProbe module runs every day at 00:00 to erase Guids that have expired, so that the table is kept light; 
  8. Footer pagination (Page x of y) can be activated in the Site property HasPDFPagination in the DataDictionaryCreator module, changing it to True (show footer), False (show no footer);


You will have four Menu Items to choose, Module, Application, Espace, Solution and Environment depending on the scope.

  • In the Module Menu Item, you can choose between the following pages:
    • Module Info: Shows the information for a single Module(Espace or Extension);
    • Single Entity: Shows an Entity and the Module Info from a single Module(Espace or Extension);
    • All Entities: Shows all the Entities and the Module Info from a single Module(Espace or Extension);
    • All Public Elements: Show all the Public Elements and the Module Info from a single Module(Espace or Extension);


  • In the Espace Menu Item, you can choose between the following pages:
    • All Consumed Elements: Shows all of the elements, separated by each consumed Module Info, that an Espace consumes/references;
    • All Screens: Shows all the Screens that an Espace has, with the input parameters it has;
    • All Integrations: Shows all the REST/SOAP/SAP groups that an Espace has, with the parameters they have;
    • All Processes: Show all the Processes that an Espace has, with the parameters it has; 
    • All Timers: Show all the Timers that an Espace has;
    • All Circular References: Shows the Circular references between the Espace and other Espaces; 


  • In the Application Menu Item, you can choose between the following pages:
    • All Entities: Shows all Entities, separated by each Module Info, that belongs to that Application;
    • All Modules: Shows all the Modules Info, that belong to that Application;
    • All Timers: Application based version of the All Timers of Espace (Extensions don't appear);
    • All Processes: Application based version of the All Processes of Espace (Extensions don't appear);
    • All Circular References: Shows the Circular references between the Application's Espaces and other Espaces;


  • In the Solution Menu Item, you can choose between the following pages:
    • All Entities: Shows all Entities, separated by each Module Info, that belongs to that Solution;
    • All Modules: Shows all the Modules Info, that belong to that Solution;
    • All Timers: Solution based version of the All Timers of Espace (Extensions don't appear);
    • All Processes: Solution based version of the All Processes of Espace (Extensions don't appear);
    • All Circular References: Shows the Circular references between the Solution's Espaces and other Espaces;


  • In the Environment Menu Item, you can choose between the following pages:
    • Unused Public Elements: Shows all Unused Public Elements from all the Modules in the Environment;
    • Size Of Modules: Shows the size of the binary of each module (note that it may not correspond to the size when downloading, since it doesn't factor in the Manifest.xml and the zip compression);
    • Users: Shows the Users in the various tenants, their Developer Service Center Roles (if they are a developer user in the Service Center Tenant) with the security access levels divided by areas and transversal authorizations, Effective Roles (Sum of the Users Application Roles and Group derived Roles), Users Application Roles, and the Groups and the Roles belonging in those Groups. (only active Users, Espaces, Tenants, Roles, Groups will appear)
    • DeveloperOperationsStatistics: Shows the operations By Module, By Operation, By User, By Tenant, By Interval Date of the developers in the environment;