Effector 6.3 developer manual

XML reference 6.3

Effector Studio 6.3 summary

Effector Studio 6.3 manual

Effector 6.2 developer manual

XML reference 6.0

Effector Studio 3.2 summary

Effector Studio 3.2 manual

ExcelLikeForm

This component can be used to record data on an excel like interface.

/ExcelLikeForm

Root node.

/ExcelLikeForm/Caption (String)

Optional. The label of the display. Currently exclusively used by the Effector Studio.

/ExcelLikeForm/DataDefinition (String)

The data source.

/ExcelLikeForm/BusinessObject (String)

This is used to load and save the excel. The system takes into account the settings about rights, located in the BusinessObject.

/ExcelLikeForm/SpreadJSONColumn (String)

The name of the DataDefinition column, that contains the JSON to be displayed. The latter has to have the same name in the BusinessObject.

/ExcelLikeForm/IDColumn (String)

A columns name in theDataDefinition” that contains the excel`s unique identifier.

/ExcelLikeForm/TemplateIDColumn (String)

The name of the column (BusinessObject) that determines which excel has served as a template for the creation of the given row.

/ExcelLikeForm/TemplateNameColumn (String)

The name of the column that can contain the name of the excel. Optional setting.

/ExcelLikeForm/NameColumn (String)

The name of a column in the DataDefinition that contains the name of the excel. Optional setting, can be displayed on the UI.

/ExcelLikeForm/DataExchangeSettings

This node contains the data exchange settings. The options written here are needed when inserting data into the displayed Excel or extracting data (and splitting it into different tables) when saving.

/ExcelLikeForm/DataExchangeSettings/DataLoaderStoredProcedure (String)

Optional, the name of the deleted procedure that collects the data upon loading. It needs to receive the following parameters (these values are automatically loaded by the system):

  • @ProcessID (BIGINT): Mandatory parameter, contains the identifier that summarizes the processing (the system stores the values under this identifier).
    • @ExcelID (INT): Mandatory parameter, tagging one of the rows of the excel containing the JSON.
    • @TemplateExcelID (INT): Mandatory parameter, specifying which template was used to create the excel row
  • @userID (INT): Optional parameter, if it exists, the system fills it with the id of the logged in user.

/ExcelLikeForm/DataExchangeSettings/DataSaverStoredProcedure (String)

Optional, the name of the deleted procedure that will distribute the data upon saving. It needs to receive the following parameters (these values are loaded by the system:

  • @ProcessID (BIGINT): Mandatory parameter, contains the identifier that summarizes the processing (the system stores the values under this identifier).
    • @ExcelID (INT): Mandatory parameter, tagging one of the rows of the excel containing the JSON.
    • @TemplateExcelID (INT): Mandatory parameter, specifying which template was used to create the excel row
  • @userID (INT): Optional parameter, if it exists, the system fills it with the id of the logged in user.
  • @Comment (VARCHAR(MAX)): Optional parameter; if it exists and if we are using an excellikeform realization, this parameter can be used to pass a text given on the interface. The saving of this text must be taken care of in the DataSaverStoredProcedure stored procedure.

/ExcelLikeForm/DataExchangeSettings/ParametersTable (String)

Optional, the name of the table that contains the cell intervals that the system will use for the collection and distribution of the data.

/ExcelLikeForm/DataExchangeSettings/ValuesTable (String)

Optional, the name of the table that the system uses to load and save data. The DataLoaderStoredProcedure and the DataSaverStoredProcedure reads and writes this table according to the parameters in ParametersTable table.

/ExcelLikeForm/SheetsToHide (RuleValueType)

The name of the sheets to be hidden, ordered and separated with a “#|#” sign. Optional setting.

/ExcelLikeForm/TemplateURL (String)

Rarely used option. Basically, we have to give the path of the view that we want to use instead of the default display. With this, there is an opportunity to write a unique JavaScript codes that executes operations, that cannot be interpreted by a normal display. An operation like that can be for example the hiding of rows according to the loaded data.

Example:

Example

<?xml version="1.0" encoding="utf-8"?> <ExcelLikeForm xmlns="http://effector.hu/schema/ns/excellikeform"> <Caption></Caption> <DataDefinition></DataDefinition> <BusinessObject></BusinessObject> <SpreadJSONColumn></SpreadJSONColumn> <IDColumn></IDColumn> <TemplateIDColumn></TemplateIDColumn> <TemplateNameColumn></TemplateNameColumn> <NameColumn></NameColumn> <DataExchangeSettings> <DataLoaderStoredProcedure></DataLoaderStoredProcedure> <DataSaverStoredProcedure></DataSaverStoredProcedure> <ParametersTable></ParametersTable> <ValuesTable></ValuesTable> </DataExchangeSettings> <TemplateURL></TemplateURL> </ExcelLikeForm>

  • Last update: 2 weeks 4 days ago
  • Effector