Versions Compared

Old Version 5

changes.mady.by.user Sean Crowe

Saved on

compared with

New Version Current

changes.mady.by.user Sean Crowe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Asset names are changed to random GUIDs with a ".asset" extension during packaging.

  • The document.xml is modified to use the new GUID.

  • The id property matches the externalID property in the modified document.xml. This ID should be relied on to be the same after import.

  • The oldID is the original Asset file ID in the BackOffice.

  • The file property indicates where the asset will be uploaded in the BackOffice if no other value is provided during import. This value is hardcoded to be Imported\{document name}\{file name}

...

  • BackOffice

  • Adobe® plugin or extensions

  • DocumentCreateFromChiliPackage API - POST /rest-api/v1.2/resources/documents/frompackage

When uploading a package, you can define the folder location for uploaded Assets or Fonts.

Expand
titleAPI Upload

In the API call, use the query properties:

  • newAssetLocation

  • newFontLocation

For example:

http://cp-xyz-123.chili-publish-sandbox.online/rest-api/v1/resources/documents/frompackage?documentName=example&folderPath=temp&newAssetLocation=importAssets&newFontLocation=importFonts

If you don't define a location, default locations will be used as defined in the fonts.xml and the assets.xml files.

  • Fonts: General\FromInDesign\{file name}

  • Assets: Imported\{document name}\{file name}

Infonote

NoteImportant: If the default path contains a file with the same name, the new file from the package will not be uploadedbe added. Instead, the document XML will be modified during import to utilize the file already in the BackOffice.

If the file name is unique, the new file from the package will be added to the BackOffice with a new ID and the document XML will be modified during import to utilize the new ID.

Best Practices

Font Management

...

  • Change the font location to the same staic static folder path when importing packages.

...

  • Prevents duplicate fonts

  • Saves storage space

  • Ensures use of verified, working fonts - as it is possible for someone to upload a corrupt font or for the font to become corrupt during unzipping

This approach assumes that font names are consistent amongst users, which is what we also find in looking at usage. However, in systems that utilize a lot of different fonts and designers without strict font requirements, you will still have a small percentage of duplicate fonts due to the font file names being different.

Asset Management

It's strongly recommended to:

...

This approach prevents accidental overriding ignoring of unique assets with that happen to share the same name that are supposed to be uniquefile name. For example, someone uses an image called “headshot.png” and when they import the package, there may already be another “headshot.png” from a completely different designer. Clearly, you want both copies, and you don’t want to replace the package file with the already existing file. Thus, it is prudent to use unique folder pasts with assets.

However, please create a cleanup strategy to clean up old unused assets.