Back to Website
Show / Hide Table of Contents

Documents

  • Last updated on January 15, 2025
  • •
  • 1 minute to read

You can store any files as Documents, including images, designs, mockups, archives, etc. However, this section primarily serves for working with such files as .json, .xml, .pdf, and .tgset.

Documents

Document types

There are currently four supported types of documents:

  • Config file: Files with a .json or .xml extension
  • Dielines: Files with a .pdf extension
  • Toggle set: Files with a .tgset extension
  • General: All other file extensions

In addition to the type, each document also has a format — for example, a Config file can have either XML or JSON format, while Toggle set supports only one format, JSON. Dielines are stored in the PDF format. General documents use the BINARY format.

Uploading documents

To add documents to your account:

  1. Navigate the Assets section and select Documents.
  2. Upload files either by clicking New > Import or just dragging and dropping them from your computer.

Importing documents

The document type is identified automatically during import based on the extension. Changing the document type after upload is not currently possible.

You may use folders to keep your files organized. For example, create subfolders for different document types.

Creating documents

In the Customer's Canvas account, you can manually create and edit Toggle set and Config file documents. The Dielines documents can automatically be created when generating designs from .m3d mockup files. Other types can only be imported.

To create a new Config or Toggle set file:

  1. Click New.

  2. Select Config file or Toggle set.

  3. Enter the filename and click Save.

    Creating documents

After saving, the JSON editor will open, allowing you to populate your file with content.

Connecting documents to PIM products

You can link any document to a PIM product. During personalization, these documents can be retrieved through the API and processed in a special way.

To connect a document to a PIM product:

  1. In your Customer's Canvas account, navigate to Products and click a product in the list.

  2. In the product settings, click the Documents tab, select relevant options, and click Save.

    Select relevant options

  3. Go back to the product list, click ellipsis in the product row, and click Asset connections.

    Browsing the product list

  4. When a new window opens, switch to the Documents tab and add the necessary documents using the Add file button.

    Adding the necessary documents

  5. Set the link to the appropriate option for the added document in one of three ways.

    Linking the options

For detailed instructions on asset connections, refer to the Connecting assets to products topic.

Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2024 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback