AddressBookItemField

One of the address book item properties listed below.

Internal identifier of the address book item.

(see pages below)

AddressBookItemProperty

Name of the address book item field.

Internal identifier of the address book item.

Value of the address book item field

AssetField

Field name of an asset metadata field

Internal identifier of the digital asset

Value of the metadata field

AssetProperty

One of the Asset properties listed below

Internal identifier of the digital asset

(see pages below)

DataListColumnMapping

The name of the project variable.

Internal identifier of the document

The value of the data list field.

DataMergeField

Field name of a Data List Acquisition field

Internal identifier of the document

The value of that field from the Data List Acquisition page

DocumentProperty

One of the Document properties listed below

Internal identifier of the document

(see pages below)

ModuleField

A key that your module uses to identify this value

Unique Name of the Extension module

The value that your module wishes to save

OrderField

Field name of the Checkout field

Internal identifier of the order

The value of that shipping or payment option field

OrderProperty

One of the Order properties listed below

Internal identifier of the order

(see pages below)

PaymentProperty

One of the Payment properties listed below

Internal identifier of the payment

(see pages below)

PrintingField

Field name of a Printing Options field.

Internal identifier of the document

The value of that printing option field

ProductField

Field name of a product metadata field

Internal product identifier

Value of the metadatafield

ProductProperty

One of the Product Properties listed below

Internal product identifier

(see pages below)

ShipmentField

The field name of a Shipping field.

Internal identifier of the shipment.

The value of that shipping field for that shipment.

ShipmentProperty

One of the Shipment properties listed below.

Internal identifier of the shipment (see the Order Property “Shipments”)

(see pages below)

SystemField

Field name of the system data

null

The value of that GlobalData table entry

SystemProperty

One of the System properties listed below

null

(see pages below)

TaskProperty

One of the Task properties listed below

Internal identifier of the task.

(see pages below)

UserField

The field name (not the display name) of a User Profile field.

Internal identifier of the user.

The value of that user profile field

UserProperty

One of the User properties listed below

Internal identifier of the user.

(see pages below)

VariableValue

Field name of a Form Filling field.

Internal identifier of the document

The value of that field from the Form Filling step

UserListProperty

a user property returned as a list of items (e.g. items in shopping cart)

OrderListProperty

an order property returned as a list

SystemListProperty

a system property returned as a list

ShipmentListProperty

a shipment property returned as a list.

ShippingAddress1

Replace first line of shipping address

Since 7.6

ShippingAddress2

second line of shipping address

Since 7.6

ShippingCity

shipping city

Since 7.6

ShippingCountry

shipping country

Since 7.6

ShippingFirstName

first name for shipping address

Since 7.6

ShippingLastName

last name for shipping address

Since 7.6

ShippingPostalCode

postal code of shipping address

Since 7.6

ShippingState

Shipping state or province

Since 7.6

UploadPdfDocumentChoice

asset id of uploaded PDF document used for a User Upload PDF product

Since 3.0

PaymentAddress1

first line of billing address

Since 2.5

PaymentAddress2

second line of billing address

Since 2.5

PaymentCity

billing city

Since 2.5

PaymentCountry

billing country

Since 2.5

PaymentCreditCardExpirationMonth

expiration on the credit card

Since 2.5

PaymentCreditCardExpirationYear

expiration year of credit card

Since 2.5

PaymentCreditCardNameAsItAppearsOnCard

name as it appears on credit card

Since 2.5

PaymentCreditCardNumber

credit card number

Since 2.5

PaymentCreditCardSecurityCode

credit card security code

Since 2.5

PaymentCreditCardType

type of credit card used

Since 2.5

PaymentFirstName

first name for billing address

Since 2.5

PaymentLastName

last name for billing address

Since 2.5

PaymentMethodOfPayment

payment method (e.g. credit card or purchase order number)

Since 2.5

PaymentPostalCode

postal code of billing address

Since 2.5

PaymentPurchaseOrderNumber

purchase order number

Since 2.5

PaymentState

billing state or province

Since 2.5

PaymentAddress1

first line of billing address

Since 9.1

PaymentAddress2

second line of billing address

Since 9.1

PaymentCity

billing city

Since 9.1

PaymentCountry

billing country

Since 9.1

PaymentCreditCardExpirationMonth

expiration month on credit card

Since 9.1

PaymentCreditCardExpirationYear

expiration year on credit card

Since 9.1

PaymentCreditCardNameAsItAppearsOnCard

name as it appears on credit card

Since 9.1

PaymentCreditCardNumber

credit card number

Since 9.1

PaymentCreditCardSecurityCode

credit card security code

Since 9.1

PaymentCreditCardType

type of credit card used

Since 9.1

PaymentFirstName

first name for billing address

Since 9.1

PaymentLastName

last name for billing address

Since 9.1

PaymentMethodOfPayment

payment method, e.g. credit card or purchase order

Since 9.1

PaymentPostalCode

postal code of billing address

Since 9.1

PaymentPurchaseOrderNumber

purchase order number

Since 9.1

PaymentState

state or province of billing address

Since 9.1

PrintingQuantity

quantity ordered of a particular item

Since 2.5

ShippingAddress1

Replace first line of shipping address

Since 2.5

ShippingAddress2

second line of shipping address

Since 2.5

ShippingCity

shipping city

Since 2.5

ShippingCountry

shipping country

Since 2.5

ShippingDeliveryMethod

delivery option selected for an order (see the Pageflex Storefront Deployer guide for details).

Since 2.5

ShippingFirstName

first name for shipping address

Since 2.5

ShippingLastName

last name for shipping address

Since 2.5

ShippingPostalCode

postal code of shipping address

Since 2.5

ShippingState

Shipping state or province

Since 2.5

UserProfileAccountNumber

the deployer’s account number for this user

Since 2.5

UserProfileAddress1

first line of the user’s address

Since 2.5

UserProfileAddress2

second line of the user’s address

Since 2.5

UserProfileCity

user’s city

Since 2.5

UserProfileCountry

user’s country

Since 2.5

UserProfileEmailAddress

user’s e-mail address

Since 2.5

UserProfileFirstName

user’s first name

Since 2.5

UserProfileLastName

user’s last name

Since 2.5

UserProfilePostalCode

user’s postal code

Since 2.5

UserProfilePricingDiscount

deployer’s pricing discount for this user

Since 2.5

UserProfileState

user’s state or province

Since 2.5

UserProfileTaxExemptStatus

user’s tax-exempt status

Since 2.5

Label

The address book label for the item (read/write).

Since 7.6

OwnerID

The User ID of the owner of the address book containing this item.

Since 7.6

SequenceNumber

The SequenceNumber field of the address book item. The one with sequence number 0 is the default.

Since 7.6

ActualUses

A count of the number of (non-temporary) documents which use the asset (read-only).

Since 3.0

AllowUserToDownload

"1" if the user may download the asset from My Library

Since 2.5

AssetType

Either “image” or “PDF_DOC” or what kind of CSV (read-only)

Since 2.5

CurrencyUnit

The ISO string indicating the currency in which the Price is given. May be null.

Since 3.0

DataAvailable

“1” if the data for the asset is actually present in the Storefront file system (e.g. has been downloaded from an external source)

Since 3.0

Description

The Description of the asset.

Since 2.0

DoShowToUser

“1” if the asset should be made known to the user when viewing MyLibrary

Since 3.0

FileLocation

Location of the asset in the file system (read-only).

Since 2.0

HasBeenPurchased

“1” if the asset has been charged for (so it shouldn't be deleted).

Since 3.0

IsActive

“1” if not archived, “0” if archived

Since 2.0

IsAvailable

“1” if the asset may be assigned to a document (a computation involving the MaxNumberOfUses and the SunsetDateTime) (read-only)

Since 3.0

IsStaged

“1” if the asset is staged.

Since 3.0

MaximumUses

The maximum number of documents allowed to share this asset. May be null (in which case the asset is unrestricted) or “1” for acquired data lists. Other values may be meaningful in a future release of Storefront or of the extensions.

Since 3.0

NumberOfPages

Number of pages in a PDF_DOC asset. May be null, and will be null for other types of asset.

Since 3.0

NumberOfRows

Number of rows in database, or null.

Since 2.5

OwnerID

User ID of the owning user. May be null.

Since 2.0

PixelsPerMeter

Resolution for an IMAGE or PDF_DOC asset.

Since 3.0

Price

Price of the asset, in terms of units of the currency indicated in CurrencyUnit. Must be null if the CurrencyUnit is null.

Since 3.0

ShortName

Short name of asset.

Since 2.5

SizeHeight

Floating point value (converted to a string) indicating the height of an IMAGE or PDF_DOC asset, in points. May be null.

Since 3.0

SizeWidth

Width of an IMAGE or PDF_DOC asset, in points. May be null.

Since 3.0

SunsetDateTime

A string of the form “2005-10-12 15:27:00” indicating the date/time after which the asset may no longer be used. May be null.

Since 3.0

SxiUniqueNameID

The UniqueName of SXI module for this asset (read-only).

Since 3.0

ThumbnailLocation

Location of the asset’s thumbnail file (read-only).

Since 2.0

TimeUploaded

A string of the form “2005-10-12 15:27:00” indicating the date/time the asset was uploaded. May be null. (read-only).

Since 2.5

ApprovalWorkflowName

Allows changing approval workflow to be assigned to a document. r/w until order placed, read only after order is placed.

Since 7.5

CommentForAdmin

The UserVisibleComment field for an ordered document, or null for an unordered one.

Since 2.0

CommentForUser

The AdminVisibleComment field for an ordered document, or null for an unordered one.

Since 2.0

ContainingKitDocument

The document ID of the kit document of which this document is a part. If applied to a non-part document it is an error and returns null.

Since 7.6

DatabaseToMerge_AssetID

The CSV database to be used for data merge.

Since 2.0

DatabaseToReallyUse_AssetID

Asset ID of the data list to be used by Pageflex Server, in preference to DataBaseToMerge_AssetID (which comes from the product). This can be non-null if an administrator has used the Change File feature to replace the database file after ordering.

Since 3.0

Description

The shopping cart Description column for this document.

Since 2.0

DiscountAmount

Amount (currency) to be applied to the document as a discount. Setting this invalidates DiscountPercentage (read/write).

Since 7.6

DiscountPercentage

Percentage to be applied to the document as a discount. Setting this invalidates DiscountAmount (read/write).

Since 7.6

DiscountedPrice

Price of document after the discounts above are applied.

Since 7.6

DocumentPrice (deprecated)

The HTML_Pricing_DocumentPrice for an ordered document (or one about to be ordered).

Since 2.0

EditingStatus

Controls whether a document is in the shopping cart or on hold. Returns the following values:

“Ordered” — an ordered document;

“InCart” — in shopping cart but not ordered yet;

“OnHold” — on hold but not ordered yet;

“TempDoc” — temporary copy of document being ordered.

The status can be changed from “InCart” to “OnHold” and vice-versa if it is in one of these states.

Since 7.0

ExternalID

The External Document identifier of the document.

Since 2.0

ExtraStatus

Extra production information added to document status. Used and set by special-purpose extensions.

Since 8.0

FinalOutputLocation

Location of the final output directory, if output has been generated, otherwise null (read-only).

Since 2.0

HasErrorAtUnknownStep

Indicates an error condition that has not identified the step. “1” indicates an error (read/write).

Since 2.0

HasErrorFromExtensionAPI
(write is deprecated; use SetDocumentExtensionError() instead)

”1” if at least one SXI module has set error text on this document, “0” otherwise.

Since 2.5

HasErrorInDataMerge

“1” indicates an error in this step (read/write).

Since 2.0

HasErrorInFormFilling

“1” indicates an error in this step (read/write).

Since 2.0

HasErrorInFreeEdit

“1” indicates an error in this step (read/write).

Since 2.0

HasErrorInPrintOptions

“1” indicates an error in this step (read/write).

Since 2.5

IsKitDocument

“0” or “1” depending on whether the document is a kit document (its parts are the PartDocuments property).

Since 7.6

IsKitPart

“0” or “1” depending on whether the document is part of a kit document.

Since 7.6

NeedsAttention

“1” if the document should be flagged as needing attention by an administrator.

Since 3.0

NontaxableProductionPrice

Nontaxable portion of production price.

Since 5.1

JobNameOverride

job name to be used by Pageflex Server. May be null.

Since 2.5

OrderGroupID

Internal ID of the order that this document is a part of, or null if not part of an order (read-only).

Since 2.0

OrderStatus (deprecated)

See “Status” below.

Since 2.0

OutputFileIsShared

In the case of uploaded or static PDF products, “1” if the file should be rendered (or linked) from its original location and not copied, “0” if it should be copied to the usual output location where Pageflex Server sends things (read-only).

Since 3.0

OutputJobName (deprecated)

Job name used to generate final output (read-only). May be changed by setting the “JobNameOverride” for the document. This property matches “FinalOutputJobName” unless “JobNameOverride” has been set.

Since 2.0

OwnerID

User ID of the owning user. Should not be used to transfer the ownership of a document, so for this purpose, it is read-only.

Since 2.0

PaymentForDataListIsAssociatedWithThisItem

“1” if a data list is used in this document and should be included in the document’s total price

Since 3.0

PerDocumentPriceTable

Name of the per-document price table actually selected for this document (for uploaded PDF documents, the result of a Price Table Selection Rule). (read-only)

Since 3.0

PerLeafPriceTable

Name of the per-leaf price table actually selected for this document (the result of a Price Table Selection Rule). (read-only)

Since 3.0

Price

Price actually charged for document. This will match RawPrice, below (read/write).

Since 2.5

ProductDataListSource

Name of data source for the data asset used in this document. (read-only)

Since 3.0

ProductDataListSxiModule

Unique ID of the SXI module which provides the data list for this document (read-only).

Since 3.0

ProductID

Internal product identifier of this document’s product

Since 5.1

ProductName

The Display Name of the product for this document (read-only).

Since 2.0

ProductionPrice

Portion of price associated with production (i.e. not data cost) (read-only).

Since 5.1

ProjectFileLocation

Location of the project file (read-only).

Since 2.0

RawPrice

Price of document before the discounts are applied.

Since 7.6

RequiresShippingStep

1 = if this document is part of an order then the Shipping step is not optional

Since 5.1

ReviewersComment

Approve/decline comment for document (read-only).

Since 2.0

ShipmentID

Returns the Shipment ID of the shipment to which the document is assigned, or null if the document has not yet been ordered (read-only).

Since 7.6

Status

The status of a document (replaces OrderStatus). Possible values include null for an unordered document, or “Unreviewed”, “DataPending”, “ManualPrep”, “ReadyToProduce”, “Submitted”, “Rendered”, “Failed”, “Printed”, “Packed”, “Shipped”, or “Rejected” for an Ordered Document. See “Document Status” for details about document statuses.

Since 3.0

TaxableProductionPrice

Taxable portion of production price.

Since 5.1

TemplateFileLocation

Location of the document’s XDT file (read-only).

Since 2.0

ThumbnailLocation

Location of the document thumbnail (read-only).

Since 2.0

Weight

Weight of document.

Since 2.5

ApprovalWorkflowName

Allows a approval workflow to be assigned to an order. This feature is only available via SINI and has no analog in the UI. r/w until order placed, read only after order is placed.

Since 7.5

CollectionToken

String to present to collection module to effect collection of funds. NULL if split payment is invoked for the order in 9.1 or later (see the individual PaymentProperty.SxiModuleForCollection values), or if the payment module does not support collection.

Since 2.5, changes in 9.1

CurrentStepID

The internal identifier of the Current ApprovalStep. Read only, null if not currently pending approval.

Since 7.5

CurrentStepNumber

The number of the Current ApprovalStep. Read only, null if not currently pending approval.

Since 7.5

DateTimePlaced

A string of the form “2005-10-12T15:27:00” indicating the date and time the order was placed by the end user (local time). May be null (read-only).

Since 2.5

CurrencyConversionRate

Conversion rate between user's currency and store currency at the time the order was placed, represented as a decimal string (read-only).

Since 8.0

DiscountAmount

Amount (currency) to be applied to the entire order as a discount. This is on top of any document-level discounts. Setting this invalidates DiscountPercentage (read/write).

Since 7.6

DiscountPercentage

Percentage to be applied to the entire order as a discount. This is on top of any document-level discounts. Setting this invalidates DiscountAmount (read/write).

Since 7.6

DiscountedPrice

Price of entire order after discounts are applied.

Since 7.6

DoNotDisplayToUser

1 = hide this order from user, 0 = display in user’s “My Orders” page.

Since 2.5

DoNotProcessPayment

1 = do not really collect this order (read-only after order placed). This corresponds to the User Access setting “Whose payment step is for demos/testing only?”

Since 2.5

ExternalID

The ExternalGroupID of the order.

Since 2.0

HandlingCharge

Amount for handling, in currency units (read-only after order placed).

Since 2.5

IsDownloadOrder

1 = a “Get-it-now” order, 0 = not a “Get-it-now” order.

Since 9.3

IsoCurrencyCode

ISO code of currency in effect for this order (read-only after order placed).

Since 2.5

OwnerID

User ID of the owning user.

Since 2.0

PayloadIdent

A string associated with the order for tracking purposes. Used and set by special-purpose extensions.

Since 8.0

PaymentStatus

A string whose values are as follows:

AUTH — payment has been authorized.

PEND — payment authorization is still pending.

DECL — payment authorization was declined.

COLL — payment has been collected.

VOID — payment authorization was voided.

NULL—if split payment is invoked for the order in 9.1 or later (see the individual PaymentProperty. SxiModuleForCollection values), or if the payment module does not support collection.

Since 7.6, changes in 9.1

RawPrice

Price of entire order before discounts are applied.

Since 7.6

ReviewerComments

Order comment from reviewer (read-only).

Since 2.5

Status

Production status of the order, derived from the status of the documents in the order; this will be one of “In Process”, “Pending Review”, “Completed”, “Declined”, “Canceled” or “Unknown” (read-only).

Since 2.5

StepCount

The total number of ApprovalSteps for order (read-only).

Since 7.5

Subtotal

Order subtotal, returned as a long, or as a double when returned from GetCurrencyValue().

Since 9.0

SxiModuleForCollection

The unique ID of the SXI module that will collect the amount due for the order. NULL if split payment is invoked for the order in 9.1 (see the individual PaymentProperty.SxiModuleForCollection values), or if the payment module does not support collection. Read-only before 9.0.

Since 2.5, changes in 9.0 and 9.1

TimeSentToPrinter

A date/time formatted according to the (invariant) general date and time format specifier. Used and set by special-purpose extensions.

Since 8.0

UserIsoCurrencyCode

ISO 4217 code of the currency shown to the user at the time the order was placed (read-only).

Since 8.0

Weight

Total weight of order in weight units; does not include the carton weights; excludes Rejected documents and documents which are download-only (read-only).

Since 2.5

AdditionalLines

The HTML_Pricing_AdditionalLines of the order (deprecated)

Since 2.0

DataListsAreTaxed

1 = data lists are taxable in the tax locale associated to this order (read-only).

Since 5.1

DocumentPrices

The HTML_Pricing_Itemization of the order (deprecated)

Since 2.0

DownloadsAreTaxed

1 = download-only products are taxable in the tax locale associated to this order (read-only)

Since 5.1

HandlingIsTaxed

1 = handling charges are taxable in the tax locale associated to this order (read-only)

Since 5.1

ReviewedBy

Internal identifier of the reviewer, or null (read-only)

Since 2.5

ShippingCharge

Amount for shipping, in units corresponding to IsoCurrencyCode (e.g. 1.23). In 7.5, returns the aggregate of the shipping charges for the various shipments.

Since 2.5

ShippingIsTaxed

1 = shipping charges are taxable in the tax locale associated to this order (read-only)

Since 5.1

Tax

Amount of tax, in currency units (read-only after order placed). In 7.5, returns the aggregate fo the taxes for the various tax locations of the shipments in the order.

Since 2.5

TotalPrice

The HTML_Pricing_Total of the order (deprecated)

Since 2.0

OrderID

The internal ID of the order that this payment belongs to.

Since 9.1

SequenceNo

The number within the order assigned to this payment, starting with 1. Read-only.

Since 9.1

SxiModuleForCollection

UniqueName of SXI module that promises to collect funds for this order.

Since 9.1

ReservedAmount

Amount reserved against this payment. Formatted as a decimal, e.g. “1.50”.

Since 9.1

PaymentType

A code indicating the payment type; typically a 2-letter code for the credit card issuer, or "PO" for purchase order.

Since 9.1

CollectionToken

String to present to collection module to effect collection of funds.

Since 9.1

TransactionID

The TransactionID field from the response to the AuthorizeTransaction event, if any.

Since 9.1

AuthorizationStatus

One of the following strings:

AUTH — payment has been authorized.

PEND — payment authorization is still pending.

DECL — payment authorization was declined.

COLL — payment has been collected.

VOID — payment authorization was voided.

Since 9.1

AllowQuickOrder

“1” if the product can be quick-ordered (skipping customization). Writeable.

Since 9.0

ApprovalWorkflowName

Product’s assigned approval workflow name (read-only before 9.0).

Since 7.5, changes in 9.0

ArchetypeAsset

Asset ID of the document template (for a print product) or PDF file (for a PDF download product)

Since 5.1

AutoSubmit

“1” if the job is automatically submitted for final output when ready for production (writeable)

Since 5.1

BitmapPreviewJobName

Job name of the job used for bitmap previews

Since 5.1

CurrentReleasedVersion

Product identifier of the current released version of this product, or null if there is no released version.

Since 5.1

CurrentStagedVersion

Product identifier of the staged version of this product

Since 5.1

DataListIsForMerge

“1” if the data lists for the product are used as a data source for the final output job.

Since 5.1

DateTimeModified

Time product was last modified in the form “08/17/2000 16:32”

Since 5.1

DateTimeReleased

Time product was released, or the empty string if the product is not released

Since 5.1

Description

Description of the product

Since 5.1

DisplayName

Display name of the product

Since 5.1

DisplayPricePreview

“1” if users can get price previews while editing

Since 5.1

EnableAutomaticFinalOutput

Synonym for AutoSubmit, above

Since 9.0

FinalOutputAction

For a PDF or Upload Office Product, either “renderAndCopy” (for Marked Rendered and copy to output folder) or “rendered” (Mark Rendered). Writeable.

Since 9.0

FinalOutputJobName

Job name of the job used for final output

Since 5.1

HasEverBeenReleased

“1” if any version of this product has been released

Since 5.1

HoldForManualPrep

Synonym for RequiresManualPrep, below

Since 9.0

IsArchived

“1” if this version of the product has been archived

Since 5.1

IsBookProduct

"1" for book products, "0" for others (read-only).

Since 8.0

IsRetired

“1” if this version of the product has been retired

Since 5.1

IsStaged

“1” if this is the staged version of the product

Since 5.1

MarkShippedOnceDownloadable

“1” if “Set status to ‘Shipped’ when output is generated” is set (writeable)

Since 5.1

MarkShippedWhenDownloadAvailable

Synonym for MarkShippedOnceDownloadable, above

Since 9.0

MasterProductID

Current staged product ID of this product, or NULL if this is the master.

Since 5.1

ModifiedSinceReleased

“1” if the most recently released version of the product differs from the staged version

Since 5.1

OfferDownload

Synonym for OfferOutputForDownload, below

Since 9.0

OfferOutputForDownload

“1” if the product is offered for download (writeable)

Since 5.1

OutputFileIsShared

(applies to PDF download products) “1” if the original location of the file is provided as a link. “0” if the file will be copied.

Since 5.1

PdfPreviewFile

Asset ID for use with a static PDF product job (writeable).

Since 7.7.5

PDFPreviewFile

Synonym for PdfPreviewFile, above.

Since 9.0

PdfProofJobName

Job name of the job used for PDF proofs

Since 5.1

PrintProcess

Print process used to produce the product, one of "NonPrint", "Printed", "LithoPrint" or "DigitalPrint", or "Unassigned". Used and set by special-purpose extensions (writeable).

Since 8.0

ProductCode

A unique, human-readable and searchable identifier for the product.

Since 7.5

ProductTaxCategory

Synonym for TaxCategory, below

Since 9.0

ProductType

A string denoting the type of current product:

■ HTML— Pageflex HTML documents

■ PAGEFLEX — Pageflex Print documents

■ PDF— Hosted PDF

■  STUDIO_ID— Studio ID Print 

■ UPLOAD— User-uploaded PDF

Since 5.1, Studio_ID added in 7.0

ProjectFileLocation

File path of the project file for this product

Since 5.1

ProjectName

Project name of the product’s project

Since 5.1

QuantityColumnText

Text template to use in the “Quantity” element of the shopping cart (writeable)

Since 9.0

RequiresManualPrep

“1” if the product is held for manual prep before being marked ready for production (writeable)

Since 5.1

RequiresShippingStep

“1” if the product requires a shipping step (writeable)

Since 5.1

RequiresShippingStepInCheckout

Synonym for RequiresShippingStep, above

Since 9.0

SearchKeywords

Space-separated list of search keywords

Since 9.0

TaxCategory

Tax category name for this product (writeable):

■ Standard — Documents are taxable according to the tax locale

■ TaxFree — Documents are nontaxable

■ Download — Documents are taxable if downloads are taxed in the tax locale

Since 5.1, changes in 9.0

ThumbnailLocation

File path of the thumbnail for this product

Since 5.1

ToolTip

String used as tool tip (writeable)

Since 9.0

URLPermaLinkToken

Permanent link (writeable)

Since 9.0

DatalistsAreTaxed

“1” = data lists are taxable in the tax locale associated to this shipment (read-only)

Since 7.5

DownloadsAreTaxed

“1” = download-only documents are taxable in the tax locale associated to this shipment (read-only)

Since 7.5

HandlingIsTaxed

“1” = handling charges are taxable in the tax locale associated to this shipment (read-only)

Since 7.5

OrderGroupID

The internal ID of the order to which this shipment belongs

Since 7.5

SequenceNumber

The index number of this shipment among the shipments in the order (starting with 1) (read-only)

Since 7.5

ShippingCharge

The shipping charge for this shipment, in units corresponding to the IsoCurrencyCode of the associated order (e.g. 1.23)

Since 7.5

ShippingIsTaxed

“1” = shipping charges are taxable in the tax locale associated to this shipment (read-only)

Since 7.5

Weight

Total weight of documents in the shipment in weight units; does not include the carton weights; excludes Rejected documents and documents which are download-only (read-only)

Since 7.5

ArchiveUploadDir

Location of uploaded files (the In Box) (read-only).

Since 2.5

AutoCreatePendingAuthorizations

When ordering via SINI, create a pending authorization of type Purchase Order if no others have been created already. Default is 0 (false).

Since 9.8

CurrencyCulture

If an argument is supplied, the home culture name of the given currency, e.g. "en-US" for "USD". If no argument is supplied, the home culture of the store currency (read-only).

Since 8.0

CurrentCultureName

Name of current culture, e.g. “en-US”. Pertains to the current session. Set in the application and stored as CurrentCulture, used to select a Strings file and do currency/number formatting. Setting this overrides the CurrentCulture and CurrentUICulture as defined in the user’s browser.

Since 2.5

CurrentPageName

Name of the current page. Returns null if the caller is not associated with a session (read-only).

Since 5.5

CurrentPageUrl

URL of the current page. Returns null if the caller is not associated with a session (read-only).

Since 5.5

CurrentStepGroup

Name of the current step group, either “Edit” or “Checkout”. Returns null if the caller is not associated with a session, or if no steps are in progress (read-only).

Since 5.5

CurrentStepUrl

URL of the current editing step. Returns null if the caller is not associated with a session, or if no document is being edited (read-only).

Since 5.5

CurrentTheme

Name of the current skinning theme. Returns null if the caller is not associated with a session. No effect on setting if the caller is not associated with a session.

Since 5.5

CurrentUICultureName

Name of current UI culture, i.e. culture name for looking up resource strings. Set in the application and stored as CurrentCulture, used to select a Strings file and do currency/number formatting. Setting this overrides the CurrentCulture and CurrentUICulture as defined in the user’s browser.

Since 5.1

CurrentUserDocument

Document ID of the document currently being edited. null if no document is being edited (read-only).

Since 5.1

DefaultCultureName

The culture associated with the default language assigned on the Site Options page (read-only).

Since 8.0

DeploymentCode

deployment code of this deployment (read-only)

Since 5.1

IsoCurrencyCode

ISO code of store currency (read-only)

Since 2.5

LoggedOnUserID

Internal identifier of user. Pertains to the current session (read-only).

Since 2.5

IsStagedSession

Returns “1” if current session is a staged session, and “0” if it is not.

Since 7.0

LoggedOnUserName

Logon name of user. Pertains to the current session (read-only).

Since 2.5

LoggedOnUserSeesPricing

Returns “1” if this user sees pricing, “0” if they do not. Pertains to the current session (read-only).

Since 9.5

OemCode

Code identifying special editions of Storefront. If null, then this is pure Pageflex Storefront (read-only).

Since 8.0

OrderOnBehalfOf

When ordering via SINI, user ID of the user who will be the owner of the ordered documents, or null if the documents retain their old ownership. Default is null. Overridden by SubmitOrderVirtually.

Since 9.8

PendingOrder

Order ID of the order currently pending, including the potential order in the shopping cart if the shopping cart page is shown. null if there is no pending order (read-only).

Since 5.1

ShowExtraStatusToUsers

"1" if users should see the "ExtraStatus" document property, "0" if not.

Since 8.0

ShowPaymentStep

The payment step will be shown for the current order.

Since 5.1

ShowShippingStep

The shipping step will be shown for the current order.

Since 5.1

SmtpPassword

E-mail server password (read-only).

Since 2.5

SmtpServerName

E-mail server name (read-only).

Since 2.5

SmtpSslPort

E-mail server port to use for SSL (read-only).

Since 2.5

SmtpUseAuthentication

“Yes” or “No” on whether to use authentication in SMTP (read-only).

Since 2.5

SmtpUsername   

E-mail server login name (read-only).

Since 2.5

SmtpUseSsl   

The string from GlobalData which controls the use of SSL during E-mail. If the string is “Yes” then e-mail uses SSL. May be null (read-only).

Since 2.5

StorefrontName

Database name of the deployment (read-only).

Since 2.0

StorefrontVersion

A string of the form “3.0.0.258” indicating the current version number of Storefront (read-only).

Since 3.0

StoreWeightUnit

“g” or “oz” for store’s weight unit (read-only).

Since 2.5

SuppressValidateDocuments

When ordering via SINI, skip the final validation of the shopping cart; assume all documents are valid. Default is 0 (false). Overridden by SubmitOrderVirtually arguments.

Since 9.8

UrlPrefixForLinks

A string to be used in e-mails in constructing URLs for linking back, e.g. to a microsite. May be null.

Since 3.0

UserCurrencyRate

Conversion rate from user currency to store currency, respresented as a decimal string (read-only).

Since 8.0

UserIsoCurrencyCode

Preferred currency of the logged-on user sessoin. If the caller is not associated with a user session, returns the store currency (read-only).

Since 8.0

Name

The name displayed on the “Scheduled Tasks” page.

Since 8.1

IsEnabled

True if the task is currently enabled to run.

Since 8.1

LastRan

Date and time of the most recent previous task instance, or null if the task has never run.

Since 8.1

Repeat

The binary string indicating which days the task is repeated, with string length determined by the value of RepeatPeriod.

If RepeatPeriod is “Weeks” then this string is the same 7-digit one used by the legacy version of this property: e.g. “0010001” means run on Tuesdays and Saturdays, “0111110” means run Monday through Friday, and “0000000” means a one-shot task that never repeats.

If RepeatPeriod is “Months” then this can be 31-character string indicating the days of the month to run: “0010000000000000000000000000001” means to run on the 3rd of the month and the 31st of the month (or for shorter months, the 3rd day and the last day). “Months” also admits a special 35-character string format which allows you to specify eligibility by day of the week; e.g. “00000000100000000000000000000000000” means to run on the second Monday of the month, and “00000000000000000000000000000000010” means to run on the last Friday.

Since 8,1, changes in 9.1

RepeatFrequency

An integer indicating the number of repeat periods between scheduled runs of the task.

Since 9.1

RepeatPeriod

One of the following strings denoting what type of interval is used to schedule repeating events:

Minutes 

Days 

Weeks 

Months 

Since 9.1

RepeatStopDateTime

A date/time string indicating when the task should stop being scheduled.

Since 9.1

RepeatStopOccurrences

An integer indicating the maximum numbers of times the task should run.

Since 9.1

RepeatStopOnFailure

For tasks which have a notion of success or failure, “1” means that the task should not continue repeating after it has failed once; “0” means to carry on scheduling the task.

Since 9.1

StartTimeDate

The date and time of the first task instance, in the form “MM/DD/YYY HH:MM:SS”

Since 8.1

SxiModuleUniqueName

For external tasks, the ID of the SXO module to invoke.

Since 8.1

SxiTaskName

For external tasks, the task name to indicate to the SXI module.

Since 8.1

TaskArguments

Any arguments required for the task, concatenated with U+000A separators.

Since 8.1

TaskCode

Task codes:

■ “purge-logs” to purge logs

■ “send-email” to send a message

■ “sxi-task” for external tasks

Since 8.1

ApprovalWorkflowName

Allows changing approval workflow to be assigned to a user. r/w.

Since 7.5

CanViewProfile

“1” if the user can view My Profile, “0” if not (read-only)

Since 5.5

DateTimeCreated

Date/time when the user was created, formatted according to the (invariant) general date and time format specifier.

Since 8.0

DirectoryLocation

The location of the user’s own assets (read-only).

Since 2.0

IsActive

“1” if the user is active, “0” if suspended

Since 2.0

IsAdminAccount

“1” if the user has admin privileges, or “0” if not. (In general, Booleans get returned this way from SINI.)

Since 3.0

IsAnonymous

“1” if the user is an anonymous account, “0” if not.

Since 5.5

IsArchived

“1” if the user is archived

Since 3.0

IsUserAccount

“1” if the user has website user privileges

Since 3.0

LockoutEndTime

Used with the failed-login lockout feature. Non-null if a user is inactive because of a lockout. Can be set to a particular time or null, and should be accompanied by appropriate setting or clearing of the IsActive property.

Since 9.6

LogonName

The logon name of the user.

Since 2.0

LoggedOnUserSeesPricing

Returns “1” if this user sees pricing, “0” if they do not. Pertains to the current session (read-only).

Since 9.5

Password

The raw value of the user password (write only).

Since 2.5

PasswordChangeForced

"1" if the password must be changed at the next user logon, "0" otherwise.

Since 8.0

PasswordExpiration

Date/time when the user password expires, formatted according to the (invariant) general date and time format specifier. NULL if the password does not expire.

Since 8.0

PasswordHashed

The hashed value of the user password.

Since 2.0

PartDocuments

Array of strings containing the document IDs of the part documents of the given kit document. If applied to a non-kit document, this is an error and returns null (and not the zero-length array). For version 8.0.2 and after, the array will only include non-zero part documents.

Since 7.6, changes in 8.0.2

DocumentsAndParts

Array of strings containing the document IDs of the documents in an order, including parts of kits.

Since 7.6

DocumentsInOrder

Array of strings containing the document IDs of the documents in an order. For version 7.6 and after, this includes only the top-level documents in the shipment and no part documents.

Since 2.0, changes in 7.6

PackingStrategy

List of box contents for an order; see “CalculatePackingStrategy” for the format of the strings in the list

Since 3.0

PackingWeights

List of floating point numbers (formatted as strings) representing just the weights of the boxes (and their contents), one number per box

Since 3.0

PaymentObjects

A list of the internal IDs for payment transactions associated to this order, ordered by sequence number; normally there is only one unless Split Payment is in effect

Since 9.1

Shipments

List of internal identifiers of all shipments belonging to this order.

Since 7.5

DocumentsAndParts

Array of strings containing the document IDs of the documents in the given shipment, including parts of kits.

Since 7.6

DocumentsInShipment

Array of strings containing the document IDs of the documents in the given shipment (part of an order). For version 7.6 and after, this includes only the top-level documents in the shipment and no part documents.

Since 7.5, changes in 7.6

PackingWeights

list of floating point numbers (formatted as strings) representing just the weights of the boxes in the shipment (and their contents), one number per box

Since 7.5

ActiveExtensions

Returns an array of the SXI Module UniqueName values of all active extensions.

Since 7.0

AllAdminGroups

Returns a list of the names of all administrator groups.

Since 3.0

AllMasterProducts

An array with the internal ID (staged version) of every product (including archived products)

Since 9.1

AllMasterProductsNotArchived

An array with the internal ID (staged version) of every active product (including retired products)

Since 9.1

AllMasterProductsWithLiveRelease

An array with the internal ID (staged version) of every product having a live release.

Since 9.1

AllUsers

Returns a list of user IDs of all users.

Since 2.0

AllUserGroups

Returns a list of the names of all user groups.

Since 3.0

AllUserGroupsWithIds

An array of designators for every user group, consisting of the group name followed by “|” and the internal ID of the group.

Since 9.1

CurrentCategory

Returns an array of strings specifying the hierarchical category name of the current category. Returns null if the caller is not associated with a session, or if that session is not showing the Start page. (read-only)

Since 5.5

DisabledExtensions

Returns an array of the UniqueNames of all the inactive extensions.

Since 7.0

UsersInGroup

Returns a list of the user IDs of all users contained in a given group. In this case the ObjectID in the GetValue() call should be set to the group name.

Since 3.0

AddressBookItems

Array of strings containing the address book item IDs for the given user, including any global address book items, or those for groups containing the user.

Since 7.6

AllContainingGroups

list of the names of all groups to which the user belongs

Since 2.0

ContainingListGroups

list of the names of list groups containing the user

Since 2.0

DocumentsInShoppingCart

list of document identifiers of documents in the user’s shopping cart

Since 2.0

DocumentsOnHold

list of document identifiers of documents in the user’s On Hold area

Since 2.0

GlobalDatabases

list of databases in the global library available to this user

Since 2.0

GlobalImages

list of images in the global library which are available to this user

Since 2.0

OrderedDocuments

list of document identifiers of all ordered documents owned by the user

Since 2.0

OrdersCompleted

list of order IDs of shipped orders owned by the user

Since 2.0

OrdersPending

list of order IDs of unshipped orders owned by the user

Since 2.0

UserAddressBookItems

Array of strings containing only the address book item IDs in the user's personal address book.

Since 7.6

UserDatabases

list of asset IDs for databases in the user’s library

Since 2.0

UserImages

list of asset IDs for images in the user’s library

Since 2.0

UserPdfDocuments

list of asset IDs for PDF documents in the user’s library

Since 3.0