Difference between revisions of "ProDon:Commitment Importation module"
Pgillespie (talk | contribs) |
|||
(26 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{Header_TOC}}<br> |
{| width="100%" cellspacing="1" cellpadding="1" border="1" class="wikitable sortable" | {| width="100%" cellspacing="1" cellpadding="1" border="1" class="wikitable sortable" | ||
Line 10: | Line 10: | ||
! width="90" scope="col" | Specific Properties | ! width="90" scope="col" | Specific Properties | ||
|- | |- | ||
− | | | + | | CommDateRegistration |
− | | | + | | CommReg<br> |
| <br> | | <br> | ||
− | | '''Date'''<br>''' | + | | '''Date'''<br>'''Empty''' = Current date |
| style="text-align: center;" | 10<br> | | style="text-align: center;" | 10<br> | ||
| align="center" | [[#1eng|1]]<br> | | align="center" | [[#1eng|1]]<br> | ||
|- | |- | ||
− | | | + | | CommDateStart<br> |
− | | | + | | CommStart<br> |
| <br> | | <br> | ||
− | | '''Date'''<br>''' | + | | '''Date'''<br>'''Empty '''= Current date |
| style="text-align: center;" | 10<br> | | style="text-align: center;" | 10<br> | ||
| align="center" | [[#1eng|1]]<br> | | align="center" | [[#1eng|1]]<br> | ||
|- | |- | ||
− | | | + | | CommDateEnd<br> |
− | | | + | | CommEnd<br> |
| <br> | | <br> | ||
− | | '''Date'''<br>''' | + | | '''Date'''<br>'''Empty''' = Current date |
| style="text-align: center;" | 10<br> | | style="text-align: center;" | 10<br> | ||
| align="center" | [[#1eng|1]]<br> | | align="center" | [[#1eng|1]]<br> | ||
|- | |- | ||
− | | | + | | CommDateNext<br> |
− | | | + | | <br> |
+ | | <br> | ||
+ | | '''Date<br>Empty '''= Current date<br> | ||
+ | | style="text-align: center;" | 10<br> | ||
+ | | align="center" | [[#1eng|1]]<br> | ||
+ | |- | ||
+ | | CommComments<br> | ||
+ | | CommCom<br> | ||
| <br> | | <br> | ||
| <br> | | <br> | ||
Line 38: | Line 45: | ||
| align="center" | [[#pluseng|[+]]]<br> | | align="center" | [[#pluseng|[+]]]<br> | ||
|- | |- | ||
− | | | + | | CommType<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | '''Y''' or '''Empty''' = Objective<br>'''A''' = Automatic |
| style="text-align: center;" | 1<br> | | style="text-align: center;" | 1<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommAnnualReceipt<br> |
− | | | + | | CommAReceipt<br> |
| <br> | | <br> | ||
− | | '''N''' | + | | '''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> | ||
|- | |- | ||
− | | | + | | CommCodeOccasion<br> |
− | | | + | | CommOccasion<br> |
− | | | + | | CommOcc<br> |
− | | '''Code''' | + | | Existing occasion '''Code'''<br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommCodeActivity<br> |
− | | | + | | CommActivity<br> |
− | | | + | | CommAct<br> |
− | | '''Code''' | + | | Existing activity '''Code'''<br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | [[#2eng|2]]<br> | | align="center" | [[#2eng|2]]<br> | ||
|- | |- | ||
− | | | + | | CommDescOccasion |
+ | | | ||
+ | | | ||
+ | | | ||
+ | | style="text-align: center;" | 100 | ||
+ | | align="center" | [[#3eng|3]] | ||
+ | |- | ||
+ | | CommDescActivity | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | style="text-align: center;" | 100 | ||
+ | | align="center" | [[#3eng|3]] | ||
+ | |- | ||
+ | | CommActOrigin<br> | ||
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | Existing '''origin'''<br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | [[#3eng|3]]<br> | | align="center" | [[#3eng|3]]<br> | ||
|- | |- | ||
− | | | + | | CommCodeGL<br> |
− | | | + | | CommGL<br> |
| <br> | | <br> | ||
− | | '''Code''' | + | | Existing GL '''Code''' <br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | [[#etoileeng|[*]]]<br> | | align="center" | [[#etoileeng|[*]]]<br> | ||
|- | |- | ||
− | | | + | | CommFrequency<br> |
− | | | + | | CommFreq<br> |
| <br> | | <br> | ||
− | | '''? | + | | '''?W''' = Every ? week(s)<br>'''?M''' = Every ? month(s)<br>'''?Y''' = Every ? year(s) |
| style="text-align: center;" | 3<br> | | style="text-align: center;" | 3<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommInstalment<br> |
− | | | + | | CommInstalm<br> |
| <br> | | <br> | ||
− | | ''' | + | | '''Currency format'''<br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommPaymentMethod<br> |
− | | | + | | CommPayment<br> |
− | | | + | | CommPaym<br> |
− | | '''Code''' | + | | Existing payment method '''Code'''<br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommPaymentReference<br> |
− | | | + | | CommPaymentRef<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
Line 108: | Line 129: | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommTransit<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | '''Integer'''<br> |
| style="text-align: center;" | 10<br> | | style="text-align: center;" | 10<br> | ||
| align="center" | [[#4eng|4]]<br> | | align="center" | [[#4eng|4]]<br> | ||
|- | |- | ||
− | | | + | | CommInstitutionNo<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | '''Integer'''<br> |
| style="text-align: center;" | 10<br> | | style="text-align: center;" | 10<br> | ||
| align="center" | [[#4eng|4]]<br> | | align="center" | [[#4eng|4]]<br> | ||
|- | |- | ||
− | | | + | | CommInstitutionName<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
Line 129: | Line 150: | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommCreditCardNo<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | '''Integer'''<br> |
| style="text-align: center;" | 30<br> | | style="text-align: center;" | 30<br> | ||
| align="center" | [[#4eng|4]]<br> | | align="center" | [[#4eng|4]]<br> | ||
|- | |- | ||
− | | | + | | CommExpiration<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | '''MM/ | + | | '''MM/YY''' or '''MM/YYYY'''<br>Slash is required |
− | | style="text-align: center;" | 5 | + | | style="text-align: center;" | 5 or 7<br> |
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommAccountNo<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | '''Integer'''<br> |
| style="text-align: center;" | 20<br> | | style="text-align: center;" | 20<br> | ||
| align="center" | [[#4eng|4]]<br> | | align="center" | [[#4eng|4]]<br> | ||
|- | |- | ||
− | | | + | | CommRIBKey<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | ''' | + | | '''Integer'''<br> |
| style="text-align: center;" | 2<br> | | style="text-align: center;" | 2<br> | ||
| align="center" | [[#5eng|5]]<br> | | align="center" | [[#5eng|5]]<br> | ||
|- | |- | ||
− | | | + | | CommCanvasserCode<br> |
− | | | + | | CommCanvCode<br> |
| <br> | | <br> | ||
− | | '''Code''' | + | | Existing solicitor '''Code'''<br> |
| style="text-align: center;" | 25<br> | | style="text-align: center;" | 25<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommCanvasserName<br> |
− | | | + | | CommCanvName<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> |
| style="text-align: center;" | 200<br> | | style="text-align: center;" | 200<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommObjective<br> |
− | | | + | | CommObj<br> |
| <br> | | <br> | ||
− | | ''' | + | | '''Currency format'''<br> |
| style="text-align: center;" | 15<br> | | style="text-align: center;" | 15<br> | ||
| align="center" | <br> | | align="center" | <br> | ||
|- | |- | ||
− | | | + | | CommCompleteIfObjAchieved<br> |
| <br> | | <br> | ||
| <br> | | <br> | ||
− | | '''N''' | + | | '''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" | [[#6eng|6]]<br> | | align="center" | [[#6eng|6]]<br> | ||
|} | |} | ||
− | '''{{Anchor|[+]|pluseng}}''' : | + | '''{{Anchor|[+]|pluseng}}''' : 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. |
+ | |||
+ | '''{{Anchor|[*]|etoileeng}}''' : If the symbol [*] is added to the end of the label, the code will be created if it does not already exist. | ||
− | '''{{Anchor| | + | '''{{Anchor|1|1eng}}''' : The date format is determined by the format selected in the import options. Characters that extend beyond the maximum length will be ignored. |
− | '''{{Anchor| | + | '''{{Anchor|2|2eng}}''' : This field requires the presence of a similar field under Occasion. |
− | '''{{Anchor| | + | '''{{Anchor|3|3eng}}''' : 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 code is not allowed. |
− | '''{{Anchor| | + | '''{{Anchor|4|4eng}}''' : The field must contain at least 1 character and no more than ? characters. The maximum length is defined in the electronic payment configuration. |
− | '''{{Anchor| | + | '''{{Anchor|5|5eng}}''' : This field is required if the 3 other RIB validation-related fields are used. |
− | '''{{Anchor| | + | '''{{Anchor|6|6eng}}''' : This field is ignored if the commitment type is "Objective." |
− | |||
{{Footer_ProDon}} | {{Footer_ProDon}} |
Latest revision as of 15:16, 24 May 2016
Commitment Importation module |
Full Label | Abbreviation 1 | Abbreviation 2 | Possible Values | Maximum Length | Specific Properties |
---|---|---|---|---|---|
CommDateRegistration | CommReg |
|
Date Empty = Current date |
10 |
1 |
CommDateStart |
CommStart |
|
Date Empty = Current date |
10 |
1 |
CommDateEnd |
CommEnd |
|
Date Empty = Current date |
10 |
1 |
CommDateNext |
|
|
Date Empty = Current date |
10 |
1 |
CommComments |
CommCom |
|
|
255 |
[+] |
CommType |
|
|
Y or Empty = Objective A = Automatic |
1 |
|
CommAnnualReceipt |
CommAReceipt |
|
N or F or Empty = No Y or T = Yes |
1 |
|
CommCodeOccasion |
CommOccasion |
CommOcc |
Existing occasion Code |
15 |
|
CommCodeActivity |
CommActivity |
CommAct |
Existing activity Code |
15 |
2 |
CommDescOccasion | 100 | 3 | |||
CommDescActivity | 100 | 3 | |||
CommActOrigin |
|
|
Existing origin |
15 |
3 |
CommCodeGL |
CommGL |
|
Existing GL Code |
15 |
[*] |
CommFrequency |
CommFreq |
|
?W = Every ? week(s) ?M = Every ? month(s) ?Y = Every ? year(s) |
3 |
|
CommInstalment |
CommInstalm |
|
Currency format |
15 |
|
CommPaymentMethod |
CommPayment |
CommPaym |
Existing payment method Code |
15 |
|
CommPaymentReference |
CommPaymentRef |
|
|
255 |
|
CommTransit |
|
|
Integer |
10 |
4 |
CommInstitutionNo |
|
|
Integer |
10 |
4 |
CommInstitutionName |
|
|
|
255 |
|
CommCreditCardNo |
|
|
Integer |
30 |
4 |
CommExpiration |
|
|
MM/YY or MM/YYYY Slash is required |
5 or 7 |
|
CommAccountNo |
|
|
Integer |
20 |
4 |
CommRIBKey |
|
|
Integer |
2 |
5 |
CommCanvasserCode |
CommCanvCode |
|
Existing solicitor Code |
25 |
|
CommCanvasserName |
CommCanvName |
|
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 |
|
CommObjective |
CommObj |
|
Currency format |
15 |
|
CommCompleteIfObjAchieved |
|
|
N or F or Empty = No Y or T = Yes |
1 |
6 |
[+] : 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 code is not allowed.
4 : The field must contain at least 1 character and no more than ? characters. The maximum length is defined in the electronic payment configuration.
5 : This field is required if the 3 other RIB validation-related fields are used.
6 : This field is ignored if the commitment type is "Objective."
Document name: ProDon:Commitment Importation module