Connectors Reference
Vena’s interface pairs the best parts of Excel and the power of a full finance-led planning solution so you can streamline your workflows without upending your processes. Connect to Vena to import data from a file into your cube, or to export data from your cube to a file.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Gets all the models you have access to |
|
|
Select a data model |
|
|
Trigger an ETL job to import data into Vena |
|
|
ExportAttributes (string modelIdPath, ExportAttributesParameterLidsBody lidsBody) |
Export attributes from a model |
|
Export hierarchies from a model |
|
|
ExportValues (string modelIdPath, ExportValuesParameterValuesBody valuesBody) |
Export values from a model |
|
ExportLIDs (string modelIdPath, ExportLIDsParameterLidsBody lidsBody) |
Export LIDs from a model |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Gets all the models you have access to
Description: Fetch available models
Syntax:
VenaSolutions.FetchModels ()
Returns:
Type:array of (ModelDTO)
Summary: Select a data model
Description: Fetch the ETL templates of the selected model
Syntax:
VenaSolutions.FetchTemplates (string modelIdPath)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
modelIdPath |
string (Data Model) |
Select Model you want templates for |
True |
Returns:
Type:array of (TemplateDTO)
Summary: Trigger an ETL job to import data into Vena
Description: Upload hierarchy, intersections, lids, or attributes to a model
Syntax:
VenaSolutions.ETLUpload (string modelIdPath, string templateId, [advanced]string fileName, [advanced]string file, [advanced]string fileType, [advanced][Optional]string fileEncoding)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
modelIdPath |
string (Data Model) |
Select the Vena data model |
True |
|
|
templateId |
string (ETL template) |
Select an ETL template |
True |
|
|
fileName |
string (File name) |
Select the file name |
True |
|
|
file |
string (File content to upload) |
Select the file content to upload |
True |
|
|
fileType |
string (File type)Values: [CSV, PSV, TDF] |
Select the file type |
True |
|
|
fileEncoding |
string (File encoding)Values: [UTF-8, UTF-16, Cp1252] |
Select the file encoding |
False |
Returns:
Type:ETLJob
Summary: Export attributes from a model
Description: Export attributes from a model
Syntax:
VenaSolutions.ExportAttributes (string modelIdPath, ExportAttributesParameterLidsBody lidsBody)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
modelIdPath |
string (Data Model) |
Select the Vena data model |
True |
|
|
lidsBody |
ExportAttributesParameterLidsBody
|
|
True |
Returns:
Type:string
Summary: Export hierarchies from a model
Description: Exports hierarchies from a model
Syntax:
VenaSolutions.ExportHierarchies (string modelIdPath, [Optional]ExportHierarchiesParameterHierarchiesBody hierarchiesBody)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
modelIdPath |
string (Data Model) |
Select the Vena data model |
True |
|
|
hierarchiesBody |
ExportHierarchiesParameterHierarchiesBody
|
|
False |
Returns:
Type:string
Summary: Export values from a model
Description: Export values from a model
Syntax:
VenaSolutions.ExportValues (string modelIdPath, ExportValuesParameterValuesBody valuesBody)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
modelIdPath |
string (Data Model) |
Select the Vena data model |
True |
|
|
valuesBody |
ExportValuesParameterValuesBody
|
|
True |
Returns:
Type:string
Summary: Export LIDs from a model
Description: Export LIDs from a model
Syntax:
VenaSolutions.ExportLIDs (string modelIdPath, ExportLIDsParameterLidsBody lidsBody)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
modelIdPath |
string (Data Model) |
Select the Vena data model |
True |
|
|
lidsBody |
|
|
True |
Returns:
Type:string
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
|
|
pauseRequested |
boolean
|
|
|
templateId |
string
|
|
|
errorMessage |
string
|
|
|
userId |
string
|
|
|
lockProperty |
string
|
|
|
resumable |
boolean
|
|
|
user |
|
|
|
createdDate |
integer
|
|
|
phase |
string
|
|
|
id |
string
|
|
|
shortMessage |
string
|
|
|
saveJob |
boolean
|
|
|
log |
array of (LogItem)
|
|
|
lockId |
string
|
|
|
rollbackRequired |
boolean
|
|
|
cancelRequested |
boolean
|
|
|
updatedDate |
integer
|
|
|
version |
integer
|
|
|
requestId |
string
|
|
|
error |
boolean
|
|
|
validationResults |
string
|
|
|
attributes |
array of (string)
|
|
|
currentStepNumber |
integer
|
|
|
numCalcOverwrite |
integer
|
|
|
metadata |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
integer
|
|
|
message |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schemaVersion |
integer
|
|
|
steps |
array of (ETLStep)
|
|
|
name |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dataType |
string
|
|
|
stepType |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
showHeaders |
boolean Show Header |
Show headers in the export |
|
queryString |
string MQL Query String |
MQL Query |
|
format |
string File Format |
Select the file format Values: [CSV, PSV, TDF] |
|
encoding |
string File Encoding |
Select the file encoding Values: [UTF-8, UTF-16, Cp1252] |
|
destination |
string
|
Destination always to file |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
showHeaders |
boolean Show Header |
Show headers in the export |
|
queryString |
string MQL Query String |
MQL Query |
|
format |
string File Format |
Select the file format Values: [CSV, PSV, TDF] |
|
encoding |
string File Encoding |
Select the file encoding Values: [UTF-8, UTF-16, Cp1252] |
|
destination |
string
|
Destination always to file |
|
exportMemberIds |
boolean Export Member IDs |
Include member IDs in the export |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
showHeaders |
boolean Show Header |
Show headers in the export |
|
queryString |
string MQL Query String |
MQL Query |
|
format |
string File Format |
Select the file format Values: [CSV, PSV, TDF] |
|
encoding |
string File Encoding |
Select the file encoding Values: [UTF-8, UTF-16, Cp1252] |
|
destination |
string
|
Destination always to file |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
showHeaders |
boolean Show Header |
Show headers in the export |
|
queryString |
string MQL Query String |
MQL Query |
|
format |
string File Format |
Select the file format Values: [CSV, PSV, TDF] |
|
encoding |
string File Encoding |
Select the file encoding Values: [UTF-8, UTF-16, Cp1252] |
|
destination |
string
|
Destination always to file |
|
includeExternalId |
boolean Include External IDs |
Include the External IDs in the export |
|
isNamedHeader |
boolean Named Dimensions |
Include named dimensions in the header |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
clonedFromId |
string
|
|
|
updateReason |
string
|
|
|
createdBy |
string
|
|
|
scripts |
array of (string)
|
|
|
updatedTimestamp |
integer
|
|
|
updatedEpochSeconds |
string
|
|
|
key |
string
|
|
|
updatedBy |
string
|
|
|
modelFolder |
string
|
|
|
id |
string
|
|
|
name |
string
|
Name of the model |
|
createdTimestamp |
integer
|
|
|
createdEpochSeconds |
string
|
|
|
version |
integer
|
|
|
desc |
string
|
Description of the model |
|
dimensionNumbers |
array of (integer)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
metadata |
|
|
|
hasSchedule |
boolean
|
|
|
unsaved |
string
|
|
|
stepType |
string
|
|
|
id |
string
|
|