Element Path: <cwt><ARTICLE>
The article element defines an article that can be purchased at the terminal. Multiple articles can be defined and connected to different tariff packages. An article can be selected by buttons, by entering the article id as text or automatically by the system.
| Important:
The Name attribute for an Article is not mandatory. It is however, strongly recommended to always assign a fitting unique name.
Two or more articles shall not have the same name. From articles with duplicate names the data from the second article will be queued and the statistics will not reach WebOffice |
Limitations for additional fees
•The primary article (the parking article) in a linked list of additional fee articles should only have additionalFeeArticleId. Any additionalFeeRule, additionalFeeFixedAmount or Percent is ignored in the primary article.
•Do not use cardFee or transactionFee together with AdditionalFee at least not if any of the three are percent.
•Additional Fee does not support starting with coin/cash. The end-user should be forced to Step or select additional fee article before inserting a coin/cash
•If you need to combine coin and additionalFee (not recommended):
oSet the decreaseLeftToPayWhenCashIsPaid = "true", see below.
oDo not use AdditionalFeePercent.
•Does not support Post Payment
| See the "Fees Explained" how-to guide for a detailed description on the relation between different fees. |
Attributes
acceptZeroPurchase
| Description: | Defines if it shall be possible to purchase the article without paying anything for it (purchase with zero ticks paid). |
acceptZeroToupPurchase
| Description: | If true it shall be possible to purchase free top-up tickets |
additionalFeeArticleId
| Description: | Link to the additional fee article.
Multiple additional fee articles can be defined and connected using additionalFeeArticleId |
additionalFeeRule
| Range: | Never, Always, OptionalViaUIClickFunction |
| Description: | This attribute defines additional fee rule for the article |
•Never: Additional fee amount will be excluded from the purchase.
•Always: Additional fee amount will be included always in the purchase
•OptionalViaUIClickFunction:- Additional fee amount will be included if user select the articleId
additionalFeeFixedAmount
| Description: | The additional fee fixed amount to be added to the purchase amount.
The fixed amount will be treated as minimum amount if additionalFeePercent is defined. |
additionalFeePercent
| Description: | The additional fee percent amount to be added to the purchase amount. Calculated from amount for the parent article only. |
adjustEndTimeWithMaxMinutes
| Description: | Changes the end time to Max minutes, that can be set by either payunit or purchase prerequisites duration |
articleId
| Description: | The identifier of the article. |
An ID must be unique within your company. PAT Data will be sent in to WebOffice on start-up. When having to different articles in two terminals with the same ID will result in WebOffice overwriting the article information with the information from the terminal that rebooted last
autoSelectPaymentService
| Description: | If set to true, the first valid payment service will be selected automatically when the article is selected if the currently selected payment service is invalid. See Appendix PAT selection regarding article selection. |
autoSelectTariff
| Description: | If set to true, the CWT will select the first valid tariff package connected to the article if both the currently selected tariff package and the tariff package defined in defaultTariffId are invalid. SeePAT selection regarding article selection. |
defaultTariffId
| Description: | Defines the default tariff id for the article. If the currently selected tariff package is invalid, the CWT will select the tariff package defined in defaultTariffId when the article is selected. See PAT selection regarding article selection. |
group
| Description: | The article can be included in a group. The group name can be used in the user interface to show specific panels that are connected to the group. This is useful if different articles require different user interface designs in the same CWT. See CWT User Interface Design Handbook for details on definition of panels for article groups. |
name
| Description: | The name of the article. This will be displayed on article buttons and in the user interface labels for article name. |
purchaseCategory
selectFromAllTariffs
| Description: | Defines if tariff selection shall be possible from all tariff packages defined in the CWT or if it shall be done from the tariff packages connected to the article through the COMMONTARIFFGROUP or ARTICLETARIFFGROUP. |
storePurchasedTime
| Description: | Defines if purchased time information should be stored in Purchase and OngoingPurchase database table. If set to false then units (purchases minutes) is set to 0 and startDate, EndDate, PayIntervalStartDate, and PayIntervalEndDate are set to PurchaseDate. |
tickStep
| Description: | Defines how many ticks that shall be incremented if plus is sent as step value or how many ticks that shall be decremented if minus is sent as step value. |
timeStep
| Description: | Defines how many minutes a time article to be purchased shall be incremented if plus is sent as step value or how many minutes the time shall be decremented if minus is sent as step value. The value 0xFF00FF00 is used as a generic plus and minus value. |
topUpCountLimit
| Description: | This attribute is used to identify how many times a user is allowed to top up previous purchases. This attribute is used in conjunction with topUpTimeLimit and must be specified and set to greater than 0 to enable top up. |
| When the TopUpCountLimit has passed, it is no longer possible to top up the previous purchase |
| The value specifies the number of top ups allowed for a plate (code). |
| Example: | A TopUpTimeLimit and a TopUpCountLimit for the article 0: |
<ARTICLE articleId="0" name="PBP_ARTICLE_1" useCommonTariffs="false"
topUpTimeLimit="9" topUpCountLimit="3" autoSelectTariff="true"
selectFromAllTariffs="false" purchaseCategory="10">
<paymentService id="0"/>
</ARTICLE>
topUpTimeLimit
| Description: | This attribute is used to identify the period in with the system will allow a user to top up her previous purchases. The top up time is calculated from the start time of the first transaction. When the TopUpTimeLimit has passed, it is no longer possible to top up the previous purchase.
This attribute is used in conjunction with topUpCountLimit and must be specified and set to greater than zero (0) to enable top up. |
| The Value specifies the amount of time in minutes for which the system will allow a user to top up his previous purchase. |
Note:
The system can have a message for the offline transaction dependent on if top-up purchase is available.
When topUpTimeLimit and topUpCountLimit are greater than zero (0), this message will appear “Place the ticket on dashboard. Top-up is only available on this terminal".
topUpPbsMode
| Value: | FourDigitCode, Code, ParkingSpaceId |
| Description: | This attribute defines the type of code the user needs to enter for a top up purchase when top up functionality is used in conjunction with Pay by Space (PBS). |
| FourDigitCode:
When the user makes a purchase a four-digit random ID is printed on the parking ticket. To make a top up purchase the user must input the ID printed on the ticket. |
| Code:
To make a top up purchase the user must enter a unique code. Typically, the code is a car license plate. This mode can be used together with textInputTransformation |
| ParkingSpaceId:
If a parking space has a top up purchase then it is automatically enabled when the user enters the space id. This is same functionality as with MP104 MEMO top up. In this mode, the terminal emulates single space meter functionality. |
unit
| Description: | Defines what the article unit is. Time shall be selected for time-based articles like parking. Piece shall be selected for articles that represent items as a soda can. If unit is Time, the number of units will be registered in a purchase as the number of minutes. |
useCommonTariffs
| Description: | Defines if the article shall use the common tariff group (see section 3.12) for selection of tariff packages. If not (false) at least one article tariff group needs to be defined to connect available tariffs to the article. |
VAT
| Description: | Overrides the default VAT value defined for the system in the PAYMENT element for the specific article (see defaultVAT attribute in section 1.1). The value is specified as an integer including two decimals. A value of 2500 means 25%. |
VATCategory
| Description: | Specifies the category of VAT. Overrides the default VAT value defined for the system in the PAYMENT element for the specific article (see defaultVATCategory attribute in section 3.6). |
Example:
Setup 1:
An article for selling parking time with VAT set to 25% and articleId set to 1. The article uses the common tariff group and has a default tariff package with id 1 and is connected to a payment service with id 0.
<ARTICLE articleId="1" name="Parking" useCommonTariffs="true"
defaultTariffId="1" VAT="2500" purchaseCategory="10">
<paymentService id="0"/>
</ARTICLE>
Example:
Setup 2:
An article for selling parking time with VAT set to 0% and id set to 100. The article uses a private ARTICLETARIFFGROUP to connect the tariff packages and is connected to two different payment services with id 0 and 1. It does not have a defined default tariff, which requires selection of a valid tariff package.
<ARTICLE articleId="100" name="Parking2" useCommonTariffs="false" VAT="0"
purchaseCategory="10">
<paymentService id="0"/>
<paymentService id="1"/>
</ARTICLE>
<ARTICLE articleId="1" name="Parking" useCommonTariffs="true"
defaultTariffId="1" VAT="2500" purchaseCategory="10">
<paymentService id="0"/>
</ARTICLE>
Additional Fee examples
<!--Example parent (parking) article -->
<ARTICLE articleId="17400" name="ParentArticle" additionalFeeArticleId="98765"
useCommonTariffs="false" autoSelectTariff="false"
selectFromAllTariffs="true" defaultTariffId="933012206"
purchaseCategory="10">
<paymentService id="17400" />
</ARTICLE>
<!-- Example if a transaction fee (defined as additionalFee) also is included -->
<ARTICLE articleId="98765"
name="TransactionFee" additionalFeeRule="Always" additionalFeeArticleId="98766" additionalFeeAmount="1.00"
additionalFeePercent="5.00"
useCommonTariffs="false" autoSelectTariff="false"
defaultTariffId="1" purchaseCategory="10">
<paymentService id="1" />
</ARTICLE>
<!-- Example of an SMS receipt fee is included (OptionalViaUIClickFunction ) -->
<ARTICLE articleId="98766" name="DigitalReceiptFee"
additionalFeeRule="OptionalViaUIClickFunction " additionalFeeAmount="1.00"
useCommonTariffs="false" autoSelectTariff="false"
defaultTariffId="1" purchaseCategory="10">
<paymentService id="1" />
</ARTICLE>
