Asset Attributes

This chapter outlines the asset attributes for the E-Commerce assets within Squiz Matrix.

Ecommerce Form Page

Attribute (Type)        Description        
name (text)      Name field input (Details screen)    
short name (text)      Short Name field input (Details screen)    

Ecommerce Form Contents

Attribute (Type)         Description        
actions (serialise)     Submission Actions settings (Submission Actions screen)     
answer_col_width (html_width)     Answer Width field setting (Form Contents screen)     
asset_multiple_source (text)     Multiplicity Source field input (Details screen)     
asset_name_source (text)     Name Source field input (Details screen)     
asset_price_source (text)     Price Source field input (Details screen)    
asset_promotable_source (text)     Promotability field input (Details screen)    
asset_taxable_source (text)     Taxability Source field input (Details screen)     
cancel_button_name (text)     Cancel Button field input (Display Formatting screen)    
captcha_arc (boolean)     -    
captcha_arc_colour (boolean)     -    
captcha_bgcolour (colour)     -    
captcha_bordercolour (colour)     -    
captcha_font_size (integer)     -    
captcha_form_invalid_error_message (text)     -    
captcha_height (integer)     -    
captcha_include_numbers (boolean)      -    
captcha_include_uppercase (boolean)      -    
captcha_invalid_error_message (text)      -    
captcha_length (integer)      CAPTCHA Key Length field input (Form Contents screen)     
captcha_link_text (text)      CAPTCHA Regen Link Text field input (Form Contents screen)     
captcha_max_angle (integer)      -    
captcha_max_distance (integer)      -    
captcha_min_angle (integer)       -    
captcha_min_distance (integer)        -    
captcha_textcolour (colour)      -    
captcha_ttf (assetid)       -    
captcha_use_colours (boolean)       -    
captcha_usefont (boolean)        -    
captcha_width (integer)      -    
captcha_x_start (integer)       -    
captcha_zoom (integer)        CAPTCHA Character Zoom field input (Form Contents screen)     
confirmation_button_name (text)     Confirm Button field input (Display Formatting screen)    
confirmation_page_name (text)     -    
custom_reference_id (text)     New Reference ID field input (Details screen)    
form_asset_format (text)     Individual Asset Format field input (Display Formatting screen)     
form_asset_list_format (text)     Asset List Format field input (Display Formatting screen)    
form_assets_empty_str (text)      -    
form_assets_format (text)     -    
form_width (html width)     Form Width field setting (Form Contents screen)     
gateway_assetid (assetid)     Linked Gateway field setting (Details screen)    
item_format (text)     Item Format field input (Display Formatting screen)     
item_promo_code_req_var (text)     Asset Promotional Code Request Variable field input (Details screen)    
item_quantity_req_var (text)     Asset Quantity Request Variable field input (Details screen)    
item_req_var (text)     Asset ID Request Variable field input (Details screen)    
item_taxable_string (text)     Taxable Item String field input (Display Formatting screen)    
key_val_rules (serialise)     -    
log (boolean)     -    
log_asset_item_format (text)     -    
log_entry_format (text)     -    
log_item_block_format (text)     -    
log_question_item_format (text)     -    
log_submissions (boolean)     -    
log_to_file (boolean)     -    
mollom_captcha_incorrect_text (text)        -     
mollom_captcha_regen_link_text (text)      -    
mollom_questions_to_check (serialise)      -    
mollom_spam_submission_text (text)      -    
mollom_unsure_submission_text (text)      -    
multi_page (boolean)      -    
name (text)      Name field input (Details screen)    
next_button (text)      -    
next_questionid (integer)      Questions (not attached to a section) - next question ID: (eg. if the last question added to the form is #100:q6, the next question ID will be 7) (Form Contents screen)     
note_size (text)      Note Text Size field input (Form Contents screen)     
page_list_format (text)        -    
previous_button (text)      -    
provide_accessible_captcha (boolean)      -    
question_col_width (html_width)      Question Width field setting (Form Contents screen)     
questions (serialise)      Questions (not attached to a section) settings (Form Contents screen)       
receipt_emails_format (email_format)        Receipt Email Format field settings (Email Options screen)       
receipt_field (assetid)      Receipt Recipient Question field setting (Email Options screen)      
recipient_emails_format (email_format)      Recipient Email Format field settings (Email Options screen)     
require_captcha (boolean)      Require CAPTCHA field setting (Form Contents screen)     
reset_button (text)        Reset Button Text field input (Form Contents screen)     
reset_button_extras (text)        -    
rules (serialise)     -    
save_and_exit_button (text)      -    
save_button (text)      -    
save_confirmation_message (text)        -    
selective_emails (serialise)      -    
show_results (boolean)      -    
sort_order (serialise)      -    
staf_field (assetid)      -    
staf_format (email_format)      -    
submission_errors_msg (wysiwyg)      Error Message Format field input (Form Contents screen)    
submission_expiry_time (duration)      -    
submission_warning_time (duration)      -    
submit_button (text)      Submit Button Text field input (Form Contents screen)     
submit_button_extras (text)      -    
tax_name (text)     Tax Name field input (Details screen)    
tax_value (float)     Tax Value (%) field input (Details screen)    
taxable_rules (serialise)     -    
unattached_page_name (text)      -    
use_bodycopy_confirmation (boolean)      -    
use_bodycopy_exit (boolean)        -    
use_bodycopy_main (boolean)        -    
use_bodycopy_thank_you (boolean)       -    
use_bodycopy_unattached (boolean)      -    
use_client_side (boolean)      Client-Side Validation field setting (Form Contents screen)     
use_confirmation_page (boolean)      -    
use_mollom (boolean)      -    
warning_email_format (email_format)      -    

Order

Attribute (Type)       Description      
attributes (serialise)     Answers to Global Questions section (Details screen)    
billing_addr (text)     Billing Address field information (Details screen)    
billing_name (text)     Billing Name field information (Details screen)    
captcha_status (boolean)     -    
complete (boolean)     Whether Order was completed or not    
current_page (integer)     -    
delivery_addr (text)     Delivery Address field information (Details screen)     
delivery_name (text)     Delivery Name field information (Details screen)     
id (text)     -    
latest_page (integer)     -    
submitted (datetime)     -    
transaction_id (text)     Transaction ID field information (Details screen)      
xml (text)     XML output of the Order     

Cart

Attribute (Type)         Description        
a_z_letter_format (text)     -    
a_z_style (selection)     -    
asset_grouping (serialise)     Asset Grouping settings (Asset Grouping screen)    
asset_positions (serialise)     List Position Settings settings (Details screen)     
asset_selections (serialise)     -    
asset_targets (serialise)     -    
cart_updated_text (text)     Cart Updated Message field input (Details screen)    
check_boxes (integer)     -    
checkout_text (text)     Checkout Cart Button Text field input (Details screen)    
column_layout (serialise)     Column Settings settings (Column Layout screen)       
column_layout_type (selection)     Column Type field selection (Column Layout screen)       
current_page_format (text)     -    
default_sort_by (integer)     Default Sort-by Option field selection (Asset Sorting screen)       
direction (selection)     -    
div_row_class (text)     Row Class field input (Column Layout screen)       
ecommerce_checkout_id (assetid)     Ecommerce Checkout Asset field setting (Details screen)    
exclude_assets (serialise)     -    
exclude_current_asset (boolean)     -    
exclude_root_nodes (serialise)     -    
float_precision (integer)     Float Precision field input (Details screen)    
form_submit_method (selection)     -    
group_by (selection)     List Format field selection (Details screen)       
lineage_seperator (text)     -    
link_types (integer)     Cart Items to List field setting (Details screen)    
list_effective (boolean)     -    
list_permission (integer)     -    
max_depth (integer)     -    
metadata_sort_type (text)     Default Metadata Sort Type field selection (Asset Sorting screen)     
min_depth (integer)      -    
name (text)     Page Name field input (Details screen)    
next_page_text (text)     -    
no_items_text (text)     No Items Message field input (Details screen)    
num_per_page (text)     Assets Per Page field input (Details screen)    
other_page_text (text)     -    
page_link_format (text)     -    
paramater_map (paramater_map)     Dynamic Parameters settings (Details screen)    
prev_page_text (text)     -    
proxy_types (serialise)     -    
reset_button_text (text)     Reset Button Text field input (Details screen)    
reverse_sort (boolean)     Default Sort Direction field selection (Asset Sorting screen)       
self_in_lineage (boolean)     -    
short_name (text)     Page Short Name field input (Details screen)    
show_price (boolean)      -    
sort_by (serialise)     Sort-by Options settings (Asset Sorting screen)     
sort_direction_asc_text (text)     Ascending Sort Text field input (Asset Sorting screen)       
sort_direction_desc_text (text)     Descending Sort Text field input (Asset Sorting screen)       
start_position (text)     -    
statuses (serialise)     -    
structured_dropdown_options (serialise)     -    
submit_button_text (text)      Update Cart Button Text field input (Details screen)    
submit_to_page_url (boolean)     -    
subs_only (boolean)     -    
types (serialise)     -    
use_local_cart (boolean)     -    

Checkout Page

Attribute (Type)         Description        
accept_empty_country_question (boolean)     Accept empty question? field setting (Region Specific Options screen)    
conditional_delivery_fees (serialise)     Checkout Button Text field input (Display Formatting screen)    
confirm_order_button_text (text)     Go to Confirmation Button Text field input (Display Formatting screen)    
country_question (assetid)     Country Question field setting (Region Specific Options screen)    
currency_symbol (text)     Currency Symbol field input (Display Formatting Options screen)     
customise_receipt (boolean)     Customise Receipt Contents field setting (Display Formatting Options screen)     
default_delivery_weight_fee (float)     Default Price Per Weight Metric field input (Region Specific Options screen)    
default_max_product_quantity (integer)     Default Maximum Product Quantity field input (Region Specific Options screen)    
delivery_weight_fee_mapping (serialise)     Price Per Weight Metric field setting (Region Specific Options screen)    
enforce_quantities (boolean)     Enforce Quantities field setting (Region Specific Options screen)    
flat_charge_assetid (serialise)     List of Flat Fees field settings (Taxation and Flat Fees screen)    
float_precision (integer)     Float Precision field input (Display Formatting Options screen)     
go_to_confirmation_button_text (text)     Go to Confirmation Button Text field input (Display Formatting Options screen)    
international_delivery_fee (float)     International Delivery Fee field input (Region Specific Options screen)    
international_delivery_fee_exempt_countries (serialise)     International Delivery Fee Exempt Countries field setting (Region Specific Options screen)    
item_weight_attribute_source (text)     Item Weight Source field setting (Asset Attribute) (Region Specific Options screen)     
item_weight_metadata_source (assetid)     Item Weight Source field setting (Metadata Selection) (Region Specific Options screen)    
item_weight_selector (selection)     Item Weight Selection field selection (Region Specific Options screen)    
max_delivery_fee (float)     Maxmimum delivery fee field input (Region Specific Options screen)    
name (text)     Page Name field input (Details screen)    
quantity_attribute (text)     Quantity Source field setting (Asset Attribute) (Quantity Tracking screen)    
quantity_field (assetid)     Quantity Source field setting (Metadata Text Field) (Quantity Tracking screen)    
quantity_message_cart (text)     Cart insufficient Quantity Message field input (Quantity Tracking screen)    
quantity_message_checkout (text)     Checkout insufficient Quantity Message field input (Quantity Tracking screen)     
quantity_selector (selection)     Quantity Selector field setting (Quantity Tracking screen)    
refund_info_text (text)     Product Non-Refund Text field input (Display Formatting screen)     
return_to_checkout_button_text (text)     Go Back Button Text field input (Display Formatting screen)    
short_name (text)     Page Short Name field input (Details screen)    
tax_charge_assetid (serialise)     -    
taxable_countries (serialise)     Taxable Countries field settings (Region Specific Options screen)    
taxation_name (text)     Taxation Name field input (Taxation and Flat Fees screen)    
taxation_rate (float)     Taxation Rate field input (Taxation and Flat Fees screen)    

Default Delivery Method

Attribute (Type)         Description        
name (text)      Asset Name field input (Details screen)    

Ecommerce Order

Attribute (Type)         Description        
billing_addr (text)     Billing Address field information (Details screen)    
billing_name (text)     Billing Name field information (Details screen)     
delivery_addr (text)     Delivery Address field information (Details screen)     
delivery_id (assetid)     Delivery Method field information (asset ID) (Details screen)     
delivery_name (text)     Delivery Name field information (Details screen)     
delivery_state (serialise)     Summary ofpurchased Products (price, quantity, name, has_tax, taxable, is_donation, refund_type, product_code, financial_code)    
ecom_ref_no (text)     Merchant Transaction ID field information (Details screen)      
order_form_value (serialise)     Summary field information (Order Form Q&A) (Details screen)    
order_grand_total (float)     Total price cost of the Order     
order_history (serialise)     Actions field information (Details screen)    
order_xml (text)     Order XML field information (XML Format screen)    
products (serialise)     Products purchased     
status (integer)     Processing Status field information (Details screen)     
status_message (text)     Processing Status field information (Details screen)    
summary (text)     Order Receipt field information (Details screen)    
transaction_id (text)     Transaction ID field information (Details screen)     

SecurePay eSec Payment Gateway

Attribute (Type)         Description        
cancel_text (text)     Cancel Button Text field input (Details screen)     
display_ccv (boolean)     -    
merchant_id (text)     Merchant ID field input (Details screen)    
message (wysiwyg)     -    
name (text)     Page Name field input (Details screen)    
reset_text (text)     Reset Button Text field input (Details screen)     
short_name (text)     Short Name field input (Details screen)    
submit_text (text)     Submit Button Text field input (Details screen)    
test_mode (boolean)     Text Mode field setting (Details screen)     

Datacash Payment Gateway

Attribute (Type)         Description        
addr1_var_name (text)     Address 1 Variable Name field input (Details screen)      
addr2_var_name (text)     Address 2 Variable Name field input (Details screen)    
addr3_var_name (text)     Address 3 Variable Name field input (Details screen)    
addr4_var_name (text)     Address 4 Variable Name field input (Details screen)    
avscv2_standard_policy (selection)     AVS / Standard Policy field selection (Details screen)    
cancel_text (text)     Cancel Button Text field input (Details screen)     
cardinfo_dir_path (text)     Cardinfo Directory Path field input (Details screen)     
client (text)     Client field input (Details screen)    
currency (selection)     Currency field selection (Details screen)    
datacash_api_path (text)     Datacash API Path field input (Details screen)    
merchant_url (text)     Merchant URL field input (Details screen)    
name (text)     Page Name field input (Details screen)    
nonthreed_card_types (selection)     Non-3D Secure Card Types field selection(s) (Details screen)    
password (password)     Password field input (Details screen)    
postcode_var_name (text)     Postcode Variable Name field input (Details screen)      
purchase_desc (text)     Purchase Description field input (Details screen)    
reset_text (text)     Reset Button Text field input (Details screen)       
short_name (text)     Short Name field input (Details screen)    
submit_text (text)     Submit Button Text field input (Details screen)      
test_mode (boolean)     Test Mode field setting (Details screen)    
timeout (integer)     Timeout file input (Details screen)    

SagePay Payment Gateway

Attribute (Type)         Description        
addr1_var_name (text)     Address 1 Variable Name field input (Details screen)     
addr2_var_name (text)     Address 2 Variable Name field input (Details screen)      
avscv2_standard_policy (selection)     Enable AVS/CV2? field selection (Details screen)    
cancel_text (text)     Cancel Button Text field input (Details screen)     
city_var_name (text)     City Variable Name field input (Details screen)      
country_var_name (text)     CountryVariable Name field input (Details screen)      
currency (selection)     Currency field selection (Details screen)    
delivery_addr_is_billing_addr (boolean)     Delivery Address is Billing Address? field setting (Details screen)    
description (text)     Description field input (Details screen)    
firstname_var_name (text)     First Name Variable Name field input (Details screen)     
giftaid_var_name (text)     Gift Aid Variable Name field input (Details screen)    
hide_delivery_addr (boolean)     Hide Delivery Address? field setting (Details screen)    
name (text)     Page Name field input (Details screen)    
postcode_var_name (text)     Postcode Variable Name field input (Details screen)      
protocol (text)     Protocol field input (Details screen)    
reset_text (text)     Reset Button Text field input (Details screen)     
run_mode (selection)     Run Mode field selection (Details screen)    
short_name (text)     Short Name field input (Details screen)    
submit_text (text)     Submit Button Text field input (Details screen)    
supported_card_types (selection)     Supported Cart Types field selection(s) (Details screen)    
surname_var_name (text)     Surname Variable Name field input (Details screen)    
threeds_enabled (boolean)     Enable 3-D Secure? field input (Details screen)     
timeout (integer)     Timeout field input (Details screen)    
vendor (text)     Vendor field input (Details screen)    

DPS Payment Gateway

Attribute (Type)         Description        
addr1_var_name (text)     Address 1 Variable Name field input (Details screen)      
addr2_var_name (text)     Address 2 Variable Name field input (Details screen)       
addr3_var_name (text)     Address 3 Variable Name field input (Details screen)       
addr4_var_name (text)     Address 4 Variable Name field input (Details screen)     
amount_not_specified_error (text)     Amount Not Specified Error field input (Details screen)     
avs_standard_policy (selection)     AVS / Standard Policy field selection (Details screen)    
cancel_text (text)     Cancel Button Text field input (Details screen)     
card_cv2_invalid_error (text)     Card Cv2 Invalid Error field input (Details screen)     
card_cv2_not_specified_error (text)     Card Cv2 Not Specified Error field input (Details screen)     
card_number_not_specified_error (text)     Card Number Not Specified Error field input (Details screen)     
client (text)     Client field selection (Details screen)    
currency (selection)     Currency field selection (Details screen)    
cv2_standard_policy (selection)     CV2 / Standard Policy field selection (Details screen)    
expiry_date_invalid_error (text)     Expiry Date Invalid Error field input (Details screen)     
issue_number_invalid_error (text)     Issue Number Invalid Error field input (Details screen)     
name (text)     Page Name field input (Details screen)    
password (password)     Password field input (Details screen)    
postcode_not_specified_error (text)     Postcode Not Specified Error field input (Details screen)     
postcode_var_name (text)     Postcode Variable Name field input (Details screen)    
purchase_desc (text)     -    
reset_text (text)     Reset Button Text field input (Details screen)     
short_name (text)     Short Name field input (Details screen)    
start_date_invalid_error (text)     Start Date Invalid Error field input (Details screen)     
street_address_not_specified_error (text)     Street Address Not Specified Error field input (Details screen)     
submit_text (text)     Submit Button Text field input (Details screen)    
test_mode (boolean)     Test Mode field setting (Details screen)    

uTransact Payment Gateway

Attribute (Type)         Description        
bgas_webservice_url (text)     Utransact Bgas URL field input (Details screen)    
cancel_text (text)     Cancel Button Text field input (Details screen)    
display_ccv (boolean)     CV2 Verification field setting (Details screen)    
map_address1_assetid (assetid)     Address line 1 question field setting (Details screen)     
map_address2_assetid (assetid)      Address line 2 question field setting (Details screen)      
map_city_assetid (assetid)      City question field setting (Details screen)      
map_email_assetid (assetid)      Email question field setting (Details screen)     
map_firstname_assetid (assetid)      First name question field setting (Details screen)    
map_postcode_assetid (assetid)      Postcode question field setting (Details screen)    
map_suburb_assetid (assetid)      Suburb question field setting (Details screen)      
map_surname_assetid (assetid)      Surname question field setting (Details screen)     
merchant_id (text)     Merchant ID field input (Details screen)    
name (text)     Page Name field input (Details screen)    
password (password)     Password field input (Details screen)    
payment_model (text)     Payment Model field input (Details screen)    
reset_text (text)     Reset Button Text field input (Details screen)    
services_webservice_url (text)     Utransact Services URL field input (Details screen)    
short_name (text)     Short Name field input (Details screen)    
submit_text (text)     Submit Button Text field input (Details screen)    
transactions_webservice_url (text)     Utransact Transactions URL field input (Details screen)    
username (text)     Username field input (Details screen)    

Product

Attribute (Type)         Description        
accept_promotional_code (boolean)     Accept Promotional Code field setting (Details screen)    
description (text)     Product Description field input (Details screen)    
details (text)     Details / Product Specifications field input (Details screen)    
financial_code (text)     Financial Code field input (Details screen)    
name (text)     Product Name field input (Details screen)    
price (float)     Product Price field input (Details screen)    
price_obj (serialise)     Product Price settings (Details screen)    
product_code (text)     Product Code field input (Details screen)    
refund_type (selection)     Refund Type field selection (Details screen)    
short_description (text)     Short Description field input (Details screen)     
short_name (text)     Product Name field input (Details screen)    

Promotional Code

Attribute (Type)         Description        
code (text)     Promotional Code field input (Details screen)    
name (text)     Name field input (Details screen)    
rules (serialise)     Promotional Rules settings (Details screen)    

Paypal Configuration

Attribute (Type)         Description        
custom_param_secret_str (text)     Custom Parameter Secret String field input (Details screen)    
encryption_lib_path (text)     Paypal Encryption Library Path field input (Details screen)    
name (text)     Name field input (Details screen)    

Paypal Business Account

Attribute (Type)         Description        
account_id (text)     Merchant Account ID field input (Details screen)    
account_type (selection)     Paypal Account Type field selection (Details screen)    
error_email (email)     Email field input (Details screen)    
name (text)     Name field input (Details screen)    
paypal_cert_path (text)     Paypal Certificate Path field input (Details screen)    
private_key_path (text)     Private Key Path field input (Details screen)    
public_cert_id (text)     Public Certificate ID field input (Details screen)    
public_cert_path (text)     Public Certificate Path field input (Details screen)    
send_email_on_error (boolean)     Send emails on error? field setting (Details screen)    

Paypal Payment Button

Attribute (Type)         Description        
button_type (selection)     Button Type field selection (Details screen)    
cancel_return_url (text)     Cancel URL field input (Details screen)    
cart_target_window (selection)     -    
currency (selection)     Currency field selection (Details screen)     
custom_var (text)     Custom variable field input (Details screen)    
extra_vars (text)     Extra Variables field input (Details screen)    
image_url (text)     Image URL field input (Details screen)    
item_id (text)     Item ID field input (Details screen)    
item_name (text)     Item name field input (Details screen)    
name (text)     Page Name field input (Details screen)    
notify_url (text)     Notify URL field input (Details screen)    
paypal_account_id (assetid)     Paypal Business Account field setting (Details screen)    
paypal_config_id (assetid)     Paypal Configuration field setting (Details screen)    
price (text)     Price field input (Details screen)     
return_url (text)     Return URL field input (Details screen)    
shopping_url (text)     -    
short_name (text)     Page Short Name field input (Details screen)    
undefined_quantity (boolean)     Undefined quantity? field setting (Details screen)    

Paypal IPN Receiver

Attribute (Type)         Description        
assetid_param_name (text)     Target asset ID paramater name field input (Details screen)    
name (text)     Page Name field input (Details screen)    
short_name (text)     Page Short Name field input (Details screen)    

Paypal Order

Attribute (Type)         Description        
currency (text)     Total Amount field information (currency) (Details screen)      
custom_info (text)     Custom Information information (Details screen)    
incomplete_reason (text)     Incomplete Reason field information (Details screen)     
payment_status (text)     Payment Status field information (Details screen)    
products (serialise)     Summary information (Details screen)    
total_amount (float)     Total Amount field information (Details screen)     
txn_id (text)     Unique Transaction ID field information (Details screen)