Difference between revisions of "Common functions:Period Management (version 4)"

From Logilys
Jump to: navigation, search
(Undo revision 9783 by Jfauvel (talk))
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Header_TOC}}<br>  
+
{{Header_TOC}}
 +
 
 +
'''<u>CAUTION</u>''' : This document is for '''VERSION''' '''4''' of '''''Prodon'''''. To go to the document for version 5, [[Prodon:Period Management|click here]]. <br>
 +
<br>  
  
 
== Introduction  ==
 
== Introduction  ==
  
Period management is a way to configure a period of time (e.g. the accounting period or a quarter of an organization). When the periods are configured, it is possible to see the summaries for each period in the "Client" files as well as in "Analysis &amp; History". Moreover, these summaries can be used to produce reports and customized lists in relation to those specific periods.  
+
In the software, there are three notions related to regions: region types, regions, region definitions.  
  
== Creating a Period  ==
+
Region types allow you to specify the kind of regions, for example: administrative region, tourist region, etc. The '''regions''' allow you to build the regions list and to specify their types, for example: Niagara, Durham, etc. The '''region definitions''' allow you to set the postal code range or the cities in one region.
  
In the software main menu, first click on "Configuration", then click on "[[Image:Bouton période.png]] Periods".
+
<br>  
 
 
[[Image:Period management 001.png]]
 
 
 
<br> The period management window will open, it is now possible to:
 
  
{| cellspacing="1" cellpadding="1" border="1" style="width: 524px; height: 449px;" class="wikitable"
+
These functions are accessible in the "Clients" menu of the software home page.  
|-
 
| colspan="2" | [[Image:Period management 002.png]]<br>
 
|-
 
| width="50%" |
 
<span style="color: rgb(255, 0, 0);">'''A: '''</span>Add, Edit/View or Remove periods.
 
 
 
| width="50%" |
 
<span style="color: rgb(255, 0, 0);">'''B:'''</span><span style="color: rgb(255, 0, 0);">''' '''</span>View the list of existing periods.  
 
  
 +
{| class="wikitable"
 +
![[File:Region management 001.png|400x400px]]
 
|}
 
|}
 +
<br>
  
<br> By clicking on the [[Image:Button add plus.png]] button, the following window will appear:
+
== Region Type Management  ==
  
{| cellspacing="1" cellpadding="1" border="1" class="wikitable" style="width: 407px; height: 531px;"
+
The four default region types are: Region, Tourist region, Administrative region and County.<br>
|-
 
| colspan="2" |
 
Example of an accounting period addition
 
  
 +
{| width="200" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 
|-
 
|-
| colspan="2" | [[Image:Period management 003.png]]<br>
+
|  
|-
+
If you click on the "Region types" option of the "Clients" menu, it is possible to customize the region types by double-clicking on the one you wish to edit (e.g. County).  
| width="50%" |
 
<span style="color: rgb(255, 0, 0);">'''A:'''</span> Is the interval covered by the period. The "Start" field allows you to enter the start date of the period and the "End" field allows you to enter the end date of the period.
 
 
 
| width="50%" |
 
<span style="color: rgb(255, 0, 0);">'''B: '''</span>Allows you to assign a complete name to the period.
 
 
 
|-
 
| width="50%" |
 
<span style="color: rgb(255, 0, 0);">'''C:'''</span> Allows you to assign a short name to the period.  
 
 
 
| width="50%" |
 
<span style="color: rgb(255, 0, 0);">'''D: '''</span>Two periods having the "Accounting period" box checked can not overlap. The second accounting period will absolutely have to start after the end of the first one.  
 
  
 
|-
 
|-
| width="50%" |
+
| [[File:Region management 002.png]]
<span style="color: rgb(255, 0, 0);">'''E:'''</span> When all the fields are filled out, click on "Confirm addition" to record the period.  
 
 
 
| width="50%" | <br>
 
 
|}
 
|}
  
 
<br>  
 
<br>  
  
{| width="200" cellspacing="1" cellpadding="1" border="1" class="wikitable"
+
{| width="50%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 +
|-
 +
| colspan="2" | [[File:Region management 003.png|469x469px]]<br>
 
|-
 
|-
 
|  
 
|  
Example of a quarter addition
+
<span style="color: rgb(255, 0, 0);">'''A:'''</span> Allows you to rename the region type (e.g. rename "County" for "Regional Municipality").
 +
 
 +
|
 +
<span style="color: rgb(255, 0, 0);">'''B:'''</span> Allows you to specify how the automations will be programmed for this region type.
  
|-
 
| [[Image:Period management 004.png]]
 
 
|-
 
|-
 
|  
 
|  
<span style="color: rgb(255, 0, 0);">'''A: '''</span>Even if the dates of the quarter overlap the dates of the accounting period, it is still possible to add this new period since the "Accounting period" box is not checked.  
+
<span style="color: rgb(255, 0, 0);">'''C:'''</span> The regions limits are determined by a postal code range.  
  
|}
 
 
<br>
 
 
{| width="200" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 
|-
 
| [[Image:Management period 005.png]]
 
|-
 
 
|  
 
|  
Here is the error message that appears when the dates of a new period overlap the dates of an accounting period.  
+
<span style="color: rgb(255, 0, 0);">'''D:'''</span> The regions limits are defined by specific cities and provinces.  
  
 
|}
 
|}
  
== View the Summaries by Period ==
+
== Region Management ==
  
=== In a Client File  ===
+
{| width="50%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 +
|-
 +
| colspan="2" |
 +
By clicking on the "Regions" option in the "Clients" menu, it is possible to add, remove or edit regions.
  
{| cellspacing="1" cellpadding="1" border="1" class="wikitable" style="width: 533px; height: 339px;"
 
 
|-
 
|-
| colspan="2" | [[Image:Period management 006.png]]
+
| colspan="2" | [[File:Region management 004.png]]
 
|-
 
|-
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''A: '''</span>Go in the "Summary" tab of any client file.  
+
'''<span style="color: rgb(255, 0, 0);">A:</span>''' Allows you to add a region.  
  
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''B:'''</span> View the client's transactions cumulative for each period.  
+
'''<span style="color: rgb(255, 0, 0);">B: </span>'''Allows you to edit an existing region. To modify it, you simply need to select the region to be edited, then click on the [[Image:Button Edit.png]] button or double-click on the region to modify.  
  
 
|-
 
|-
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''C:'''</span> Is the lifetime total of all the client's transactions.  
+
<span style="color: rgb(255, 0, 0);">'''C:'''</span> Allows you to remove a region. To remove it, you simply need to select the region to be deleted, then click on the [[Image:Button Minus remove delete.png]] button.  
  
 
| width="50%" | <br>
 
| width="50%" | <br>
 
|}
 
|}
  
=== In "Analysis &amp; History"  ===
+
<br>
  
It is also possible to view a summary by period in "Analysis &amp; History".<br>  
+
<br>  
  
{| cellspacing="1" cellpadding="1" border="1" style="width: 532px; height: 327px;" class="wikitable"
+
{| width="50%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 
|-
 
|-
| colspan="2" | [[Image:Period management 007.png]]<br>
+
| colspan="2" | [[File:Region management 005.png]]
 
|-
 
|-
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''A:'''</span> To display the analysis summaries, click on "[[Image:Bouton afficher sommaire analyse.png]] Display/Hide analysis summaries".  
+
'''<span style="color: rgb(255, 0, 0);">A: </span>'''Choose one of the [[ProDon:Region Management#Region_Type_Management|four region types]].<br>
  
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''B: '''</span>To display the analysis summaries by period, select "Period" in the drop-down list.  
+
'''<span style="color: rgb(255, 0, 0);">B: </span>'''Specify in which country the region is. If the field remains empty, the client's "Country" field should also be empty.  
  
 
|-
 
|-
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''C:'''</span> View the list of summaries by period.  
+
'''<span style="color: rgb(255, 0, 0);">C: </span>'''Enter the wanted code for the region.
 +
 
 +
| width="50%" |
 +
'''<span style="color: rgb(255, 0, 0);">D: </span>'''Enter the name of the region.  
  
| width="50%" | <br>
 
 
|}
 
|}
  
== Use of a Period<br> ==
+
== Region Definition Management ==
  
=== In a Report<br>  ===
+
By defining the regions, automations will be created: in a client's file, by only entering the city or the postal code, the given region will automatically appear if it has previously been defined.
  
The created periods will also be available when you produce reports.  
+
<br>
 +
 
 +
{| width="677" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 +
|-
 +
| colspan="2" |
 +
By clicking on the "Region definitions" option of the "Clients" menu, it is possible to manage the region definitions.  
  
{| width="50%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 
 
|-
 
|-
| colspan="2" | [[Image:Period management 008.png]]
+
| colspan="2" | [[Image:Region management 006.png]]
 
|-
 
|-
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''A:'''</span> Select the report to be issued (e.g. a donation occasion results).  
+
'''<span style="color: rgb(255, 0, 0);">A: </span>'''Allows you to add a region.
 +
 
 +
| width="50%" |
 +
'''<span style="color: rgb(255, 0, 0);">B: </span>'''Allows you to edit an existing definition. To modify it, you simply need to select the definition to be edited, then click on the [[Image:Button Edit.png]] button or double-click on the definition you wish to modify.  
  
 +
|-
 
| width="50%" |  
 
| width="50%" |  
<span style="color: rgb(255, 0, 0);">'''B: '''</span>Click on "Generate".  
+
'''<span style="color: rgb(255, 0, 0);">C: </span>'''Allows you to remove a definition. To remove it, you simply need to select the definition to be deleted, then click on the [[Image:Button Minus remove delete.png]] button.  
  
 +
| width="50%" | <br>
 
|}
 
|}
  
 
<br>  
 
<br>  
  
{| cellspacing="1" cellpadding="1" border="1" style="width: 392px; height: 519px;" class="wikitable"
+
{| width="50%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
 
|-
 
|-
| colspan="2" | [[Image:Period management 009.png]]
+
| [[Image:Region management 007.png]]<br>
 +
| [[Image:Region management 008.png]]<br>
 
|-
 
|-
| width="50%" |
+
|  
<span style="color: rgb(255, 0, 0);">'''A:'''</span> Choose the wanted donation occasion.  
+
'''<span style="color: rgb(255, 0, 0);">A:</span>'''<span style="color: rgb(255, 0, 0);"> </span>Allows you to indicate the type of region to be defined. The type also determines the method to use in <span style="color: rgb(255, 0, 0);">'''E'''</span>, whether the limits are determined in accordance with a city or with postal codes.  
  
| width="50%" |
+
|  
<span style="color: rgb(255, 0, 0);">'''B:'''</span> Filter on the transaction date.&nbsp;  
+
'''<span style="color: rgb(255, 0, 0);">B:</span>''' The country determines the regions available in <span style="color: rgb(255, 0, 0);">'''C'''</span>. It is impossible to modify it after&nbsp; a region.
  
 
|-
 
|-
| width="50%" |  
+
|  
<span style="color: rgb(255, 0, 0);">'''C:'''</span> Choose a period from the drop-down menu.  
+
<span style="color: rgb(255, 0, 0);">'''C:'''</span> Allows you to specify the region for which the limits will be determined. By entering the reference number, the desired region will appear.  
  
| width="50%" |  
+
|  
<span style="color: rgb(255, 0, 0);">'''D:'''</span> The start and end dates corresponding to the chosen period are automatically entered in the appropriate boxes.  
+
'''<span style="color: rgb(255, 0, 0);">D: </span>'''If the wanted region has not previously been created, you can create a new one by clicking on the&nbsp;[[Image:Button add plus.png]] button.  
  
|}
+
|-
 +
| colspan="2" |
 +
'''<span style="color: rgb(255, 0, 0);">E: </span>'''It is with these boxes that the rule to use can be created. To modify the method of defining the regions (By city, province and country or By postal code and country), see [[ProDon:Region Management#Region_Type_Management|Region type management]].
  
=== In a Customized List  ===
+
In the example on the left, all the clients who live in "St-Catharines" will automatically be attributed the "Niagara" administrative region.
  
The periods can also be used in the [[ProDon:Customized Lists|customized client lists]] by donations criteria (dynamic and static lists).  
+
In the example on the right, all the clients having postal codes between L1G 0A0 and L1G 9Z9, will automatically be attributed the "Durham" tourist region.  
  
<br>
+
|}
 
 
[[Image:Period management 010.png]]
 
 
 
<br>
 
  
 
<br>  
 
<br>  
Line 178: Line 162:
 
<br>  
 
<br>  
  
{{Footer_ProDon_Version|4.6.5.6}}<br>
+
{{Footer_ProDon_Version|4.6.5.5}}<br>

Latest revision as of 13:56, 16 July 2018

Period Management (version 4)

CAUTION : This document is for VERSION 4 of Prodon. To go to the document for version 5, click here.

Introduction

In the software, there are three notions related to regions: region types, regions, region definitions.

Region types allow you to specify the kind of regions, for example: administrative region, tourist region, etc. The regions allow you to build the regions list and to specify their types, for example: Niagara, Durham, etc. The region definitions allow you to set the postal code range or the cities in one region.


These functions are accessible in the "Clients" menu of the software home page.

Region management 001.png


Region Type Management

The four default region types are: Region, Tourist region, Administrative region and County.

If you click on the "Region types" option of the "Clients" menu, it is possible to customize the region types by double-clicking on the one you wish to edit (e.g. County).

Region management 002.png


Region management 003.png

A: Allows you to rename the region type (e.g. rename "County" for "Regional Municipality").

B: Allows you to specify how the automations will be programmed for this region type.

C: The regions limits are determined by a postal code range.

D: The regions limits are defined by specific cities and provinces.

Region Management

By clicking on the "Regions" option in the "Clients" menu, it is possible to add, remove or edit regions.

Region management 004.png

A: Allows you to add a region.

B: Allows you to edit an existing region. To modify it, you simply need to select the region to be edited, then click on the Button Edit.png button or double-click on the region to modify.

C: Allows you to remove a region. To remove it, you simply need to select the region to be deleted, then click on the Button Minus remove delete.png button.




Region management 005.png

A: Choose one of the four region types.

B: Specify in which country the region is. If the field remains empty, the client's "Country" field should also be empty.

C: Enter the wanted code for the region.

D: Enter the name of the region.

Region Definition Management

By defining the regions, automations will be created: in a client's file, by only entering the city or the postal code, the given region will automatically appear if it has previously been defined.


By clicking on the "Region definitions" option of the "Clients" menu, it is possible to manage the region definitions.

Region management 006.png

A: Allows you to add a region.

B: Allows you to edit an existing definition. To modify it, you simply need to select the definition to be edited, then click on the Button Edit.png button or double-click on the definition you wish to modify.

C: Allows you to remove a definition. To remove it, you simply need to select the definition to be deleted, then click on the Button Minus remove delete.png button.



Region management 007.png
Region management 008.png

A: Allows you to indicate the type of region to be defined. The type also determines the method to use in E, whether the limits are determined in accordance with a city or with postal codes.

B: The country determines the regions available in C. It is impossible to modify it after  a region.

C: Allows you to specify the region for which the limits will be determined. By entering the reference number, the desired region will appear.

D: If the wanted region has not previously been created, you can create a new one by clicking on the Button add plus.png button.

E: It is with these boxes that the rule to use can be created. To modify the method of defining the regions (By city, province and country or By postal code and country), see Region type management.

In the example on the left, all the clients who live in "St-Catharines" will automatically be attributed the "Niagara" administrative region.

In the example on the right, all the clients having postal codes between L1G 0A0 and L1G 9Z9, will automatically be attributed the "Durham" tourist region.





Document name: Common functions:Period Management (version 4)
Version : 4.6.5.5