Use this method to Create, Update, Delete, Import from binary artifacts
| Overload Name | Description |
|---|---|
| AddSheet | Add a worksheet from the current view to a specified BinaryArtifact. |
| AddWorkbook | Add all worksheets from the current view to a specified BinaryArtifact |
| CreateFromFile | Create a BinaryArtifact from a file. |
| CreateFromSheet | Create a BinaryArtifact from a specified worksheet of the current view. |
| CreateFromWorkbook | Create a BinaryArtifact from the workbook of the current view. |
| Delete | Delete a specified BinaryArtifact. |
| ImportRange | Copy a specified range from a BinaryArtifact into the current view. |
| ImportSheet | Import a specified worksheet from a BinaryArtifact into the current view. |
| ImportWorkbook | Import all sheets from a specified BinaryArtifact into the current view. |
Add a worksheet from the current view to a specified BinaryArtifact.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SheetName | Specify the binary artifact sheet-name. |
| NewSheetName | If not blank the loaded sheet will be named per the specified NewSheetName. |
| ID | Specify the ID of the binary artifact. (Required) |
| VersionPolicy |
Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestNewSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| ValuesOnly |
Whether to replace cell formulas with cell values. Default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ToPositionPolicy |
Select how to specify where to copy the worksheet to. If left blank "Last" will be used.
Specify one of the following values or an arbitrary value:
<blank>FirstLastToPositionOfSheetNamedToPositionNumber
|
| ToPosition | If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number. |
| Password | The password assigned to the saved workbook. |
Add all worksheets from the current view to a specified BinaryArtifact
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ID | Specify the ID of the binary artifact. (Required) |
| VersionPolicy |
Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestNewSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| ValuesOnly |
Whether to replace cell formulas with cell values. Default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ToPositionPolicy |
Select how to specify where to copy the worksheet to. If left blank "Last" will be used.
Specify one of the following values or an arbitrary value:
<blank>FirstLastToPositionOfSheetNamedToPositionNumber
|
| ToPosition | If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number. |
| Password | The password assigned to the saved workbook. |
Create a BinaryArtifact from a file.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Type |
Specify the BinaryArtifact type. If left blank Excel will be used for Excel file types. Otherwise Other will be used. Other: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension.
Specify one of the following values or an arbitrary value:
<blank>ExcelOther
|
| ID | Specify the ID of the binary artifact. (Required) |
| Name | Specify the name of the binary artifact. |
| Description | Specify the description for the binary artifact. |
| VersionPolicy |
Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestNewSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| Filename | Specify the Filename of the binary artifact. When creating a BinaryArtifact, if Filename is left blank the BinaryArtifact's ID will be used. |
| Folder | Specify the full path to the folder that contains the file. |
| ValuesOnly |
Whether to replace cell formulas with cell values. Default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Password | The password assigned to the saved workbook. |
Create a BinaryArtifact from a specified worksheet of the current view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SheetName | Specify the binary artifact sheet-name. |
| Type |
Specify the BinaryArtifact type. If left blank Excel will be used for Excel file types. Otherwise Other will be used. Other: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension.
Specify one of the following values or an arbitrary value:
<blank>ExcelOther
|
| ID | Specify the ID of the binary artifact. (Required) |
| Name | Specify the name of the binary artifact. |
| Description | Specify the description for the binary artifact. |
| VersionPolicy |
Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestNewSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| ValuesOnly |
Whether to replace cell formulas with cell values. Default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Filename | Specify the Filename of the binary artifact. When creating a BinaryArtifact, if Filename is left blank the BinaryArtifact's ID will be used. |
| FileType |
Specify the file type of saved workbook. Defaults to the current view's file type if not specified. CSV: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel8: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension. OpenXMLWorkbook: Specifies the Excel 2007-2016 Open XML file format. Typically saved with the .xlsx filename extension. OpenXMLWorkbookMacroEnabled: Specifies the Excel 2007-2016 macro enabled Open XML file format. Typically saved with the .xlsm filename extension. UnicodeText: Specifies a tab-delimited Unicode text file encoded as UTF-8. Typically saved with the .txt filename extension.
Specify one of the following values or an arbitrary value:
<blank>CSVExcel8OpenXMLWorkbookOpenXMLWorkbookMacroEnabledUnicodeText
|
| Password | The password assigned to the saved workbook. |
Create a BinaryArtifact from the workbook of the current view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Type |
Specify the BinaryArtifact type. If left blank Excel will be used for Excel file types. Otherwise Other will be used. Other: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension.
Specify one of the following values or an arbitrary value:
<blank>ExcelOther
|
| ID | Specify the ID of the binary artifact. (Required) |
| Name | Specify the name of the binary artifact. |
| Description | Specify the description for the binary artifact. |
| VersionPolicy |
Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestNewSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| ValuesOnly |
Whether to replace cell formulas with cell values. Default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Filename | Specify the Filename of the binary artifact. When creating a BinaryArtifact, if Filename is left blank the BinaryArtifact's ID will be used. |
| FileType |
Specify the file type of saved workbook. Defaults to the current view's file type if not specified. CSV: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel8: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension. OpenXMLWorkbook: Specifies the Excel 2007-2016 Open XML file format. Typically saved with the .xlsx filename extension. OpenXMLWorkbookMacroEnabled: Specifies the Excel 2007-2016 macro enabled Open XML file format. Typically saved with the .xlsm filename extension. UnicodeText: Specifies a tab-delimited Unicode text file encoded as UTF-8. Typically saved with the .txt filename extension.
Specify one of the following values or an arbitrary value:
<blank>CSVExcel8OpenXMLWorkbookOpenXMLWorkbookMacroEnabledUnicodeText
|
| Password | The password assigned to the saved workbook. |
Delete a specified BinaryArtifact.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ID | Specify the ID of the binary artifact. (Required) |
| DeleteVersionPolicy |
Determines the Version of the BinaryArtifact to be deleted. If not specified and the SpecificVersion argument has no value then Latest will be used. All = all versions of the Binary Artifact. Latest = latest version of the Binary Artifact. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
AllLatestSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
Copy a specified range from a BinaryArtifact into the current view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ID | Specify the ID of the binary artifact. (Required) |
| ImportVersionPolicy |
Determines the BinaryArtifact version to be imported from. If not specified and the SpecificVersion argument has no value then Latest will be used. Latest = latest version of the Binary Artifact. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| CopyRange | The range from the specified BinaryArtifact that will be copied into the current workbook. |
| PasteRange | The address in the current workbook to copy the CopyRange's cells to. |
| OutputRangeName (8.0) | The range where the range is imported to will be given the specified name. |
| InsertPolicy |
Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.
Specify one of the following values or an arbitrary value:
<blank>RowsColumnsRowsAndColumnsShiftCellsRightShiftCellsDown
|
| PasteType |
Specifies the type of paste to perform.
Specify one of the following values or an arbitrary value:
<blank>AllColumnWidthsCommentsFormatsFormulasFormulasAndNumberFormatsValidationValuesValuesAndNumberFormats
|
| PasteOperation |
Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).
Specify one of the following values or an arbitrary value:
<blank>NoneAddSubtractMultiplyDivide
|
| CopyColumnWidths |
Whether to copy the column widths of the copy range.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyRowHeights |
Whether to copy the row heights of the copy range.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SkipBlanks |
If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Transpose |
Rows become columns. Columns become rows.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Password | The password assigned to the saved workbook. |
Import a specified worksheet from a BinaryArtifact into the current view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ID | Specify the ID of the binary artifact. (Required) |
| ImportVersionPolicy |
Determines the BinaryArtifact version to be imported from. If not specified and the SpecificVersion argument has no value then Latest will be used. Latest = latest version of the Binary Artifact. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| ValuesOnly |
Whether to replace cell formulas with cell values. Default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SheetName | Specify the binary artifact sheet-name. |
| NewSheetName | If not blank the loaded sheet will be named per the specified NewSheetName. |
| ToPositionPolicy |
Select how to specify where to copy the worksheet to. If left blank "Last" will be used.
Specify one of the following values or an arbitrary value:
<blank>FirstLastToPositionOfSheetNamedToPositionNumber
|
| ToPosition | If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number. |
| Password | The password assigned to the saved workbook. |
Import all sheets from a specified BinaryArtifact into the current view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ID | Specify the ID of the binary artifact. (Required) |
| ImportVersionPolicy |
Determines the BinaryArtifact version to be imported from. If not specified and the SpecificVersion argument has no value then Latest will be used. Latest = latest version of the Binary Artifact. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestSpecific
|
| SpecificVersion | The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| ToPositionPolicy |
Select how to specify where to copy the worksheet to. If left blank "Last" will be used.
Specify one of the following values or an arbitrary value:
<blank>FirstLastToPositionOfSheetNamedToPositionNumber
|
| ToPosition | If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number. |
| Password | The password assigned to the saved workbook. |