Versions Compared

Key

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

...

Code Block
"DBVersionNumber": "2014.2.0.14", //2016.1.1.7

Set to either, 2014.2.0.14 or 2016.1.1.7 depending on the version of RTP being used. This determines how credit cards are saved into RTP.

Code Block
"SourceTag": "UNITY-PK-",
"SourceId": "UNITY-PK",

Used to create the RTP Alternate ID Profile. Update ‘PK’ to whatever makes sense for each resort. Do not change after customers start logging in.

Code Block
"RelativeRoleCode": 1035,

Set value to match the RTP RoleCode for a ‘relative'. This value can be found in RTP admin or the database in the Role table.

Code Block
"PrimaryProfileTypeCode": 102,
"AlternateIdProfileTypeCode": 102,

Set value to a newly created ProfileType code in RTP (always set these two settings to the same value). AW recommends creating a new Profile Type rather than using an existing on. After this is created, a new entry in RTP admin needs to be created in Profile Type for Profiles.

Code Block
"SalesChannelCode": 1300,

Set value to the Sales Channel Code being used by the Commerce site.

Code Block
"TempCustomerCode": 3010,

Set Value to the IPTypeCode for the Temporary Customer entry in the IPType table (usually 3010 but some customers are different)

Code Block
"EncryptionToken"

No longer used. This setting can be removed.

Code Block
"RetailInventoryLocationCode": 2500,

Set value to the RTP Inventory Location Code being used for RTP retail inventory sync.

Code Block
"OrderProcessor": "Base",

Set value to Base is using Unity for Order Processing or Connect is using RTPConnect for Order Processing.

Code Block
"RTPConnect": {
  "RTPConnectUrl": "https://unity.aspenwarecommerce.net/rtpconnect/supplierservice.asmx",
  "Security": {
    "SSLEnabled": true,
    "Name": "SupplierServiceSoap",
    "Mode": "Transport",
    "Transport": {
      "ClientCredentialType": "None",
      "ProxyCredentialType": "None"

These settings are only used if the above setting, “OrderProcessor” is set to Connect. If set to Connect, define the RTP Connect URL in the RTPConnectURL field and set SSLEnabled accordingly.

Code Block
"AllowEntitlementPriceOverride": true,

Set value to true if AW Payment Plans are being used. If AW payment plans are not being used, this setting can be left as true or could be omitted from file.

Code Block
"UseAlternateInventoryStoredProc": false,

Typically this should be set to false as the performance of RTP’s inventory stored procedure was improved in 2020. This setting was created to allow Unity to use an alternate version of RTP’s stored procedure which helped increase performance until RTP’s version was improved.

Set to true if an alternate stored procedure is being used for RTP inventory pool inquires (i.e. AW_proc_publicGetProductInventoryPoolInventory.sql). Set to false (or remove setting) if the standard RTP inventory pool stored procedure is being used.

Code Block
"VoucherProductHeaderCode": "evp",
"VoucherPaymentMethodCode": 10,
"StoredValueProductHeaderCode": "stv",
"StoredValuePaymentMethodCode": 25,
"GiftCardProductHeaderCode": "gcp",
"GiftCardPaymentMethodCode": 501,

These settings are used in conjunction with AW Additional Payments. Define the general product header codes created for AW additional payment functionality along with the RTP Payment Method codes for voucher payments, gift cards and stored value.

Code Block
"UserId": "awuser",

Define an RTP UserID that will be added as the OperatorID for anything created from the site (Customer Manager Profiles, Orders, Transactions, etc.)

Code Block
"CurrencyCode": 1,

Define the RTP Currency Code being used by the site. Typically this is set to 1

Code Block
"PaymentMethodCodeOrder": 4005,
"PaymentMethodCodeFulfillment": 9999,

Set PaymentMethodCodeOrder to a newly created AW Clearing Payment Method code from RTP and set the PaymentMethodCodeFulfillment code to the RTP Deposit Applied Payment Method Code (typically 9999).

Code Block
"SupplierCode": "1",
"DistributorCode": "4",

If using RTPConnect, set SupplierCode to 1 and DistributorCode to the DisctributorCode being used by RTPConnect for Aspenware.

Code Block
"ShippingFeeProductCode": "999899",

Set to the shipping fee product header code being used by the site (**This setting may not be used anymore)

Code Block
"IPTypeCodeGuestCustomer":3014,

If using AW Guest Check-out, set value to the IPTypeCode for the Guest Checkout Customer Type entry in the IPType table

Code Block
"ActivityBuffer": 10,
"ActivityCutoffBuffer": 0,

If selling RTP Activities, these settings are used to determine if the RTP Activity lock has expired. So if the lock expires at 4:30:00 and it's set to 10 secs, then it will consider the lock is expired at 4:29:50 and try to get a new lock. This is to account for the amount of time after the order completes in AW but before it is processed into RTP by Unity.

Code Block
"CanUpdateAlternateIdProfile": true,

Set Value to true. This allows a merged customer in RTP to get an updated Alternate ID Profile value.

Code Block
"ConfigurationSettingCodes": [
  {
    "Name": "SaleLocationCode",
    "Value": 1000
  }

Leave this Value set to 1000. This is used to lookup the RTP Sale Location Code for various purposes.

Code Block
Database": {
  "RTP": { // settings for RTP Database
    "ConnectionString": "Data Source=servernameORIP;Initial Catalog=databasename;Persist Security Info=True;User ID=sqluser;Password=sqlpassword;"
    },
  "Support": {
    "ConnectionString": "Data Source=servernameORIP;Initial Catalog=databasename;Persist Security Info=True;User ID=sqluser;Password=sqlpassword;"
   },
  "Arrivals": {
    "ConnectionString": "Data Source=servername;Initial Catalog=databasename;Persist Security Info=True;User ID=sqluser;Password=sqlpassword;MultipleActiveResultSets=true"
      }

Define database settings. There are three connection strings.

  • RTP - define RTP database server, database name and SQL userID and password for accessing RTP.

  • Support - define the same as RTP unless the customer has a ‘Custom’ database that stores validation stored procedures, alternate inventory pool stored procedures, etc.

    • Arrivals - define Azure Arrival database server, database name and SQL userID and password for accessing the Arrival database. Get these values from DevOps.

Code Block
"Stores": [ // store specific settings go in a "Store" config (1 to many stores)
  {
    "StoreName": "Peak",
    "SaleLocationCode": 1600,
    "AuditLocationCode": 1600,
    "SalesChannelCode": 1300,
    "ClientCode": 300,
    "DistributorCode": "4",
    "UsePaymentCardTokenTable": "true",
	"EncryptPaymentCardTokenValue": "false"
  }

Define Aspenware Commerce Store settings. There can be more than one Store in this section if there are multiple Stores on the same Nop instance (i.e. Peak Mountain, Peak Highlands, Peak Golf, etc.)

Define values as follows.

  • StoreName = define CompanyName from Nop Store table

  • SaleLocationCode - define the RTP Sale Location Code attached to the ClientCode in this same section (look in RTP in Client admin).

  • AuditLocationCode - define the RTP Audit Location Code attached to the ClientCode in this same section (look in RTP in Client admin).

  • SalesChannelCode - define the Sales Channel Code being used by the site. The same setting is listed above outside of the Store section so set to the same.

  • ClientCode - define the Client Code being used by the Store (can be different per Store).

  • DistributorCode - define the RTP Distributor Code being used by RTP Connect (if using RTP Connect for Order Processing).

  • UsePaymentCardTokenTable - only used if "DBVersionNumber": "2016.1.1.7". Set to ‘true’ if using Auth.NET or Payeezy.

  • EncryptPaymentCardTokenValue - set to ‘true’ for Auth.NET and ‘false’ for Payeezy. These settings are not used for Square or Braintree.

Code Block
"AllowPlaceholderAddress": false,

Set Value to false to prevent Unity from creating Address Profiles in RTP that do not contain full address information. This prevents Address Profiles from being created with only periods. Set to true to allow Address Profiles to be created with just a period in the address fields.

Code Block
"LinkedRefundsEnabled": true,

Set Value to true to enable linked refunds for Square and Windcave. These are the only credit providers that supports this settings as of May of 2024. Set Value to false for other credit providers or do not have the setting added.

Code Block
"ForceActivityProcessorToBase": true,

Set Value to true if customer is using RTPConnect to process orders. This allows for a faster search of activity availability on the PDP so recommend setting to true for all customers using Connect. The setting is ignored if using Base/Unity for order processing.

Code Block
"MatchTaxCalculation": true,

When the MatchTaxCalculation setting is set to true, tax calculations in Unity will align with RTP calculations. RTP uses bankers rounding in most cases (see “Add a Penny Logic” exceptions below). This ensures a $0 balance when comparing orders in Unity and tax calculations in RTP.

Code Block
 "RentalOrderDescription": "AW Rental Order",

Optional setting that allows defining the RTP Order Header description for rental orders (orders that use a rental location). Without this setting, order descriptions will be the same as non-rental orders which is, ‘Aspenware Commerce Ecommerce Order’.