Learning Center

Exchange / Apply suggestions ​

Task in alpha phase

This Data Factory task is in phase. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

This task enables to apply all suggestions on a list of items, and optionally to mark them as read.

Task name:

Examples ​

json
{
    "name": "exchange-apply-suggestions",
    "taskReferenceName": "exchange-apply-suggestions",
    "description": "Apply all suggestions based on items file",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "items" : "${export_items.output.file}",
        "extraFilters": [
            {
                "type": "eq",
                "field": "isAcknowledged",
                "value": false
            }
        ]
    }
}
json
{
    "name": "exchange-apply-suggestions",
    "taskReferenceName": "exchange-apply-suggestions",
    "description": "Apply all suggestions based on items file",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "items" : "${export_items.output.file}",
        "extraFilters": [
            {
                "type": "eq",
                "field": "isAcknowledged",
                "value": false
            }
        ],
        "screens": [
            "ALL_ATTRIBUTES",
            "MEDIA"
        ]
    }
}
json
{
    "name": "exchange-apply-suggestions",
    "taskReferenceName": "exchange-apply-suggestions",
    "description": "Apply all suggestions based on items file using options",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "items" : "${export_items.output.file}",
        "isAcknowledged": "NO-CHANGES"
    }
}
json
{
    "name": "exchange-apply-suggestions",
    "taskReferenceName": "exchange-apply-suggestions",
    "description": "Apply all suggestions based on items file using options",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "items" : "${export_items.output.file}",
        "extraFilters": [
            {
                "type": "eq",
                "field": "isAcknowledged",
                "value": false
            },
            {
                "type": "eq",
                "field": "hasCreatedItem",
                "value": true
            }
        ],
        "hasCreatedItem": "NO"
    }
}
json
{
    "name": "exchange-apply-suggestions",
    "taskReferenceName": "exchange-apply-suggestions",
    "description": "Apply all suggestions based on items file for specific fields",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "items" : "${export_items.output.file}",
        "extraFilters": [
            {
                "type": "eq",
                "field": "isAcknowledged",
                "value": false
            },
            {
                "type": "eq",
                "field": "hasCreatedItem",
                "value": true
            }
        ],
        "fields": "file://assets/fields.xml"
    }
}
json
{
    "name": "exchange-apply-suggestions",
    "taskReferenceName": "exchange-apply-suggestions",
    "description": "Apply all suggestions based on items file using options",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "items" : "${export_items.output.file}"
    }
}

Definition ​

PropertyTypeRequiredDescription
The name (or type) of the task
The unique name of the task in your job. It is used to reference this task in the workflow.
The functional description of this task in your job.
The type of the task. It must be SUB_WORKFLOW.
true: the job continues if there is an error on this task.
false: the job fails.
Input parameters of the task. See below

Input Parameters ​

PropertyTypeRequiredDescription
An export items file (see details here : table-export-items)
Defines the acknowledgement status to apply to the suggestions.
YES : All suggestions are set to acknowledged (default value).
NO : All suggestions are set to not acknowledged.
NO_CHANGES : No changes are made to acknowledgement status.
YES_IF_EMPTY : Suggestion is set at aknowledged only if all the suggested fields in suggestion are applied. Requires the fields input.

You can apply only certain fields when applying the suggestion.
If you don't specify, all fields will be applied.
Default : api.product-live.com
Definition of the screens on which the suggestions must be applied.
If not specified, all screens will be taken into account.
Definition of the extra filters thant must be applied when defining suggestions to take into account (see details here : find-request)

Input items ​

See details on the input items in the Data Factory task table-export-items output - file.

Input fields example ​

xml
<Fields>
    <Field key="TITLE"/>
    <Field key="MAIN-IMAGE"/>
</Fields>

Input options definition ​

XPathDescriptionOccurs
FieldsThe root element1
Fields/FieldDefines the behavior for a single field1..*
Fields/Field/@keyThe field key1..1

Outputs ​

PropertyDescription
reportAn XML a report of managed suggestions

Output report example ​

xml
<Report task="exchange-apply-suggestions">
    <Log type="info" code="SUGGESTION_APPLIED">
      <Metadata name="suggestionCreationDate">2024-08-21T09:55:18.000Z</Metadata>
      <Metadata name="acknowledged">true</Metadata>
      <Metadata key="newItem">true</Metadata>
      <Metadata-Collection name="identifiers">
         <Metadata name="EAN">3221616129726</Metadata>
      </Metadata-Collection>
      <Metadata-Collection name="modifications">
         <Metadata key="MULTI-SELECT-QUANTIFIE" deleted="true"/>
         <Metadata key="NUMBER">
            <Old-Value>2</Old-Value>
            <New-Value>3</New-Value>
         </Metadata>
         <Metadata key="NUMBER-WITH-SUFFIX">
            <Old-Value suffix="cm">2</Old-Value>
            <New-Value suffix="mm">3</New-Value>
         </Metadata>
         <Metadata key="CONNECTORS">
            <Added key="USB">
                <Quantity new="2"/>
                <Comment new="1 USB-2, 1 USB-3"/>
            </Added>
            <Added key="HDMI">
                <Quantity old="2" new="3"/>
                <Comment new="2 HDMI-2.0, 1 HDMI 3.0"/>
            </Added>
         </Metadata>
      </Metadata-Collection>
      <Message>The suggestion has been treated</Message>
   </Log>
</Report>

Output report definition ​

XPathDescriptionOccurs
ReportThe root of the document1..1
Report/@taskThe name of the task (always exchange-apply-suggestions)1..1
Report/LogFor each item for which data has been modified0..*
../@typeThe type of the log (can be info, error)1..1
../@codeThe code of the log (can be SUGGESTION_APPLIED, ERROR)1..1
../Metadata[@key='suggestionCreationDate']The date of the processing1..1
../Metadata[@key='acknowledged']true if the suggestion has been acknowledged, false otherwise1..1
../Metadata[@key='newItem']true if the suggestion has created an item (blue envelope acknoledgement), false otherwise (yellow envelope)1..1
../Metadata-Collection[@key='identifiers']Identifiers of the item1..1
../Metadata-Collection[@key='modifications']All the modifications applied to the product during the suggestion acknowledgement0..1
../Metadata-Collection[@key='modifications']/MetadataA field impacted by the suggestion acknowledgement1..1
../Metadata-Collection[@key='modifications']/Metadata/@keyThe field key1..1
../Metadata-Collection[@key='modifications']/Metadata/@deletetrue if the suggestion aknowledgement has deleted the field value1..1
../Metadata-Collection[@key='modifications']/Metadata/Old-ValueThe previous value of the field (if applicable)0..1
../Metadata-Collection[@key='modifications']/Metadata/Old-Value/@suffixThe previous suffix of the field (if applicable)0..1
../Metadata-Collection[@key='modifications']/Metadata/New-Value/@suffixThe new suffix of the field (if applicable)0..1
../Metadata-Collection[@key='modifications']/Metadata/AddedIn the case of multivalued fields, lists the added values0..1
../Metadata-Collection[@key='modifications']/Metadata/ModifiedIn the case of multivalued fields, lists the added values0..1
../Metadata-Collection[@key='modifications']/Metadata/DeletedIn the case of multivalued fields, lists the added values0..1
../Metadata-Collection[@key='modifications']/Metadata/*[Added,Modified,Deleted]/@keyThe option key1..1
../Metadata-Collection[@key='modifications']/Metadata/*[Added,Modified,Deleted]/CommentIn the case of multivalued fields with comment, describes the modifications applied to comment0..1
../Metadata-Collection[@key='modifications']/Metadata/*[Added,Modified,Deleted]/QuantityIn the case of multivalued fields with quantity, describes the modifications applied to quantity0..1
../MessageThe log message1..1

Limits ​

  • Only items files exported with the task Table export items can be used as an input of this task (items IDs are required to process to the suggestions application).
  • Only 100 items can be processed at a time.