Namespace: Consultingwerk.BusinessEntityDesigner.Mcp
Class 
BusinessEntityDesignerMcpBusinessTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.BusinessEntityDesigner.Mcp.BusinessEntityDesignerMcpBusinessTask

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDatasetController, Consultingwerk.OERA.IBusinessService, Consultingwerk.SmartFramework.IOverwritePromptCallback, ISupportsRestMethods


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
CHARACTER AddCalculatedField (AddCalculatedFieldParameter) Adds a calculated field to a Business Entity
CHARACTER AddTempTable (AddTempTableParameterParameter) Adds a temp-table to a Business Entity and creates a data relation to a parent temp-table
LONGCHAR CreateBusinessEntity (CreateBusinessEntityParameter) Creates a new Business Entity
LONGCHAR CreateDataFields (character, character, character) Creates data fields for a Business Entity
DisposePlugins () Unloads the plugin manager service
EnsurePluginsForCurrentSettings () Re-initializes the server plugins when the settings file has changed
FixBaseFolders (character) Turns the base folder settings into absolute paths
CHARACTER FixRelativePath (character) Fixes a relative path to an absolute path
CHARACTER FixRelativePath (character, character) Fixes a relative path to an absolute path
InitializeBusinessEntityDesignerServices () Initialize Business Entity Designer services
InitializeEnvironment () Hook to initialize environment (logging, settings, etc.)
InitializeEnvironment (character) Loads the Business Entity Designer settings from the given settings file and turns the base folder settings into absolute paths
InitializePlugins () Loads the plugin manager service
InitializeProjectEnvironment (character) Loads the Business Entity Designer settings for the requested project
OnAfterGenerateSource (EventArgs) Raises the AfterGenerateSource event
OnAfterRegenerateSource (EventArgs) Raises the AfterRegenerateSource event
CHARACTER OpenFile (character) Opens a Business Entity Designer file
CHARACTER OpenFile (character, character) Opens a Business Entity Designer file of the given project
LOGICAL PromptForOverwrite (character) Prompts the user if a resource should be overwritten
RegenerateSource () Regenerates the source code
CHARACTER RegenerateSource (RegenerateBusinessEntityParameter) Regenerates the source code for the given Business Entity
CHARACTER RemoveField (RemoveFieldParameter) Removes a field from a Business Entity
CHARACTER ResolveProjectFolder (character) Returns the folder configured for the given project
CHARACTER ResolveProjectSettingsFile (character) Returns the .BusinessEntityDesignerSettings.xml file of the given project
SaveFile (character) Saves a .bedgm file

Top Constructor Summary
Options Name Purpose
BusinessEntityDesignerMcpBusinessTask () Constructor for BusinessEntityDesignerMcpBusinessTask

Top Event Summary
Options Name Purpose
AfterGenerateSource (Object, EventArgs) Event raised after the source code is generated
AfterRegenerateSource (Object, EventArgs) Event raised after the source code is re-generated

Top Property Summary
Options Name Purpose
HANDLE DatasetHandle
CHARACTER PluginSettingsFile


Method Detail
Top

CHARACTER AddCalculatedField (AddCalculatedFieldParameter)
Purpose: Adds a calculated field to a Business Entity
Notes:

Parameters:
poParameter Consultingwerk.BusinessEntityDesigner.Mcp.AddCalculatedFieldParameter
The AddCalculatedFieldParameter with details
Returns CHARACTER
The response from the SmartFramework MCP server
Top

CHARACTER AddTempTable (AddTempTableParameterParameter)
Purpose: Adds a temp-table to a Business Entity and creates a data relation to a parent temp-table
Notes:

Parameters:
poParameter Consultingwerk.BusinessEntityDesigner.Mcp.AddTempTableParameterParameter
The AddTempTableParameterParameter with details
Returns CHARACTER
The response from the SmartFramework MCP server
Top

LONGCHAR CreateBusinessEntity (CreateBusinessEntityParameter)
Purpose: Creates a new Business Entity
Notes:

Parameters:
poParameter Consultingwerk.BusinessEntityDesigner.Mcp.CreateBusinessEntityParameter
The CreateBusinessEntityParameter with details
Returns LONGCHAR
The response from the SmartFramework MCP server
Top

LONGCHAR CreateDataFields (character, character, character)
Purpose: Creates data fields for a Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcProductModule CHARACTER
The name of the product module
pcEntityObject CHARACTER
Output: the name of the repository entity object created for the Business Entity's primary temp-table (e.g. eCustomer)
Returns LONGCHAR
The response from the SmartFramework MCP server
Top

DisposePlugins ()
Purpose: Unloads the plugin manager service
Notes:

Top

EnsurePluginsForCurrentSettings ()
Purpose: Re-initializes the server plugins when the settings file has changed
Notes: The ServerPlugins list is a property of the settings file, so the
plugin manager created for a previous request may hold the plugins of
a different project (SCL-5632)

Top

FixBaseFolders (character)
Purpose: Turns the base folder settings into absolute paths
Notes: Relative base folders are anchored on the folder of the settings
file that is in charge, which makes each project's settings file
describe the output folders of that project (SCL-5632)

Parameters:
pcBaseFolder CHARACTER
The folder relative base folder settings are resolved against
Top

CHARACTER FixRelativePath (character)
Purpose: Fixes a relative path to an absolute path
Notes: Uses the location of the .BusinessEntityDesignerSettings.xml file as the base for relative paths

Parameters:
pcPath CHARACTER
The relative path
Returns CHARACTER
The absolute path
Top

CHARACTER FixRelativePath (character, character)
Purpose: Fixes a relative path to an absolute path
Notes: Overload that takes the base folder for relative paths, so that the
output folders of a project are anchored on the folder of that
project's .BusinessEntityDesignerSettings.xml file (SCL-5632)

Parameters:
pcPath CHARACTER
The relative path
pcBaseFolder CHARACTER
The folder relative paths are resolved against
Returns CHARACTER
The absolute path
Top

InitializeBusinessEntityDesignerServices ()
Purpose: Initialize Business Entity Designer services
Notes:

Top

InitializeEnvironment ()
Purpose: Hook to initialize environment (logging, settings, etc.)
Notes: Extend as needed for MCP execution context. Uses the first
.BusinessEntityDesignerSettings.xml file found in the PROPATH

Top

InitializeEnvironment (character)
Purpose: Loads the Business Entity Designer settings from the given settings
file and turns the base folder settings into absolute paths
Notes: The BusinessEntityDesignerSettings class is static session state and
PASOE agent sessions are reused across requests, so the settings are
resolved per request. Relative base folders are anchored on the
folder of the settings file, which makes each project's settings
file describe the output folders of that project (SCL-5632)

Parameters:
pcSettingsFileName CHARACTER
The name of the .BusinessEntityDesignerSettings.xml file to load
Top

InitializePlugins ()
Purpose: Loads the plugin manager service
Notes: The plugin manager reads the ServerPlugins property of the currently
loaded settings file, so the settings have to be resolved before

Top

InitializeProjectEnvironment (character)
Purpose: Loads the Business Entity Designer settings for the requested project
Notes: Used by the generating methods that do not open an existing .bedgm
file. When no project name is given, the first settings file in the
PROPATH remains in charge (SCL-5632)

Parameters:
pcProjectName CHARACTER
The optional name of the project to generate into
Top

OnAfterGenerateSource (EventArgs)
Purpose: Raises the AfterGenerateSource event
Notes: The GenerationFinished event of the BusinessEntityGenerator is
raised afterwards, so that the plug-ins deferring their work to
the end of a generation run (e.g. the keyword case plug-in) also
run on the server path (SCL-5667). It is raised after the
AfterGenerateSource subscribers, because those generate further
source files that are to be post-processed as well

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

OnAfterRegenerateSource (EventArgs)
Purpose: Raises the AfterRegenerateSource event
Notes: Raises the GenerationFinished event of the BusinessEntityGenerator
afterwards, see OnAfterGenerateSource (SCL-5667)

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

CHARACTER OpenFile (character)
Purpose: Opens a Business Entity Designer file
Notes: Overload without a project name, see OpenFile (character, character)

Parameters:
pcEntityName CHARACTER
The name of the Business Entity Designer file
Returns CHARACTER
The fully qualified path to the .bedgm file
Top

CHARACTER OpenFile (character, character)
Purpose: Opens a Business Entity Designer file of the given project
Notes: Resolves the .bedgm file and the Business Entity Designer settings
that are in charge for this request (SCL-5632):
- With a project name, the settings file of that project is loaded
and the .bedgm file is resolved against its SourceCodeBaseFolder,
because the design files of other projects (UnitTests, Tests) are
not on the PASOE PROPATH.
- Without a project name, the .bedgm file is resolved through the
PROPATH as before, and the settings file closest to it wins - the
one in its own folder, or in the closest parent folder. Only when
no settings file is found that way, the first settings file in the
PROPATH is used

Parameters:
pcEntityName CHARACTER
The name of the Business Entity Designer file
pcProjectName CHARACTER
The optional name of the project the Business Entity belongs to
Returns CHARACTER
The fully qualified path to the .bedgm file
Top

LOGICAL PromptForOverwrite (character)
Purpose: Prompts the user if a resource should be overwritten
Notes:

Parameters:
pcObjectName CHARACTER
The name of the resources that
Returns LOGICAL
Logical value indicating if an existing object should be overwritten
Top

RegenerateSource ()
Purpose: Regenerates the source code
Notes:

Top

CHARACTER RegenerateSource (RegenerateBusinessEntityParameter)
Purpose: Regenerates the source code for the given Business Entity
Notes:

Parameters:
poParameter Consultingwerk.BusinessEntityDesigner.Mcp.RegenerateBusinessEntityParameter
The RegenerateBusinessEntityParameter with details
Returns CHARACTER
The response from the SmartFramework MCP server
Top

CHARACTER RemoveField (RemoveFieldParameter)
Purpose: Removes a field from a Business Entity
Notes:

Parameters:
poParameter Consultingwerk.BusinessEntityDesigner.Mcp.RemoveFieldParameter
The RemoveFieldParameter with details
Returns CHARACTER
The response from the SmartFramework MCP server
Top

CHARACTER ResolveProjectFolder (character)
Purpose: Returns the folder configured for the given project
Notes: The project name is resolved through the McpServerProjects
configuration property. The ConfigurationProvider flattens nested
JSON objects into dotted property names, so a single project is read
as "McpServerProjects.<name>". Relative folders are resolved against
the working directory of the PASOE agent (SCL-5632)

Parameters:
pcProjectName CHARACTER
The name of the project
Returns CHARACTER
The absolute path of the project folder
Top

CHARACTER ResolveProjectSettingsFile (character)
Purpose: Returns the .BusinessEntityDesignerSettings.xml file of the given project
Notes:

Parameters:
pcProjectName CHARACTER
The name of the project
Returns CHARACTER
The absolute path of the project's settings file
Top

SaveFile (character)
Purpose: Saves a .bedgm file
Notes:

Parameters:
pcFileName CHARACTER
The name (including path) of the .bedgm file to save


Constructor Detail
Top

BusinessEntityDesignerMcpBusinessTask ()
Purpose: Constructor for BusinessEntityDesignerMcpBusinessTask
Notes:



Event Detail
Top

AfterGenerateSource (Object, EventArgs)
Purpose: Event raised after the source code is generated
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

AfterRegenerateSource (Object, EventArgs)
Purpose: Event raised after the source code is re-generated
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event


Property Detail
Top

HANDLE DatasetHandle

Returns HANDLE
Top

CHARACTER PluginSettingsFile

Returns CHARACTER


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       16.08.2026 16:54:47