Page Comparison

...

Code Block

language	cpp
theme	Confluence

EdmiError edmiRemoteValidateInstances (SdaiServerContext  serverContextId, 
                                         SdaiAggrOrInstance aggrOrInstId,
                                         SdaiInstance       instanceBuffer[],
                                         SdaiString         diagnosticFile, 
                                         SdaiInteger        nFileMappings, 
                                         SdaiFileMapping    fileMapping[], 
                                         SdaiOptions        options,
                                         SdaiString         remoteRuleSchemaName, 
                                         SdaiLogDescription logDescription, 
                                         SdaiInteger        numberOfParameters, 
                                         SdaiSelect         parameters[], 
                                         SdaiSelect         userReturnedValue, 
                                         SdaiInteger        *warnings, 
                                         SdaiInteger        *errors, 
                                         SdaiInvocationId   *edmiInvocationId);

Invokes the EDMmodelChecker to validate an application instances against a specified set of rules in a remote EDMdatabase. The rules must be defined within the dictionary model of the data model. They may be defined in the data models underlying Express Schema or in any EDMruleSchema that has been compiled to extend the data models dictionary model. The result of the validation may be a plain text report or a population of the EDM_VALIDATION_RESULT_SCHEMA. The validation result population may be used for generating validation reports with a user defined layout and format. The expressions logging can be used to trace the validation process in the EDMexpressVM. The EDMsupervisor and the interactive EDMdebugger may be used for testing and debugging rules as well as for getting detailed information from the validation process.

Arguments

...

Type	Name	Comment
SdaiServerContext	serverContextId	Context identification, from edmiDefineServerContext
SdaiAggrOrInstance	aggrOrInstId
SdaiInstance	instanceBuffer
SdaiString	diagnosticFile	Specifies the file name for diagnostic information generated by this function. If no file name is supplied, i.e. the <diagnosticFile> argument is set to NULL, all diagnostic information will be written to the _the EDMinterface^_ current output device. The _The EDMinterface ^_ current output device can be defined by the edmiDefineOutputFunction operation.
SdaiInteger	nFileMappings
SdaiFileMapping	fileMapping[]
SdaiOptions	options	Specifies the options that will be used in the execution of the edmiRemoteValidateInstances function. The options value should be specified as a bitwise OR between the options to be enabled. All available options are defined in the header file sdai.h . An option value equals zero gives the default options. See below for a detailed description of the available options.
SdaiString	remoteRuleSchemaName	Specifies the name of the remote EDMruleSchema to use in the validation operation. Rule schema names are case insensitive. The rules and constraint defined in the dictionary model (Express schema) that is the underlying schema of the specified <remoteModelName> will be validated when <remoteRuleSchemaName> = NULL.
SdaiLogDescription	logDescription
SdaiInteger	numberOfParameters	Specifies the number of parameters the function supplies to the actual validation process.
SdaiSelect	parameters[]
SdaiSelect	userReturnedValue
SdaiInteger	warnings	The address of a variable that will receive the number of warnings detected by the EDMexpressCompiler^ in the current invocation.
SdaiInteger	errors	The address of a variable that will receive the number of errors detected by the EDMexpressCompiler^ in the current invocation.
SdaiInvocationId	edmiInvocationId	Not yet used. When the edmiInvocationId is specified unequal NULL, the actual operation will be asynchronous and a handle (identifier) of the call will be returned in the edmiInvocationId argument. This handle can be used in later operations for requesting the status (waiting, running, finished ..) and the result of the actual operation.

Options: Descriptions:

...

Return Value

...

Insert excerpt

	US:_r_EDMInterface
	US:_r_EDMInterface
nopanel	true

Options

...

Option	Comment
UNSET_DERIVE_ATTRIBUTES	The validation will check for unset derived attributes. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
OUTPUT_STEPID	The diagnostic information will refer to stepIds rather than to the instanceIds used for identification of instances within the remote EDMdatabase . This option is only applicable for models that have been imported from step files with the KEEP_STEP_IDENTIFIERS option.
INVERSE_RULES	The validation will check for unset Inverse Constraints. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
GLOBAL_RULES	The validation will include any applicable global rule.
REQUIRED_ATTRIBUTES	The validation will check for unset non-optional explicit attributes. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
ATTRIBUTE_DATA_TYPE	The validation will check for explicit attribute values with data types that do not comply with their declaration. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
UNIQUENESS_RULES	The validation will include any applicable Uniqueness Rule.
LOCAL_RULES	The validation will include any applicable Where Rule.
AGGREGATE_SIZE	The validation will check for aggregates with numbers of elements that fail to comply with their declaration. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
ARRAY_REQUIRED_ELEMENTS	The validation will check for arrays with unset non-optional elements. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
AGGREGATE_UNIQUENESS	The validation will check for any aggregate that fail to comply with its uniqueness declaration. The SET type aggregate has a built-in uniqueness rule that will cause a warning if two or more equal values are found among its elements. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
FULL_VALIDATION	The validation will include all applicable rules and constraints. when the <ruleSchemaId> argument is zero,
AGGREGATE_DATA_TYPE	The validation will check for aggregate elements with data types that do not comply with their declaration. This option is applicable only when the <remoteRuleSchemaName> argument is NULL or an empty string.
DETAILED_OUTPUT
FULL_OUTPUT	Any available information about the cause of an error will be recorded in the diagnostic report.
STOP_ON_FIRST_ERROR	The validation process will terminate after encountering the first error.

Example

...

Code Block

language	cpp

Versions Compared

Old Version 1

New Version Current

Key

Arguments

Return Value

Options

Example

See also