Merge pull request #126145 from MalcolmTyrrell/conversionResultFile

Section on the result file.

Author: ttorble

articles/remote-rendering/how-tos/conversion/get-information.md

@@ -1,15 +1,38 @@
 ---
-title: Get information about a converted model
-description: Description of all model conversion parameters
+title: Get information about conversions
+description: Get information about conversions
 author: malcolmtyrrell
 ms.author: matyrr
 ms.date: 03/05/2020
 ms.topic: how-to
 ---
 
-# Get information about a converted model
+# Get information about conversions
 
-The arrAsset file produced by the conversion service is solely intended for consumption by the rendering service. There may be times, however, when you want to access information about a model without starting a rendering session. Therefore, the conversion service places a JSON file beside the arrAsset file in the output container. For example, if a file `buggy.gltf` is converted, the output container will contain a file called `buggy.info.json` beside the converted asset `buggy.arrAsset`. It contains information about the source model, the converted model, and about the conversion itself.
+## Information about a conversion: The result file
+
+When the conversion service converts an asset, it writes a summary of any issues into a "result file". 
+For example, if a file `buggy.gltf` is converted, the output container will contain a file called `buggy.result.json`.
+
+The result file lists any errors and warnings that occurred during the conversion and gives a result summary, which is one of `succeeded`, `failed` or `succeeded with warnings`.
+The result file is structured as a JSON array of objects, each of which has a string property that is one of `warning`, `error`, `internal warning`, `internal error`, and `result`. 
+There will be at most one error (either `error` or `internal error`) and there will always be one `result`.
+
+## Example *result* file
+
+The following example describes a conversion that successfully generated an arrAsset. 
+However, since there was a missing texture, the resulting arrAsset may not be as intended.
+
+```JSON
+[
+  {"warning":"4004","title":"Missing texture","details":{"texture":"buggy_baseColor.png","material":"buggy_col"}},
+  {"result":"succeeded with warnings"}
+]
+```
+
+## Information about a converted model: The info file
+
+The arrAsset file produced by the conversion service is solely intended for consumption by the rendering service. There may be times, however, when you want to access information about a model without starting a rendering session. To support this workflow, the conversion service places a JSON file beside the arrAsset file in the output container. For example, if a file `buggy.gltf` is converted, the output container will contain a file called `buggy.info.json` beside the converted asset `buggy.arrAsset`. It contains information about the source model, the converted model, and about the conversion itself.
 
 ## Example *info* file
 
@@ -120,6 +143,12 @@ This section records information calculated from the converted asset.
 * `recenteringOffset`: When the `recenterToOrigin` option in the [ConversionSettings](configure-model-conversion.md) is enabled, this value is the translation that would move the converted model back to its original position.
 * `boundingBox`: The bounds of the model.
 
+## Deprecated features
+
+The conversion service writes the files `stdout.txt` and `stderr.txt` to the output container, and these had been the only source of warnings and errors.
+These files are now deprecated. Instead, please use
+[result files](#information-about-a-conversion-the-result-file) for this purpose.
+
 ## Next steps
 
 * [Model conversion](model-conversion.md)

articles/remote-rendering/how-tos/conversion/toc.yml

@@ -8,5 +8,5 @@
   href: configure-model-conversion.md
 - name: Override materials during model conversion
   href: override-materials.md
-- name: Get information about a converted model
+- name: Get information about conversions
   href: get-information.md