{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"The Output Kind Image allows you to output images from Perfion.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"22c73b6e-a773-4bee-bd51-ce1a534854d6"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":3,"background":"#a6a6a6","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Image","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"What can be output","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Supports","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Supported Entities","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"a Features (Only of type Image)","type":"text"}]},{"type":"paragraph","content":[{"text":"r Attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"r Literals","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"a Multi value features","type":"text"}]},{"type":"paragraph","content":[{"text":"a Localizable features","type":"text"}]},{"type":"paragraph","content":[{"text":"a Output Kind Parameters","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"a Site","type":"text"}]},{"type":"paragraph","content":[{"text":"a Category","type":"text"}]},{"type":"paragraph","content":[{"text":"a Product","type":"text"}]},{"type":"paragraph","content":[{"text":"a Variant","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":3,"background":"#d9d9d9","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Sample Mappings","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":3,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":81.0},"content":[{"type":"media","attrs":{"width":525,"id":"3d0a52de-1ca4-4dbb-b206-d30262c5914f","collection":"contentId-244331647","type":"file","height":66}}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":3,"background":"#d9d9d9","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Sample output","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":3,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n …\n \n \n a10a14e0-7f66-4d87-8adc-a4b0e10ecf11\n 983ST_(1000x1000).png\n … Some url … \n \n \n a2edafa9-7f24-4dd5-a867-0a657cb58b1c\n Coffee Accessories.jpg\n … Some url … \n Extra-983ST.jpg\n \n \n 149a9969-57be-48cc-ab0a-ba86641e166c\n st364-978--mm-550.jpg\n … Some url … \n … Base64 encoded bytes … \n image/jpeg\n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Table 1: Summary of output kind Image.","type":"text"}]},{"type":"paragraph","content":[{"text":"Images have more data associated with them as can be seen from the Image-element output. Each image-element gives you the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Just as fields, images have a ","type":"text"},{"text":"name","type":"text","marks":[{"type":"strong"}]},{"text":" (The value of ECommerce To in the mapping)","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"As opposed to fields, it is allowed to map ","type":"text"},{"text":"multiple features to the same ECommerceTo ","type":"text","marks":[{"type":"em"}]},{"text":"for Output Kind Image. In case you want to distinguish which images comes from which feature the ","type":"text"},{"text":"perfionname","type":"text","marks":[{"type":"strong"}]},{"text":"-attribute in the output holds the feature name of the mapping.","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Images in Perfion have a ","type":"text"},{"text":"Guid","type":"text","marks":[{"type":"strong"}]},{"text":". That is output as a child-element of the Image-element.","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Whenever an image is uploaded or imported into Perfion, Perfion stores its original file name. This filename is output in the ","type":"text"},{"text":"OriginalFileName","type":"text","marks":[{"type":"strong"}]},{"text":"-element. Note that this filename is not necessarily unique. For selectable Image features, it is indeed highly likely that multiple products share the same image.","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In settings (See chapter ","type":"text"},{"text":"Settings in Ecommerce API","type":"text","marks":[{"type":"link","attrs":{"href":"https://perfion.atlassian.net/wiki/spaces/PIM/pages/244331086/Ecommerce+API#Settings-in-ECommerce-API"}}]},{"text":") you can tell EC the Url to a Perfion Image Server. When this is setup EC will output the Url to the Image in the ","type":"text"},{"text":"Url","type":"text","marks":[{"type":"strong"}]},{"text":"-element.","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"ConstructedFileName","type":"text","marks":[{"type":"strong"}]},{"text":"-element is only output if you supply ","type":"text"},{"text":"File","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" as a parameter to the Image Output Kind. This is done be simply writing “Image(File)” instead of just “Image” as output kind. In addition to ‘File’ you could and should add a second parameter telling EC, how you want the filename to be constructed. This is done by adding a small ","type":"text"},{"text":"filename-template","type":"text","marks":[{"type":"strong"}]},{"text":" where all variable parts are written between two curly brackets, i.e. { and }. Anything not in curly brackets will simply by copied as is to the ConstructedFileName-element. Between the { and } you can write any of the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Guid","type":"text","marks":[{"type":"strong"}]},{"text":" – Which will output the Guid for the image","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OriginalFileName","type":"text","marks":[{"type":"strong"}]},{"text":" – Which will output the OriginalFileName.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Finally, ","type":"text"},{"text":"any field-name ","type":"text","marks":[{"type":"strong"}]},{"text":"a Field-mapping for that entity (in this case a Product) can be output. In the example above, it was the field ","type":"text"},{"text":"Item No","type":"text","marks":[{"type":"em"}]},{"text":" that was used. ","type":"text"},{"text":"Item No","type":"text","marks":[{"type":"em"}]},{"text":" is a good choice to at least have in there to ensure uniqueness. Guid can be used for the same, but ","type":"text"},{"text":"Item No","type":"text","marks":[{"type":"em"}]},{"text":" reads better.","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"The example Output Kind Image(File, ‘Extra-{Item No}’) will construct file names so that they all begin with “Extra-“ and having the Item No added. Note that ECommerceOutputKind is a selectable, so you need to add a new item to it in order to specify a filename-template.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"NOTE:","type":"text","marks":[{"type":"strong"}]},{"text":" If no second parameter, a filename-template, is supplied the constructed file name is simply the Guid.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In settings, (see chapter ","type":"text"},{"text":"Settings in Ecommerce API","type":"text","marks":[{"type":"link","attrs":{"href":"https://perfion.atlassian.net/wiki/spaces/PIM/pages/244331086/Ecommerce+API#Settings-in-ECommerce-API"}}]},{"text":") you can define an OutputFolder. When done all Images output as files will be copied to that folder (in a substructure) given them their constructed file names. It is therefore important, that you ensure uniqueness of these filenames as done above using ","type":"text"},{"text":"Item No","type":"text","marks":[{"type":"em"}]},{"text":" as part of it. Note that setting this to blank will instruct the ECommercy Api to not store the images, but still output the ConstructedFileName-element. This is useful if you need a unique filename to pass on to the receiving system. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"NOTE:","type":"text","marks":[{"type":"strong"}]},{"text":" No files are output when running requests from the API Tool Windows.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you instead pass ","type":"text"},{"text":"Embedded","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" as parameter to the Output Kind images, EC will add a base64-encoded byte-representation of the images in a ","type":"text"},{"text":"Bytes","type":"text","marks":[{"type":"strong"}]},{"text":"-element. Note that using this easily creates huge Xml-documents and hereby possible a performance degradation. To avoid too big results please utilize paging or filtering ensuring that not too many products are fetched simultaneously. See section ","type":"text"},{"text":"GetProducts","type":"text","marks":[{"type":"link","attrs":{"href":"https://perfion.atlassian.net/wiki/spaces/PIM/pages/244331086/Ecommerce+API#GetProducts"}}]},{"text":" for available options on how to avoid huge result set. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"In Perfion v. 4.5.36 and later you will in addition get the Mime type of the returned image. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"NOTE:","type":"text","marks":[{"type":"strong"}]},{"text":" This Mime type depends on the format-parameter and not on the file type of the original file. Default the EC API will always return jpg-images (i.e. Mime type “image/jpeg”). See more on specifying the wanted image format in section ","type":"text"},{"text":"ImageServiceUrlParameters-setting","type":"text","marks":[{"type":"link","attrs":{"href":"https://perfion.atlassian.net/wiki/spaces/PIM/pages/244331086/Ecommerce+API#ImageServiceUrlParameters-setting"}}]},{"text":".","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"NOTE:","type":"text","marks":[{"type":"strong"}]},{"text":" The Url is reckoned as the default Output Kind parameter (“Image(Url)” and “Image” are hereby equivalent). This means that per default images will be output ","type":"text"},{"text":"without","type":"text","marks":[{"type":"em"}]},{"text":" constructed file names and without their bytes-representation.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"You can, of course, create multiple Image-mappings on the same entity. Furthermore it is allowed to map different features to the same “To”-name in multiple mappings. This allows you to gather images from various features and have them all output by EC in the same “list”. This ","type":"text"},{"text":"is not","type":"text","marks":[{"type":"em"}]},{"text":" done in the mappings in Table 7, where each feature is mapped to a separate name. Mapping multiple features to the same name still allows you to distinguish the images, since the perfionname-attribute is always present and holds the name of the originating feature. ","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9d37461e-07c2-494b-8508-db4a6d831fa7"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"e7ee1083-6e69-4609-8855-3ba87d0c2c07"}}]}]}],"version":1}

Browser not supported