About the Excel Component API

The Excel component provides an API for programmatically configuring the Excel component using a Java program.

For more information about component APIs, see Component APIs.

The Excel component API consists of the following methods:

  • set("workbook", File workbookFile). This method sets the Excel workbook file to use.

  • add("mapping", String[] mappingInfo). This method adds a mapping to the list of actions to be executed when the Excel component executes. The mapping can be to or from a new or existing parameter and can be either a single cell or a range of cells. By default, the mapping is inserted into the list based on the direction specified—either as the last mapping into Excel or the last mapping from Excel. The mappingInfo array must contain the following:

  • mappingInfo[0]. The name of the parameter to map. If the parameter does not currently exist on the component, Isight creates a new parameter and adds it to the component when apply() is called for this API instance.

  • mappingInfo[1]. The name of the Excel sheet within the current workbook file to map to/from.

  • mappingInfo[2]. The cells to map to/from (e.g., B4 or A3:C6).

  • mappingInfo[3]. The direction of the mapping, either "1" to map TO Excel or "2" to map FROM Excel.

  • getArray("mapping", String parameterName). This method returns the mapping information for any mapping that exists to/from the specified parameter in the form of a string array. See the add("mapping", String[] mappingInfo) description above for the definition of the mappingInfo[] array contents that are returned.

  • get/set("closeoption"). This method allows you to get/set whether the workbook will close or not after execution (either each time this component executes or after the entire job completes). The integer value used when setting this option should be 0 = never close, 1 = close after job, or 2 = close after each work item.

  • get/set("storeinmodel"). This method allows you to get/set whether or not to store the workbook in the model. If this option is set to false, the workbook will be referenced from its current location and will be expected to exist when the component executes.

  • get/set("visible"). This method allows you to get/set whether or not the Excel application will be visible when the component executes.