Document

Document Overview

The Document object type is more than a simple file stored on the web server. It is a "logical container" that holds the "components" of your document. And it enables the document to be described, published and gernerally "controlled".

Your web service may have a need to present or manage Documents, which may be in different formats, such as PDF, Word, Powerpoint, Excel etc. In fact some documents may even have multiple components! The Document Object type has been built to enable this, complete all of the regular / common functions that a Document can be expected to provide.

The Document object type inherits the "Product" object, making it available for e-commerce and stock control.

Document Properties

• ISBN - Text Property. This simple property allows the user to give the Document an ISBN Reference. ISBN is the acronym for International Standard Book Number. This 13-digit number identifies a specific book, an edition of a book, or a book-like product (such as an audiobook). This field has no checking built into it.
• Ref - Text Property. This simple property allows the user to give the Document a Reference. Often used for internal purposes, this field has no checking built into it.
• Abstract - Text Property. Abstracts are short summaries to explain the document to a User before they read the entire document. Often this is provided at the beginning of a Technical Report. In the case of the Document Object, we provide it as a Property, so that it can added to the document independanlty of the Document Component/s and searched etc. without needing to open the document.
• Keywords - Text Property. Keywords are discrete words used as tags for the document, They are a further method of classifying the document for rapid searching / cross referencing.
• PhysicalDocument - File Property. The documents file.

Subtables:

• Components - View the Subtable Here

Inherited Properties from Product:

• ProductCode - Text Property. You can give your product a short code to show in Checkout and Invoices.
• FullDescription - Text Property. The description of the document that is rendered on product pages.
• Downloadable - Boolean Property. Is this a downloadable product?
• BarCode - Text Property. The barcode for the Product.
• BarCodeType - Constant Set Property. What type of barcode do you use?
  • NA
  • EAN8
  • EAN13
• TotalPurchased - Number Property. The total number of times the Product has been purchased in orders.
• PriceExVat - Number Property. The price before VAT is applied.
• COGSPrice - Number Property. Cost Of Goods Sold. The direct costs attributable to the production of the goods/product. This includes the cost of the materials and labour directly used to create the product.
• MaxPerAccount - Number Property. If you want to limit the amount a customer can purchase at a time, set this number to 1 or more.
• DefaultQty - Number Property. If you want to automatically set the amount added to a basket, set this number to 1 or more.
• QtyIsStatic - Boolean Property. If you don't want the customer to change the quantity being purchased, set this to ticked/true.
• MaximumStockLevel - Number Property. The stock level that the product we be marked as "out of stock".
• TargetStockLevel - Number Property.
• StockInEscrow - Number Property. The number of products assigned to baskets that are incomplete (not deducted from total stock). This is not editable.
• TotalStock - Number Property. Total number of products available to purchase. This is not editable.
• StockControlMethod - Constant Set Property. How should the stock be managed?
  • None
  • Simple
  • Variant Based
  • ElectronicItem
  • InHouse Production
• Length - Number Property. Used to work out Shipping.
• Weight - Number Property. Used to work out Shipping.
• Depth - Number Property. Used to work out Shipping.
• TaxClassId - Tax Class Table Property.
• VATRateId - VAT Rate Table Property.
• OnPurchaseXFlow - GUID Property. When a Product is purchased, the selected XFlow is fired.

Inherited Subtables from Product:

• Price Breaks - View the Subtable Here
• Variant Values - View the Subtable Here
• Variants Stock - View the Subtable Here
• Variants - View the Subtable Here
• Waiting List - View the Subtable Here

Document Interface

Document Associations

• Documents -
  • Author(s). The Author of the Document. Note that the components also have UploadeBy recorded. This Association Type allows the listing of documents that the Contact has Authored. Allowed Types - Contact, Group.
  • Co Author(s). Any Co-Authors of the Document. This Association Type allows the listing of of documents that the Contact has Co-Authored. Allowed Types - Contact.
  • Referenced Documents. The Document may specifically reference other documents. This association type will allow the document to either be referenced and or be connected to other documents as reference. Allowed Types - Document.
  • Watermark. When viewed in a Document Viewer, these watermarks will be added. Allowed Types - Document Watermark.
• System -
  • Contained By. The Document can be located inside a Folder and categorised in a Category. Allowed Types - Category, Document, Folder.
  • Contains. The Document can contain other Documents and CDs. Allowed Types - Document.

Inherited Associations from Product:

• Ecommerce -
  • Companion Product. These Objects will be added, along with this Product, to a basket when this Product is added to a basket. Allowed Types - Product.
  • Main Product. This Product will be added to a basket when any of these Products are added to a basket. Allowed Types - Product.
  • Discounted Products. Discount vouchers which apply to this product. Allowed Types - Discount Voucher.
  • Offers. Offers which apply to this product. Allowed Types - Offer
  • Order Products. Orders which apply to this product. Allowed Types - Order.
  • Product Images and Videos. Images and videos shown in the Product Listing Atom for the Product. Allowed Types - Image, YouTube Video.
• System -
  • Contained By. Where can you place a Product? Allowed Types - Folder, Order, Product Category.
  • Contains. What can be "inside" a Product. Allowed Types - Contact, Offer, Image, YouTube Video.