ExcelLikeForm

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

/ExcelLikeForm

Root node.

/ExcelLikeForm/Caption

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

/ExcelLikeForm/DataDefinition

The data source.

/ExcelLikeForm/BusinessObject

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

/ExcelLikeForm/SpreadJSONColumn

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

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

/ExcelLikeForm/TemplateIDColumn

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

/ExcelLikeForm/TemplateNameColumn

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

/ExcelLikeForm/NameColumn

The name of a column in the DataDefinition that contains the name of the excel. Optional setting.

/ExcelLikeForm/DataCollectorSP

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/DataDistributorSP

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 DataDistributorSP stored procedure.

/ExcelLikeForm/DataParametersTable

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/DataValuesTable

Optional, the name of the table that the system uses for the loading and saving of the data. The DataCollectorSP and the DataDistributorSP reads and writes this table according to the parameters in DataParametersTabletrue

/ExcelLikeForm/SheetsToHide

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

/ExcelLikeForm/TemplateURL

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 java scripts 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="iso-8859-2"?> <ExcelLikeForm> <Name>ELFHQReadOnly</Name> <Caption /> <DataDefinition>DDHQExcel</DataDefinition> <BusinessObject>BusinessObjectExcelReadOnly</BusinessObject> <SpreadJSONColumn>JSON</SpreadJSONColumn> <IDColumn>id</IDColumn> <TemplateIDColumn>TemplateExcelID</TemplateIDColumn> <TemplateNameColumn>TemplateName</TemplateNameColumn> <NameColumn>Name</NameColumn> <DataCollectorSP>osp_wrk_ExcelTakeOut_CollectData</DataCollectorSP> <DataDistributorSP>osp_wrk_ExcelTakeOut_DistributeData</DataDistributorSP> <DataParametersTable>orn_ExcelTakeOutParameters</DataParametersTable> <DataValuesTable>orn_ExcelTakeOutData</DataValuesTable> <TemplateURL>delivery/js/forecastexcellikeform/view.html</TemplateURL> </ExcelLikeForm>

  • Last update: 19 weeks 3 days ago
  • Effector