Difference between revisions of "ProDon:Transaction importation module"

From Logilys
Jump to: navigation, search
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Header_ProDon|22|4.5|Louis-Sébastien Garneau|Jessy Fontaine|2010/05/27}}  
+
{{Header_TOC}}<br>
  
 
<br>  
 
<br>  
Line 14: Line 14:
 
! width="90" scope="col" | Specific Properties
 
! width="90" scope="col" | Specific Properties
 
|-
 
|-
| TrxGiftDate
+
| TrxGiftDate  
 
| TrxDate<br>  
 
| TrxDate<br>  
 
| <br>  
 
| <br>  
Line 21: Line 21:
 
| align="center" | [[#1trx|1]]<br>
 
| align="center" | [[#1trx|1]]<br>
 
|-
 
|-
| TrxOccasionCode
+
| TrxOccasionCode  
| TrxEvent<br>  
+
| TrxOccasion<br>  
| TrxEvent<br>  
+
| TrxOcc<br>  
 
| Existing occasion '''Code'''<br>  
 
| Existing occasion '''Code'''<br>  
 
| style="text-align: center;" | 15<br>  
 
| style="text-align: center;" | 15<br>  
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxActivityCode
+
| TrxActivityCode  
 +
| TrxActivity<br>
 
| TrxAct<br>  
 
| TrxAct<br>  
| TrxActivity<br>
 
 
| Existing activity '''Code'''<br>  
 
| Existing activity '''Code'''<br>  
 
| style="text-align: center;" | 15<br>  
 
| style="text-align: center;" | 15<br>  
 
| align="center" | [[#2trx|2]]<br>
 
| align="center" | [[#2trx|2]]<br>
 
|-
 
|-
| TrxActSource
+
| TrxOccasionDesc
 +
| <br>
 +
| <br>
 +
| <br>
 +
| style="text-align: center;" | 100
 +
| align="center" | [[#3trx|3]]
 +
|-
 +
| TrxActivityDesc
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
| Existing '''Source'''<br>  
+
| <br>
 +
| style="text-align: center;" | 100
 +
| align="center" | [[#3trx|3]]
 +
|-
 +
| TrxActOrigin
 +
| <br>
 +
| <br>
 +
| Existing '''Origin'''<br>  
 
| style="text-align: center;" | 100<br>  
 
| style="text-align: center;" | 100<br>  
 
| align="center" | [[#3trx|3]]<br>
 
| align="center" | [[#3trx|3]]<br>
 
|-
 
|-
| TrxGLCode
+
| TrxGLCode  
 
| TrxGL<br>  
 
| TrxGL<br>  
 
| <br>  
 
| <br>  
| '''Empty''' = Default activity code<br>Existing GL '''Compte'''  
+
| '''Empty''' = Default activity code<br>Existing GL '''account'''  
 
| style="text-align: center;" | 15<br>  
 
| style="text-align: center;" | 15<br>  
 
| align="center" | [[#etoiletrx|[*]]]<br>
 
| align="center" | [[#etoiletrx|[*]]]<br>
Line 53: Line 67:
 
| <br>  
 
| <br>  
 
| '''MM/YY or MM/YYYY<br>'''Slash is required<br>  
 
| '''MM/YY or MM/YYYY<br>'''Slash is required<br>  
| style="text-align: center;" | 5 ou 7<br>  
+
| style="text-align: center;" | 5 or 7<br>  
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxQuantity
+
| TrxQuantity  
 
| TrxQty<br>  
 
| TrxQty<br>  
 
| <br>  
 
| <br>  
Line 63: Line 77:
 
| align="center" | [[#4trx|4]]<br>
 
| align="center" | [[#4trx|4]]<br>
 
|-
 
|-
| TrxGiftAmount
+
| TrxGiftAmount  
 
| TrxGift<br>  
 
| TrxGift<br>  
 
| <br>  
 
| <br>  
Line 71: Line 85:
 
|-
 
|-
 
| TrxPaymentMethod  
 
| TrxPaymentMethod  
 +
| TrxPayment<br>
 
| TrxPaym<br>  
 
| TrxPaym<br>  
| TrxPayment<br>
 
 
| Existing payment '''Code'''<br>  
 
| Existing payment '''Code'''<br>  
 
| style="text-align: center;" | 15<br>  
 
| style="text-align: center;" | 15<br>  
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxPaymentReference
+
| TrxPaymentReference  
| TrxPayRef<br>  
+
| TrxRefPaym<br>  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 84: Line 98:
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxProperty
+
| TrxProperty  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 91: Line 105:
 
| align="center" | [[#5trx|5]]<br>
 
| align="center" | [[#5trx|5]]<br>
 
|-
 
|-
| TrxAppraisers
+
| TrxAppraisers  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 98: Line 112:
 
| align="center" | [[#5trx|5]]<br>
 
| align="center" | [[#5trx|5]]<br>
 
|-
 
|-
| TrxTransit
+
| TrxTransit  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 105: Line 119:
 
| align="center" | [[#6trx|6]]<br>
 
| align="center" | [[#6trx|6]]<br>
 
|-
 
|-
| TrxInstitutionNo
+
| TrxInstitutionNo  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 112: Line 126:
 
| align="center" | [[#6trx|6]]<br>
 
| align="center" | [[#6trx|6]]<br>
 
|-
 
|-
| TrxNameInstitution
+
| TrxInstitutionName
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 119: Line 133:
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxCreditCardNo
+
| TrxCreditCardNo  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 126: Line 140:
 
| align="center" | [[#6trx|6]]<br>
 
| align="center" | [[#6trx|6]]<br>
 
|-
 
|-
| TrxNoAccount
+
| TrxAccountNo
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 133: Line 147:
 
| align="center" | [[#6trx|6]]<br>
 
| align="center" | [[#6trx|6]]<br>
 
|-
 
|-
| TrxRIBKey
+
| TrxRIBKey  
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
Line 140: Line 154:
 
| align="center" | [[#7trx|7]]<br>
 
| align="center" | [[#7trx|7]]<br>
 
|-
 
|-
| TrxRecdStatus<br>  
+
| TrxReceiptStatus<br>  
| TrxRecdS<br>  
+
| TrxReceiptS<br>  
 
| <br>  
 
| <br>  
 
| '''N''' or '''F''' = None<br>'''Y''' or '''T''' = To be issued<br>'''C''' = To be calculated<br>'''Empty''' = According to activity  
 
| '''N''' or '''F''' = None<br>'''Y''' or '''T''' = To be issued<br>'''C''' = To be calculated<br>'''Empty''' = According to activity  
Line 154: Line 168:
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxRecdAnnual<br>  
+
| TrxAnnualReceipt<br>  
| TrxRecdA<br>  
+
| TrxAReceipt<br>  
 
| <br>  
 
| <br>  
| '''N''' or '''F''' or '''Empty''' = No<br>'''Y''' or '''T''' = Yes
+
| '''N''' or '''F''' or '''Empty''' = No<br>'''Y''' or '''T''' = Yes  
 
| style="text-align: center;" | 1<br>  
 
| style="text-align: center;" | 1<br>  
 
| align="center" | <br>
 
| align="center" | <br>
Line 168: Line 182:
 
| align="center" | [[#plustrx|[+]]]<br>
 
| align="center" | [[#plustrx|[+]]]<br>
 
|-
 
|-
| TrxSolicitorCode<br>  
+
| TrxCanvasserCode<br>  
| TrxSolCode<br>  
+
| TrxCanvCode<br>  
 
| <br>  
 
| <br>  
 
| Existing solicitor '''Code'''<br>  
 
| Existing solicitor '''Code'''<br>  
Line 175: Line 189:
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| TrxSolicitorName<br>  
+
| TrxCanvasserName<br>  
| TrxSolName<br>  
+
| TrxCanvName<br>  
 
| <br>  
 
| <br>  
 
| '''Firstname Lastname''' of an existing solicitor.<br>'''Note: '''The use of this field is not recommended.<br>A known issue can arise if there are multiple identical existing solicitors.<br>  
 
| '''Firstname Lastname''' of an existing solicitor.<br>'''Note: '''The use of this field is not recommended.<br>A known issue can arise if there are multiple identical existing solicitors.<br>  
Line 222: Line 236:
 
'''{{Anchor|[*]|etoiletrx}}'''&nbsp;: If the symbol [*] is added to the end of the label, the code will be created if it does not already exist.  
 
'''{{Anchor|[*]|etoiletrx}}'''&nbsp;: If the symbol [*] is added to the end of the label, the code will be created if it does not already exist.  
  
'''{{Anchor|1|1trx}}'''&nbsp;: The date format is determined by the format selected in the import options. Characters that extend beyond the maximum length will be ignored.
+
'''{{Anchor|1|1trx}}'''&nbsp;: The date format is determined by the format selected in the import options. Characters that extend beyond the maximum length will be ignored.  
  
 
'''{{Anchor|2|2trx}}'''&nbsp;: This field requires the presence of a similar field under Occasion.  
 
'''{{Anchor|2|2trx}}'''&nbsp;: This field requires the presence of a similar field under Occasion.  
  
'''{{Anchor|3|3trx}}'''&nbsp;: Useful only if the "Create non-existent activities" option is selected. The use of more than one source for a given activity code is not allowed.
+
'''{{Anchor|3|3trx}}'''&nbsp;: Useful only if the "Create non-existent activities or occasion" option is selected. The use of more than one origin or description for a given activity or occasion is not allowed.  
  
 
'''{{Anchor|4|4trx}}'''&nbsp;: If the transaction activity is defined by sales price, a quantity or gift amount must be entered.  
 
'''{{Anchor|4|4trx}}'''&nbsp;: If the transaction activity is defined by sales price, a quantity or gift amount must be entered.  
Line 232: Line 246:
 
'''{{Anchor|5|5trx}}'''&nbsp;: Required if payment method is gift in kind.  
 
'''{{Anchor|5|5trx}}'''&nbsp;: Required if payment method is gift in kind.  
  
'''{{Anchor|6|6trx}}'''&nbsp;: The field must contain at least 1 character and no more than ? characters. The maximum length is defined in the electronic payment configuration.  
+
'''{{Anchor|6|6trx}}'''&nbsp;: The field must contain at least 1 character and no more than&nbsp;? characters. The maximum length is defined in the electronic payment configuration.  
  
 
'''{{Anchor|7|7trx}}'''&nbsp;: This field is required if the 3 other RIB validation-related fields are used.  
 
'''{{Anchor|7|7trx}}'''&nbsp;: This field is required if the 3 other RIB validation-related fields are used.  
Line 238: Line 252:
 
'''{{Anchor|8|8trx}}'''&nbsp;: This column is ignored if the TrxThirdPartyUCN column exists.  
 
'''{{Anchor|8|8trx}}'''&nbsp;: This column is ignored if the TrxThirdPartyUCN column exists.  
  
'''{{Anchor|9|9trx}}'''&nbsp;: For custom values and characteristics, it is necessary to specify the label defined in ProDon using the prefix "Cli" and only letters and/or numbers (no spaces). For example, a field named "% people" would become TrxDPeople.<br>  
+
'''{{Anchor|9|9trx}}'''&nbsp;: For custom fields and characteristics, it is necessary to specify the label defined in ProDon using the prefix "Trx" and only letters and/or numbers (no spaces). For example, a field named "% of people" would become TrxOfPeople.<br>  
  
 
{| width="635" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 
{| width="635" cellspacing="1" cellpadding="1" border="1" class="wikitable"
Line 244: Line 258:
 
|-
 
|-
 
! scope="col" | Type<br>  
 
! scope="col" | Type<br>  
! scope="col" | Valeurs possibles<br>  
+
! scope="col" | Possible Values<br>  
! scope="col" | Longeur maximale<br>
+
! scope="col" | Maximum Length<br>
 
|-
 
|-
| Numérique<br>  
+
| Numeric<br>  
| Chiffre uniquement<br>  
+
| Numbers only<br>  
 
| <br>
 
| <br>
 
|-
 
|-
| Texte<br>  
+
| Text<br>  
 
| <br>  
 
| <br>  
 
| 255<br>
 
| 255<br>
 
|-
 
|-
| Date et heure<br>  
+
| Date and time<br>  
| Format de date tel que specifié dans les options d'importation<br>  
+
| Date format as specified in import options<br>  
 
| 10<br>
 
| 10<br>
 
|-
 
|-
| Vrai/Faux<br>  
+
| True/False<br>  
| '''N''' ou '''F''' = Non ('''Vide''' = Non)<br>'''O''' ou '''V''' = Oui<br>  
+
| '''N''' or '''F''' = No ('''Empty''' = No)<br>'''Y''' or '''T''' = Yes<br>  
 
| 1<br>
 
| 1<br>
 
|-
 
|-
| Liste de choix<br>  
+
| List of options<br>  
| Si la valeur n'existe pas déjà, elle sera automatiquement ajoutée à la liste<br>  
+
| If the value does not already exist, it will be automatically added to the list.<br>  
 
| 250<br>
 
| 250<br>
 
|-
 
|-
| Liste de choix prédéfinie<br>  
+
| Predefined list of options<br>  
| Choix existant dans '''''ProDon'''''<br>  
+
| Existing selection from '''''ProDon'''''<br>  
 
| 250<br>
 
| 250<br>
 
|}
 
|}
  
Pour ajouter une note, une date de début ou de fin à une caractéristique par une importation, il faut ajouter un suffixe approprié.&nbsp;Les suffixes sont&nbsp;:&nbsp;_note, _début et _fin. Par exemple&nbsp;:&nbsp;TrxDIndividus_note. La note peut contenir jusqu'à 255 caractères et les dates doivent correspondre au format spécifié dans les options d'importation.&nbsp;Ces informations sont ignorées si la colonne de base ne contient pas de valeurs&nbsp;(ie TrxDIndividus serait vide).&nbsp;Pour pouvoir utiliser les dates de début et fin, il faut aussi que les cases correspondantes soient cochées dans la configuration de la caractéristique.  
+
To add a note, start date or end date to a characteristic by import, the appropriate suffix must be added: _note, _start or _end. Example: TrxDPeople_note. The note can include up to 255 characters; dates must adhere to the format specified in the import options. This information will be ignored if the base column contains no values (e.g., if TrxDPeople is empty). To use start and end dates, the corresponding boxes must be checked in the configuration of the characteristic.  
  
Si la caractéristique le permet, il est possible d'importer plusieurs valeurs en utilisant le suffixe -1, -2 à la toute fin du libellé.&nbsp;Par exemple&nbsp;:&nbsp;TrxDIndividus_note-1. <br>  
+
If supported by the characteristic, several values can be imported by adding the suffix -1, -2 to the end of any label. Example: TrxOfPeople_note-1.<br>  
  
 
<br>  
 
<br>  
  
=== Liste des champs reçus ===
+
=== List of receipt fields ===
  
 
<br>  
 
<br>  
Line 284: Line 298:
 
{| width="100%" cellspacing="1" cellpadding="1" border="1" class="wikitable sortable"
 
{| width="100%" cellspacing="1" cellpadding="1" border="1" class="wikitable sortable"
 
|-
 
|-
! scope="col" | Libellé complet
+
! scope="col" | Full Label
! scope="col" | Abrégé 1  
+
! scope="col" | Abbreviation 1  
! scope="col" | Abrégé 2  
+
! scope="col" | Abbreviation 2  
! scope="col" | Valeurs possibles
+
! scope="col" | Possible Values
! width="75" align="center" scope="col" | Longeur maximale
+
! width="75" align="center" scope="col" | Maximum Length
! width="90" scope="col" | Particularité
+
! width="90" scope="col" | Specific Properties
 
|-
 
|-
| RecNoTrx
+
| RecTrxNo
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
| Numéro de transaction existant<br>  
+
| Existing transaction number<br>  
 
| style="text-align: center;" | 15<br>  
 
| style="text-align: center;" | 15<br>  
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| RecDateReçu
+
| RecReceiptDate
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
| '''Date<br>''''''Vide''' = Date du jour<br>  
+
| '''Date<br>''''''Empty''' = Current date<br>  
 
| style="text-align: center;" | 10<br>  
 
| style="text-align: center;" | 10<br>  
 
| align="center" | [[#1recu|1]]<br>
 
| align="center" | [[#1recu|1]]<br>
 
|-
 
|-
| RecNoReçu
+
| RecReceiptNo
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
| Nombre entier<br>  
+
| Integer<br>  
 
| style="text-align: center;" | 6<br>  
 
| style="text-align: center;" | 6<br>  
 
| align="center" | <br>
 
| align="center" | <br>
 
|-
 
|-
| RecMntReçu
+
| RecReceiptAmt
 
| <br>  
 
| <br>  
 
| <br>  
 
| <br>  
| '''Format monétaire'''<br>'''Vide''' = Montant de la transaction<br>  
+
| '''Currency format'''<br>'''Empty''' = Transaction amount<br>  
 
| style="text-align: center;" | 15<br>  
 
| style="text-align: center;" | 15<br>  
 
| align="center" | <br>
 
| align="center" | <br>
 
|}
 
|}
  
'''{{Anchor|1|1recu}}'''&nbsp;: Le format de date est dicté par le format choisi dans les options d'importation. Les caractères en trop par rapport à la longueur maximale seront ignorés.  
+
'''{{Anchor|1|1recu}}'''&nbsp;: The date format is determined by the format selected in the import options. Characters that extend beyond the maximum length will be ignored.  
  
 
{{Footer_ProDon}}
 
{{Footer_ProDon}}

Latest revision as of 15:54, 24 May 2016

Transaction importation module



List of Transaction Fields

Full Label Abbreviation 1 Abbreviation 2 Possible Values Maximum Length Specific Properties
TrxGiftDate TrxDate

Date
Empty = Current date
10
1
TrxOccasionCode TrxOccasion
TrxOcc
Existing occasion Code
15

TrxActivityCode TrxActivity
TrxAct
Existing activity Code
15
2
TrxOccasionDesc


100 3
TrxActivityDesc


100 3
TrxActOrigin

Existing Origin
100
3
TrxGLCode TrxGL

Empty = Default activity code
Existing GL account
15
[*]
TrxExpiration

MM/YY or MM/YYYY
Slash is required
5 or 7

TrxQuantity TrxQty

Integer
6
4
TrxGiftAmount TrxGift

Currency format
Without thousands separator
15
4
TrxPaymentMethod TrxPayment
TrxPaym
Existing payment Code
15

TrxPaymentReference TrxRefPaym


255

TrxProperty


100
5
TrxAppraisers


255
5
TrxTransit

Integer
10
6
TrxInstitutionNo

Integer
10
6
TrxInstitutionName


255

TrxCreditCardNo

Integer
30
6
TrxAccountNo

Integer
20
6
TrxRIBKey

Integer
2
7
TrxReceiptStatus
TrxReceiptS

N or F = None
Y or T = To be issued
C = To be calculated
Empty = According to activity
1

TrxReceiptAmount
TrxReceiptAmt

Currency format
Empty = According to activity and transaction
15

TrxAnnualReceipt
TrxAReceipt

N or F or Empty = No
Y or T = Yes
1

TrxNote



255
[+]
TrxCanvasserCode
TrxCanvCode

Existing solicitor Code
255

TrxCanvasserName
TrxCanvName

Firstname Lastname of an existing solicitor.
Note: The use of this field is not recommended.
A known issue can arise if there are multiple identical existing solicitors.
200

TrxThirdPartyUCN


Existing client number
7

TrxThirdPartyRefNo



25
8
TrxAnonymous
TrxAnony
TrxAno
N or F or Empty = No
Y or T = Yes
1

TrxCharacteristicLabel


Variable
Variable
9
TrxCustomFieldLabel


Variable
Variable
9

[+] : If the symbol [+] is added to the end of the label, the imported data will be added to the existing information in the database. Otherwise, the imported data will replace the existing information.

[*] : If the symbol [*] is added to the end of the label, the code will be created if it does not already exist.

1 : The date format is determined by the format selected in the import options. Characters that extend beyond the maximum length will be ignored.

2 : This field requires the presence of a similar field under Occasion.

3 : Useful only if the "Create non-existent activities or occasion" option is selected. The use of more than one origin or description for a given activity or occasion is not allowed.

4 : If the transaction activity is defined by sales price, a quantity or gift amount must be entered.

5 : Required if payment method is gift in kind.

6 : The field must contain at least 1 character and no more than ? characters. The maximum length is defined in the electronic payment configuration.

7 : This field is required if the 3 other RIB validation-related fields are used.

8 : This column is ignored if the TrxThirdPartyUCN column exists.

9 : For custom fields and characteristics, it is necessary to specify the label defined in ProDon using the prefix "Trx" and only letters and/or numbers (no spaces). For example, a field named "% of people" would become TrxOfPeople.

Variables
Type
Possible Values
Maximum Length
Numeric
Numbers only

Text

255
Date and time
Date format as specified in import options
10
True/False
N or F = No (Empty = No)
Y or T = Yes
1
List of options
If the value does not already exist, it will be automatically added to the list.
250
Predefined list of options
Existing selection from ProDon
250

To add a note, start date or end date to a characteristic by import, the appropriate suffix must be added: _note, _start or _end. Example: TrxDPeople_note. The note can include up to 255 characters; dates must adhere to the format specified in the import options. This information will be ignored if the base column contains no values (e.g., if TrxDPeople is empty). To use start and end dates, the corresponding boxes must be checked in the configuration of the characteristic.

If supported by the characteristic, several values can be imported by adding the suffix -1, -2 to the end of any label. Example: TrxOfPeople_note-1.


List of receipt fields


Full Label Abbreviation 1 Abbreviation 2 Possible Values Maximum Length Specific Properties
RecTrxNo

Existing transaction number
15

RecReceiptDate

Date
'
Empty' = Current date
10
1
RecReceiptNo

Integer
6

RecReceiptAmt

Currency format
Empty = Transaction amount
15

1 : The date format is determined by the format selected in the import options. Characters that extend beyond the maximum length will be ignored.


Document name: ProDon:Transaction importation module