Skip to content

Commit

Permalink
Rel-984674 import service staging governance correct loadfile paths i…
Browse files Browse the repository at this point in the history
…n relativity import samples (#28)

* REL-984674 change REST samples

* REL-984674 change Kepler samples

* REL-984674 correct DotNet samples

* REL-984674 correct docs

* REL-984674 PR improvemnts
  • Loading branch information
annasojkapal committed Aug 20, 2024
1 parent 6191ceb commit bbd1562
Show file tree
Hide file tree
Showing 57 changed files with 77 additions and 77 deletions.
4 changes: 2 additions & 2 deletions OpenAPI/openapidoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -1289,7 +1289,7 @@
"type": "string",
"description": "Custom provided fileshare location where dataset (load file) will be generated. When not provided the default fileshare location for selected workspace is used.",
"nullable": true,
"example": "\\files\\T001\\Files\\EDDS1015024\\DiagnosticJob"
"example": "\\\\files\\T001\\StructuredData\\Import\\EDDS1015024\\DiagnosticJob"
}
}
},
Expand Down Expand Up @@ -1473,7 +1473,7 @@
"Path": {
"type": "string",
"description": "File localization",
"example": "\\files\\T001\\Files\\tmp_loadfile\\loadfile.dat"
"example": "\\\\files\\T001\\StructuredData\\Import\\tmp_loadfile\\loadfile.dat"
},
"EndOfLine": {
"$ref": "#/components/schemas/DataSourceEndOfLine"
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ User can cancel running Import Job in every moment. All related data sources wil
{
"dataSourceSettings": {
"Path": "\\files\\T001\\Files\\SampleDataSources\\load_file.dat",
"Path": "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file.dat",
"FirstLineContainsColumnNames": true,
"StartLine": 1,
"ColumnDelimiter": "|",
Expand All @@ -406,7 +406,7 @@ User can cancel running Import Job in every moment. All related data sources wil
> C# builders
DataSourceSettings dataSourceSettings = DataSourceSettingsBuilder.Create()
.ForLoadFile("\\files\\T001\\Files\\SampleDataSources\\load_file.dat")
.ForLoadFile("\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file.dat")
.WithDelimiters(d => d
.WithColumnDelimiters('|')
.WithQuoteDelimiter('^')
Expand All @@ -424,7 +424,7 @@ User can cancel running Import Job in every moment. All related data sources wil
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.LoadFile,
Path = "\\files\\T001\\Files\\SampleDataSources\\load_file.dat",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file.dat",
NewLineDelimiter = '#',
ColumnDelimiter = '|',
QuoteDelimiter = '^',
Expand Down Expand Up @@ -526,7 +526,7 @@ User can cancel running Import Job in every moment. All related data sources wil
{
"dataSourceSettings": {
"Path": "\\files\\T001\\Files\\SampleDataSources\\opticon_file.opt",
"Path": "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_file.opt",
"FirstLineContainsColumnNames": false,
"StartLine": 0;
"EndOfLine" = 0
Expand All @@ -540,7 +540,7 @@ User can cancel running Import Job in every moment. All related data sources wil
> C# Builders
DataSourceSettings dataSourceSettings = DataSourceSettingsBuilder.Create()
.ForOpticonFile("\\files\\T001\\Files\\SampleDataSources\\opticon_file.opt")
.ForOpticonFile("\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_file.opt")
.WithDefaultDelimitersForOpticonFile()
.WithEndOfLineForWindows()
.WithStartFromBeginning()
Expand All @@ -552,7 +552,7 @@ User can cancel running Import Job in every moment. All related data sources wil
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.Opticon,
Path = "\\files\\T001\\Files\\SampleDataSources\\opticon_file.opt",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_file.opt",
NewLineDelimiter = default,
ColumnDelimiter = default,
QuoteDelimiter = default,
Expand Down Expand Up @@ -677,7 +677,7 @@ User can cancel running Import Job in every moment. All related data sources wil
{
"dataSourceSettings": {
"Path": "\\files\\T001\\Files\\SampleDataSources\\load_file.dat",
"Path": "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file.dat",
"FirstLineContainsColumnNames": true,
"StartLine": 1,
"ColumnDelimiter": "|",
Expand All @@ -695,7 +695,7 @@ User can cancel running Import Job in every moment. All related data sources wil
> C# builder
DataSourceSettings dataSourceSettings = DataSourceSettingsBuilder.Create()
.ForLoadFile("\\files\\T001\\Files\\SampleDataSources\\load_file.dat)
.ForLoadFile("\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file.dat)
.WithDelimiters(d => d
.WithColumnDelimiters('|')
.WithQuoteDelimiter('^')
Expand All @@ -713,7 +713,7 @@ User can cancel running Import Job in every moment. All related data sources wil
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.LoadFile,
Path = "\\files\\T001\\Files\\SampleDataSources\\load_file.dat",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file.dat",
NewLineDelimiter = '#',
ColumnDelimiter = '|',
QuoteDelimiter = '^',
Expand Down Expand Up @@ -1131,7 +1131,7 @@ List of samples:


// Path to the file in opticon format used in data source settings.
const string opticonFilePath = "\\files\\T001\\Files\\SampleDataSources\\opticon_01.opt";
const string opticonFilePath = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_01.opt";

- Run application

Expand Down Expand Up @@ -1187,7 +1187,7 @@ List of samples:
- Update variable which defines the path to the load file/opticon file (e.g. $opticonFilePath) according to the location where you copied sample data.

$workspaceId = 1000000
$loadFilePath = "\\files\T001\Files\SampleDataSources\load_file_01.dat"
$loadFilePath = "\\files\T001\StructuredData\Import\SampleDataSources\load_file_01.dat"

- Update other Ids related to your workspace - productionSetsArtifactId , rootFolderId,rdoArtifactTypeID. They are required only by specific samples.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public async Task Sample01_ImportNativeFiles()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public async Task Sample02_ImportDocumentsInOverlayMode()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// overlay key field
const string overlayKeyField = "Control Number";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ public async Task Sample03_ImportFromTwoDataSources()
const int filePathColumnIndex = 22;

// Path to the load files used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_02.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_02.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ public async Task Sample04_AddDataSourceToRunningJob()
const int filePathColumnIndex = 22;

// Path to the load files used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_02.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_02.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public async Task Sample05_ImportDocumentsWithExtractedText()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

var createJobPayload = new
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public async Task Sample06_ImportDocumentsToSelectedFolder()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile03Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_03.dat";
const string loadFile03Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_03.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public async Task Sample07_DirectImportSettingsForDocuments()
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.LoadFile,
Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_04.dat",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_04.dat",
NewLineDelimiter = '#',
ColumnDelimiter = '|',
QuoteDelimiter = '^',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public async Task Sample08_ImportImages()
const int workspaceId = 1000000;

// Path to the file in opticon format used in data source settings.
const string opticonFilePath = "\\files\\T001\\Files\\SampleDataSources\\opticon_01.opt";
const string opticonFilePath = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_01.opt";

// Create request's payload
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public async Task Sample09_ImportProductionFiles()
const int productionSetsArtifactId = 1000001;

// Path to the file in opticon format used in data source settings.
const string opticonFilePath = "\\files\\T001\\Files\\SampleDataSources\\opticon_02.opt";
const string opticonFilePath = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_02.opt";

// Create request's payload
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public async Task Sample10_ImportImagesInAppendOverlayMode()
const int workspaceId = 1000000;

// Path to the file in opticon format used in data source settings.
const string opticonFilePath = "\\files\\T001\\Files\\SampleDataSources\\opticon_01.opt";
const string opticonFilePath = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_01.opt";

// Create request's payload
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public async Task Sample11_DirectImportSettingsForImages()
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.Opticon,
Path = "\\files\\T001\\Files\\SampleDataSources\\opticon_01.opt",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_01.opt",
NewLineDelimiter = default,
ColumnDelimiter = default,
QuoteDelimiter = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public async Task Sample12_ImportRelativityDynamicObject()
const int domainArtifactTypeID = 1000027;

// Path to the load file used in data source settings.
const string rdoLoadFile = "\\files\\T001\\Files\\SampleDataSources\\rdo_load_file_01.dat";
const string rdoLoadFile = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\rdo_load_file_01.dat";

// Create request's payload
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public async Task Sample13_ImportRdoWithParent()
const int rdoArtifactTypeID = 2000000;

// Path to the load file used in data source settings.
const string rdoLoadFile = "\\files\\T001\\Files\\SampleDataSources\\rdo_load_file_03.dat";
const string rdoLoadFile = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\rdo_load_file_03.dat";

// Create request's payload
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public async Task Sample14_DirectImportSettingsForRdo()
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.LoadFile,
Path = "\\files\\T001\\Files\\SampleDataSources\\rdo_load_file_02.dat",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\rdo_load_file_02.dat",
NewLineDelimiter = '#',
ColumnDelimiter = '|',
QuoteDelimiter = '^',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public async Task Sample19_GetImportJobDetailsAndProgress()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public async Task Sample20_GetDataSourceDetailsAndProgress()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public async Task Sample21_CancelStartedJob()
// Destination workspace artifact Id.
const int workspaceId = 1000000;

const string loadFile07PathTemplate = "\\files\\T001\\Files\\SampleDataSources\\load_file_07_{0}.dat";
const string loadFile07PathTemplate = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_07_{0}.dat";

// set of columns indexes in load file used in import settings.
const int controlNumberColumnIndex = 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ public async Task Sample23_GetDataSourceErrors()

// Path to the load file used in data source settings.
// first file contains incorrect values.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_05.dat";
const string loadFile02Path = "\\files\\T001\\Files\\SampleDataSources\\notExistingFile.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_05.dat";
const string loadFile02Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\notExistingFile.dat";

// Create payload for request.
var createJobPayload = new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public async Task Sample01_ImportNativeFiles()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// Configuration settings for document import. Builder is used to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public async Task Sample02_ImportDocumentsInOverlayMode()
const int filePathColumnIndex = 22;

// Path to the load file used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// overlay key field
const string overlayKeyField = "Control Number";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ public async Task Sample03_ImportFromTwoDataSources()
const int filePathColumnIndex = 22;

// Path to the load files used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_02.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_02.dat";

// Configuration settings for document import. Builder is used to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public async Task Sample04_AddDataSourceToRunningJob()
const int filePathColumnIndex = 22;

// Path to the load files used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_02.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";
const string loadFile02Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_02.dat";

// Configuration settings for document import. Use builder to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public async Task Sample05_ImportDocumentsWithExtractedText()
const int filePathColumnIndex = 22;

// Path to the load files used in data source settings.
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_01.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_01.dat";

// Configuration settings for document import. Builder is used to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public async Task Sample06_ImportDocumentsToSelectedFolder()
const int controlNumberColumnIndex = 0;
const int fileNameColumnIndex = 13;
const int filePathColumnIndex = 22;
const string loadFile01Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_03.dat";
const string loadFile01Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_03.dat";

// Configuration settings for document import. Builder is used to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public async Task Sample07_DirectImportSettingsForDocuments()
DataSourceSettings dataSourceSettings = new DataSourceSettings
{
Type = DataSourceType.LoadFile,
Path = "\\files\\T001\\Files\\SampleDataSources\\load_file_04.dat",
Path = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\load_file_04.dat",
NewLineDelimiter = '#',
ColumnDelimiter = '|',
QuoteDelimiter = '^',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public async Task Sample08_ImportImages()
const int workspaceId = 1000000;

// Path to the file in opticon format used in data source settings.
const string opticonFilePath = "\\files\\T001\\Files\\SampleDataSources\\opticon_01.opt";
const string opticonFilePath = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_01.opt";

// Configuration settings for document import. Builder is used to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public async Task Sample09_ImportProductionFiles()
const int productionSetsArtifactId = 1000000;

// Path to the file in opticon format used in data source settings.
const string filePath = "\\files\\T001\\Files\\SampleDataSources\\opticon_02.opt";
const string filePath = "\\\\files\\T001\\StructuredData\\Import\\SampleDataSources\\opticon_02.opt";

// Configuration settings for document import. Builder is used to create settings.
ImportDocumentSettings importSettings = ImportDocumentSettingsBuilder.Create()
Expand Down
Loading

0 comments on commit bbd1562

Please sign in to comment.