Commit 06532092: Merged PR 50449: Implemented call to API Gateway for send to productionAssist...

IOptimizationServices.cs

+9

/Client/HomagGroup.DigitalFactory.ApiGateway.Client/Interfaces/IOptimizationServices.cs

View

/// <returns></returns>

Task<ImportDetails> IDImportViaTemplateAsync(ImportFileInfo importInfo, string machineId,

string parameterId, string templateId, bool startOptimization = false, string jobName = null);

/// <summary>

/// Send optimized saw to productionAssist, using intelliDivide

/// </summary>

/// <param name="importInfo"></param>

/// <param name="templateId"></param>

/// <param name="jobName"></param>

/// <returns></returns>

Task<ImportDetails> IDSendToPAAsync(ImportFileInfo importInfo, string templateId, string jobName = null);

}

OptimizationServices.cs

-16+71

/Client/HomagGroup.DigitalFactory.ApiGateway.Client/Services/OptimizationServices.cs

View

public async Task<ImportDetails> IDImportViaTemplateAsync(ImportFileInfo importInfo, string machineId,

string parameterId, string templateId, bool startOptimization = false, string jobName = null)

{

if (string.IsNullOrEmpty(machineId))

ValidateImportViaTemplate(importInfo, machineId, parameterId, templateId);

var request = new HttpRequestMessage { Method = HttpMethod.Post };

var query = string.IsNullOrEmpty(jobName) ? string.Empty : $"?jobName={Uri.EscapeDataString(jobName)}";

if (startOptimization)

{

throw new ArgumentNullException(nameof(machineId));

query = AppendStartOptimizationParam(query);

}

if (string.IsNullOrEmpty(parameterId))

var uri = $"{Prefix}optimizations/import/machine/{machineId}/parameter/{parameterId}/template/{templateId}{query}";

request.RequestUri = new Uri(uri, UriKind.Relative);

request.Headers.AcceptLanguage.Clear();

request.Headers.AcceptLanguage.Add(new StringWithQualityHeaderValue(CultureInfo.CurrentUICulture.Name));

var multiContent = new MultipartFormDataContent();

byte[] data;

foreach (var file in importInfo.Files)

{

throw new ArgumentNullException(nameof(parameterId));

}

if (string.IsNullOrEmpty(templateId))

using (var br = new BinaryReader(file.Stream))

{

throw new ArgumentNullException(nameof(templateId));

data = br.ReadBytes((int)file.Stream.Length);

}

if (importInfo == null)

{

throw new ArgumentNullException(nameof(importInfo));

var bytes = new ByteArrayContent(data);

multiContent.Add(bytes, "files", file.Name);

}

request.Content = multiContent;

var response = await Client.SendAsync(request).ConfigureAwait(false);

response.HandleDeprecatedMessages(request, ApiVersion, ThrowExceptionOnDeprecatedCalls, OnDeprecatedAction);

response.EnsureSuccessStatusCodeWithDetails(request);

var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

return JsonConvert.DeserializeObject<ImportDetails>(content, SerializerSettings.Default);

}

/// <inheritdoc />

public async Task<ImportDetails> IDSendToPAAsync(ImportFileInfo importInfo, string templateId, string jobName = null)

{

ValidateSendtoPA(importInfo, templateId);

var request = new HttpRequestMessage { Method = HttpMethod.Post };

var query = string.IsNullOrEmpty(jobName) ? string.Empty : $"?jobName={Uri.EscapeDataString(jobName)}";

if (startOptimization)

{

query = AppendStartOptimizationParam(query);

}

var uri = $"{Prefix}optimizations/import/machine/{machineId}/parameter/{parameterId}/template/{templateId}{query}";

var uri = $"{Prefix}optimizations/import/template/{templateId}/productionAssist{query}";

request.RequestUri = new Uri(uri, UriKind.Relative);

request.Headers.AcceptLanguage.Clear();

request.Headers.AcceptLanguage.Add(new StringWithQualityHeaderValue(CultureInfo.CurrentUICulture.Name));

return JsonConvert.DeserializeObject<ImportDetails>(content, SerializerSettings.Default);

}

private static void ValidateImportViaTemplate(ImportFileInfo importInfo, string machineId, string parameterId,

string templateId)

{

if (string.IsNullOrEmpty(machineId))

{

throw new ArgumentNullException(nameof(machineId));

}

if (string.IsNullOrEmpty(parameterId))

{

throw new ArgumentNullException(nameof(parameterId));

}

if (string.IsNullOrEmpty(templateId))

{

throw new ArgumentNullException(nameof(templateId));

}

if (importInfo == null)

{

throw new ArgumentNullException(nameof(importInfo));

}

private static void ValidateSendtoPA(ImportFileInfo importInfo, string templateId)

{

if (importInfo == null)

{

throw new ArgumentNullException(nameof(importInfo));

}

if (string.IsNullOrEmpty(templateId))

{

throw new ArgumentNullException(nameof(templateId));

}

private string AppendStartOptimizationParam(string query)

{

const string startOptimizationParam = "startOptimization=true";

README.md

+98

/Documentation/README.md

View

1.11 |07.04.2022| Added new image sizes from MaterialManager

1.12 |31.08.2022| Added IDGetTemplates / IDImportViaTemplate

1.13 |02.09.2022| Updated IDImportViaTemplate

1.14 |12.10.2022| Added IDSendToPA

## Introduction

IDGetOptimizationSolutions | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/solutions` | Returns the optimization solutions | OptExecCut / NestingOptimization

IDGetOptimizationSolutionData | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/solutions/`⤶ `{solutionId}/data/{dataType}` | Returns the optimization solution data with the specified type Allowed values are: For cutting: saw / ptx For nesting: zip | OptExecCut / NestingOptimization

IDImportViaTemplate | POST | `_PREFIX_/optimizations/`⤶ `import/machine/{machineId}/`⤶ `parameter/{parameterId}/`⤶ `template/{templateId}{query}`| Creates a new optimization and imports information from csv or xls file with exiting template Allowed query parameters are: **jobName** for specifying a custom optimization job name **startOptimization** for also starting the job optimization | CuttingOptimizationImport

IDSendToPA | POST | `_PREFIX_/optimizations/`⤶ `import/template/{templateId}/`⤶ `productionAssist{query}` | Sends and aleady optimized SAW file to productionAssist Allowed query parameters are: **jobName** for specifying a custom optimization job name | CuttingOptimizationImport

##### productionManager interface

```

For content and response see above (Example 1).

##### intelliDivide interface: IDSendToPA

###### Input

Parameter | Description

------------------|---------------------------------------------------------------------------------------------------------------------------------------------

templateId | The Id of the template used to process the file import

jobName | Optionally pass the name of the newly created customer optimization If no jobName is passed, the file name will be used as customer optimization name

###### Example 1 (default)

Request

```text

POST /api/gw/optimizations/import/template/be1a5f21-8151-4ef0-96fe-c73491551a34/productionAssist

api-version: 2021-08-10

Accept-Language: en-US

Content-Type: multipart/form-data; boundary=--some-boundary

Authorization: Basic NjU1MDFEMDktMkJCOS00M0MyLUI5RDMtMUZCMDAwNkE3NjlFOnNkMDlzaGR1Z985OGffc2ZkZ3pz32Y5ZGhzYWZkaHNmZN92ODlwYmZkOXZiaGFmZGd2

tracestate: someinternaltracedata

```

The content type must be `multipart/form-data`. The key name for each file part is `files`.

Example body for a request with a SAW file:

```text

----some-boundary

Content-Disposition: form-data; name="files"; filename="file.saw"

Content-Type: multipart/form-data; boundary=--some-boundary

[Content of file.saw]

----some-boundary--

```

Response (200 Ok)

We currently return the following import states:

* Succeeded / Error

Response (200 Ok)

```text

Content-Type: application/json

```

```json

{

"state": "Succeeded",

"link": "https://intellidivide.homag.cloud/#/62b8fee0-1b35-41c1-b03a-b947304a0d58/jobs/9fde113d-cea7-4116-825a-0010d49870c9"

}

```

or

```text

Content-Type: application/json

```

```json

{

"state": "Error",

"errorText": "The data of the import file is in an unexpected format.",

"errorDetails": "No header record was found.\r\nIReader state:\r\n ColumnCount: 0\r\n CurrentIndex: -1\r\n HeaderRecord:\r\n\r\nIParser state:\r\n ByteCount: 0\r\n CharCount: 26\r\n Row: 5\r\n RawRow: 5\r\n Count: 0\r\n RawRecord:\r\n\r\n"

}

```

or

```text

Content-Type: application/json

```

```json

{

"state": "Error",

"errorText": "No data could be identified for import. Please check the file and the import template"

}

```

###### Examlpe 2 (with jobName)

Request

```text

POST /api/gw/optimizations/import/template/be1a5f21-8151-4ef0-96fe-c73491551a34/productionAssist?jobName=New%20job

api-version: 2021-08-10

Accept-Language: en-US

Content-Type: multipart/form-data; boundary=--some-boundary

Authorization: Basic NjU1MDFEMDktMkJCOS00M0MyLUI5RDMtMUZCMDAwNkE3NjlFOnNkMDlzaGR1Z985OGffc2ZkZ3pz32Y5ZGhzYWZkaHNmZN92ODlwYmZkOXZiaGFmZGd2

tracestate: someinternaltracedata

```

For content and response see above (Example 1).

##### productionManager interface: PMImport (Example)

Request

IDImportViaTemplateAsyncTest.cs

/Samples/csharp/HomagGroup.ApiGateway.Client.Samples/IDImportViaTemplateAsyncTest.cs

View

IDSendToPAAsyncTest.cs

/Samples/csharp/HomagGroup.ApiGateway.Client.Samples/IDSendToPAAsyncTest.cs

View

TestBase.cs

/Samples/csharp/HomagGroup.ApiGateway.Client.Samples/TestBase.cs

View



	Client/HomagGroup.DigitalFactory.ApiGateway.Client
	Interfaces
	IOptimizationServices.cs
	Services
	OptimizationServices.cs
	Documentation
	README.md
	Samples/csharp/HomagGroup.ApiGateway.Client.Samples
	IDImportViaTemplateAsyncTest.cs
	IDSendToPAAsyncTest.cs +
	TestBase.cs