This page describe the parameters to use to start an export execution.
Main object
| Field | Data Type | Description |
|---|---|---|
| DBConnection | string | Source Connection name |
| ExportingEntities | Array[ExportingEntity] | entities list to export |
| OnlyExportStructure | boolean | export only the structure without any record |
| ExportPlain | boolean | if it is a export to a zip file, export with a format to open with Excel |
| ExportToDatabase | boolean | true to export to a database; otherwise, to a zip file |
| DestinationDBConnection | string | Destination Connection name (If it is a export to a database) |
| ChunkSize | integer | maximum size in kb in a chunk. If set to 0, it will be used the default value (100.000 to direct database connections and 12500 to the REST) |
| ChunkRecords | integer | maximum number of records in a chunk. If set to 0, it will be used the default value (20000) |
| KeepChunkSize | boolean | use always the same number of records per chunk |
| SmartOSSYSDataExport | boolean | only export the referenced ossys_* records in the entities foreign keys |
| CreateFKConstraints | boolean | if the export is to a database, set to true to create the foreign key constraints |
| UseQueryByRows | boolean | Use Query By Rows to get Chunks |
| SampleSizeKB | integer | Size of chunk sample for table size calculation |
| SampleSizeKB4Bin | integer | Size of chunk sample for table, with binary data, size calculation |
| DeleteExportFile | boolean | Delete the File from disk after saving in Database |
| ChunkRecordsJustIds | integer | Records chunk to use in the just id instructions (default is 200000) |
| ExportToSFTP | boolean | true to export to a SFTP connection |
| DestinationSFTPConnection | string | if the export is to SFTP, this is the connection to use |
| ExportToFileSystemPath | boolean | true to export to a folder |
| DestinationFileSystemPath | string | if the export is to a folder, this is the folder path |
| UseNewFileName | boolean | true to specify the export file name |
| NewFileName | string | if is to define the output filename, this is the zip name to use. Use the placeholder {date} to include the date in the name (YYYYMMDD_hhmmss) |
ExportingEntity object
| Field | Data Type | Description |
|---|---|---|
| SrcESpaceId | integer | entity espace id from the source |
| SrcESpaceSSKey | string | entity espace ss_key from the source |
| SrcESpaceName | string | entity espace name from the source |
| SrcEntityId | integer | entity id from the source |
| SrcEntitySSKey | string | entity ss_key from the source |
| SrcEntityName | string | entity name from the source |
| WhereClause | string | where filter to get the records from the source |
| UserMappedTable | boolean | choose a set of unique attributes to be used as the mapper of the information of this entity. The value of those attributes will be used to map the information instead of the natural primary key. |
| UserMappedUniqueAttributeIdList | Array[integer] | source attributes ids to use as mapper |
| UserMappedUniqueAttributeList | Array[string] | source attributes names to use as mapper |
| FieldsDecision | Array[FieldDecision] | change the records source values |
| TableNameInConfiguration | boolean | if the export is to a database, specify the destination table name; otherwise, it will create with the same name from the source |
| TableNameInDestination | string | if the export is to a database, define the destination table name in the destination |
FieldDecision object
| Field | Data Type | Description |
|---|---|---|
| MigrationFieldDecision | integer | actions to take in the column. 20 to ignore, 50 to scramble, 60 to anonymize or 70 to use a static value. |
| MigrationFieldDecisionName | string | name of the action to take (Ignore, Scramble, Anonymize or StaticValue) |
| AttributeId | integer | attribute id from the source |
| StaticValueToUse | string | If the action is to use a static value, will be replace with this value. |
Sample export to database Configuration
{
"DBConnection": "Source Connection Name",
"ExportingEntities": [
{
"SrcESpaceId": 1,
"SrcESpaceSSKey": "ab123dc4d-4321-1234-ab12-d123a3214a82",
"SrcESpaceName": "Espace Name",
"SrcEntityId": 456,
"SrcEntitySSKey": "3212a0fb-4221-2322-basc-7f07ab123947",
"SrcEntityName": "Entity Name",
"WhereClause": "",
"UserMappedTable": false,
"UserMappedUniqueAttributeIdList": [],
"UserMappedUniqueAttributeList": [],
"FieldsDecision": [],
"TableNameInConfiguration": true,
"TableNameInDestination": "EntityA"
}
],
"OnlyExportStructure": false,
"ExportPlain": false,
"ExportToDatabase": true,
"DestinationDBConnection": "Destination Connection Name",
"ChunkSize" : 0,
"ChunkRecords" : 0,
"KeepChunkSize" : false,
"SmartOSSYSDataExport" : false,
"CreateFKConstraints" : false,
"UseQueryByRows" : false
}
Sample export to file Configuration
{
"DBConnection": "Source Connection Name",
"ExportingEntities": [
{
"SrcESpaceId": 1,
"SrcESpaceSSKey": "ab123dc4d-4321-1234-ab12-d123a3214a82",
"SrcESpaceName": "Espace Name",
"SrcEntityId": 456,
"SrcEntitySSKey": "3212a0fb-4221-2322-basc-7f07ab123947",
"SrcEntityName": "Entity Name",
"WhereClause": "",
"UserMappedTable": false,
"UserMappedUniqueAttributeIdList": [],
"UserMappedUniqueAttributeList": [],
"FieldsDecision": [],
"TableNameInConfiguration": false,
"TableNameInDestination": ""
}
],
"OnlyExportStructure": false,
"ExportPlain": false,
"ExportToDatabase": false,
"DestinationDBConnection": "",
"ChunkSize" : 0,
"ChunkRecords" : 0,
"KeepChunkSize" : false,
"SmartOSSYSDataExport" : false,
"CreateFKConstraints" : false,
"UseQueryByRows" : false
}
Sample export to SFTP Configuration
{
"DBConnection": "Source Connection Name",
"ExportingEntities": [
{
"SrcESpaceId": 1,
"SrcESpaceSSKey": "ab123dc4d-4321-1234-ab12-d123a3214a82",
"SrcESpaceName": "Espace Name",
"SrcEntityId": 456,
"SrcEntitySSKey": "3212a0fb-4221-2322-basc-7f07ab123947",
"SrcEntityName": "Entity Name",
"WhereClause": "",
"UserMappedTable": false,
"UserMappedUniqueAttributeIdList": [],
"UserMappedUniqueAttributeList": [],
"FieldsDecision": [],
"TableNameInConfiguration": false,
"TableNameInDestination": ""
}
],
"OnlyExportStructure": false,
"ExportPlain": false,
"ExportToSFTP": true,
"DestinationSFTPConnection": "SFTP Connection",
"ChunkSize" : 0,
"ChunkRecords" : 0,
"KeepChunkSize" : false,
"SmartOSSYSDataExport" : false,
"CreateFKConstraints" : false,
"UseQueryByRows" : false
}
Sample export to Folder Configuration
{
"DBConnection": "Source Connection Name",
"ExportingEntities": [
{
"SrcESpaceId": 1,
"SrcESpaceSSKey": "ab123dc4d-4321-1234-ab12-d123a3214a82",
"SrcESpaceName": "Espace Name",
"SrcEntityId": 456,
"SrcEntitySSKey": "3212a0fb-4221-2322-basc-7f07ab123947",
"SrcEntityName": "Entity Name",
"WhereClause": "",
"UserMappedTable": false,
"UserMappedUniqueAttributeIdList": [],
"UserMappedUniqueAttributeList": [],
"FieldsDecision": [],
"TableNameInConfiguration": false,
"TableNameInDestination": ""
}
],
"OnlyExportStructure": false,
"ExportPlain": false,
"ExportToFileSystemPath": true,
"DestinationFileSystemPath": "C:\\Program Files\\OutputFolder",
"ChunkSize" : 0,
"ChunkRecords" : 0,
"KeepChunkSize" : false,
"SmartOSSYSDataExport" : false,
"CreateFKConstraints" : false,
"UseQueryByRows" : false
}