49
Using Regional Date Processing
109
Once activated, new items are added to the Applications Options pane. These options
let you change the default Region Table and set up Date Search Tokens, Region
Search Tokens, and Region Shortcuts.
The fields under Regional
Date Processing are added
when you choose View, RPD
Use these Plus (+) buttons to
define search tokens and
shortcuts.
Field
Description
Region Table
Override
Studio includes a basic region table (RDPTABLE.TBL) that contains the fifty U.S. states
and the District of Columbia. It is included to help you select regions when setting up RDP
rules.
If you need to use a different region table, click the Browse icon beside the Region Table
Override field and select the region table you want to use.
This table is not required for run-time processing.
Date Search
Tokens
Use this field to identify the token names that represent the date searches you will use
within an RDP rule.
Region Search
Tokens
Use this field to list the tokens you want the user to use when creating an RDP rule.
Click the Plus (+) button to add a region search token. To remove an entry, click on it and
then use the right mouse button to access the popup menu to delete the item. When adding
a new Region Search Token, you can use the Look Up button to select from your available
fields defined in the Extract Dictionary (XDD) for your setup.
Region Shortcuts
These date and region search tokens are used during the associated batch rule to execute
the search on the transaction data and return the appropriate values found.
Use the Region Shortcuts to create macros or collections of regions identified with a single
name. For instance, you might declare a shortcut named Atlantic and then choose the
appropriate states that are identified by that location. Later, when defining an RDP rule, you
can select a Region Shortcut token instead of individually selecting each state.
The name of the shortcut and the regions included in it are entered in a similar window to
the Search tokens defined previously. Clicking the Plus (+) button on this section title
displays a window on which you can name your shortcut and select the regions it should
contain.
Note
You can see the format of a region table by exploring the RDPTABLE.TBL file that
Studio exports for you. There are two columns. The first column contains a descriptive
name for the region — like Alabama. The second column identifies the data
representation that is found when attempting to match with mapped data — like AL.
You can edit the content of a region table using Studio’s Batch Table manager.
37
Chapter 3 – Working with Application Definition Files
110
Adding Tokens and Shortcuts
To add date or region search tokens, first click the Plus (+) button in the applicable
field. The Regional Date Processing Token wizard appears so you can name the
token and enter its search information.
You can choose from these types of lookups:
Note
You can also right click while in the Date Search Token, Region Search Token, or
Region Shortcut field and choose the Add RDP option.
Click here to select the type of
lookup for the search token.
Lookup
Description
DAL scripts
If you choose DAL scripts as the type of lookup, the wizard prompts you to enter the name of
the DAL script. Click on the Browse button to choose a script from the Open File window. After
you choose a script and click Next, the wizard lets you assign a name to the token.
DAL variables
If you choose DAL variables as the type of lookup, the wizard prompts you to enter the name
of the variable. Once you enter this information and click Next, the wizard lets you assign a
name to the token.
GVM variables
If you choose GVM variables as the type of lookup, the wizard prompts you to enter the name
of the variable. Once you enter this information and click Next, the wizard lets you assign a
name to the token.
INI lookups
If you choose INI lookup as the type of lookup, the wizard prompts you to enter the name of
the INI control group, the INI option, and the option’s default value. Once you enter this
information and click Next, the wizard lets you assign a name to the token.
XDD lookups
If you choose XDD lookups as the type of lookup, the wizard prompts you to enter the name
of the lookup. Click the Browse button to choose from the Retrieve from Extract Dictionary
window. After you click OK, the wizard lets you assign a name to the token.
Note
The date search tokens you list here become the selection choices available to the user
who is creating the RDP rule.
30
Using Regional Date Processing
111
To remove an entry, click on it and then use the right mouse button to display the
popup menu and delete the item.
Region search tokens are entered the same way within their section. Here you list the
available tokens you want the user to use when creating an RDP rule.
Click on the Plus (+) button to add a new region search token. To remove an entry,
click on it and then use the right mouse button to access the popup menu to delete
the item.
When adding a new Region Search Token, you can use the Look Up button to select
from your available fields defined in the Extract Dictionary (XDD) for your setup.
These date and region search tokens are used during the associated batch rule to
execute the search on the transaction data and return the appropriate values found.
Use the Region Shortcuts to create macros or collections of regions identified with
a single name. For instance, you might declare a shortcut named Atlantic and then
choose the appropriate states that are identified by that location. Later, when defining
an RDP rule, you can select a Region Shortcut token instead of individually selecting
each state.
The name of the shortcut and the regions included in it are entered in a similar
window to the Search tokens defined previously. Clicking the Plus (+) button on this
section title displays a window on which you can name your shortcut and select the
regions it should contain.
Click the Look Up button to display a list of regions from the Region Table along
with any other shortcuts you have already created. A region shortcut can contain
other shortcuts and these are finally resolved at runtime when the RDP rules execute.
When using the Lookup selection window, simply check, or uncheck, the items you
want to include or exclude from this Shortcut definition.
Note
The date in the extract file is in 4Y2M2D format, such as 19880217 for February 17,
1988.
VB.NET PDF: Basic SDK Concept of XDoc.PDF document. OutLines. This class describes bookmarks in a PDF document. Copyright © <2000-2015> by <RasterEdge.com>. All Rights Reserved.
pdf create bookmarks; bookmarks pdf reader
35
Chapter 3 – Working with Application Definition Files
112
Once you have created all your necessary Date and Region Search tokens and
optionally created any Regional Shortcut names you want to provide, save your BDF
and check the file back into the library.
S
ETTING
U
P
R
EGIONAL
D
ATE
P
ROCESSING
R
ULES
Regional date processing (RDP) rules are defined at the form level using the Form
Lists manager. Once you have added date and region search tokens in the RDP
settings in the Business Definition manager (and saved your Business Definition
File) a new tab appears in your Form Lists manager for RDP rules.
Regional date processing rules are separate from normal trigger rules you might
assign to forms. RDP rules operate as a filter that occurs before normal form
triggering commences. Thus, RDP rules are specified separate to any necessary
trigger condition you also would use to identify when you want to include this form.
Select the RDP Rules tab to manage your RDP rules assigned to forms. RPD rules
are optional. Any form that does not specify an RDP rule is not subject to filtering
before the triggering process begins. Also, a form can have multiple RDP rules if
necessary. During runtime, each rule will execute in sequence until a matching
condition is found, or until the list is exhausted. At that point, the form is excluded
form further triggering.
Select the form you want to add a rule to and click the Plus (+) button in the
properties area. This adds a rule to the form and starts the RDP Rule wizard.
The first page of the wizard will ask for the Date Search Token (DST) you want to
use for this rule. Only one Date Search Token can be used per rule.
13
Using Regional Date Processing
113
During rule execution, the Date Search Token is used to find and perform the
appropriate search of the transaction data. At that point, it is necessary to compare
this date to an appropriate range that you will define next. Click Next.
On this page, you identify the date this form becomes effective for this rule.
Optionally, you can also specify an end date if the form is only available within a
given range. If you do not specify an end date, the form remains active indefinitely.
You can use the pop-up calendar control to select your date.
Click Next.
This next step is where you select your region search tokens. You can select all the
region search tokens that apply this rule. This means if it is required, you can get
search data from multiple locations within the transaction to satisfy this single rule.
17
Chapter 3 – Working with Application Definition Files
114
To select an item, click on it in the list. It will remain highlighted as you continue to
click other items. To deselect an item, simply click on it again.
Click Next.
Similar to how you specified a date for comparison to the Date Search Token; the
next two wizard pages let you specify the range of values that match your region
search tokens.
This page lets you identify all the states or Region Shortcut names you want to
include with this rule evaluation.
Although you can select multiple region values here, it is only necessary for one of
those regions (such as states) to match the resulting search data to satisfy the rule. In
other words, specifying multiple selections does not mean they all have to match to
satisfy the rule.
Click Next.
Because you can select shortcuts on the previous window that define multiple
regions, this page lets you refine your list by excluding certain individual regions.
22
Using Regional Date Processing
115
For instance, suppose you had selected a Region Shortcut named SouthEast that
contained GA, AL, FL, SC, and NC. Although the previous page would show the
selection of SouthEast, this exclusion page shows the expanded list of regions
included therein. This lets you turn off certain states within that token if they do not
apply to this rule.
Another example might be a shortcut called Nation that includes all 50 states and
DC. But if this rule were to require that California be excluded, you could then
deselect (uncheck) CA from the resolved list and that region would be omitted when
the rule executes.
Therefore any regions and shortcuts you selected from the first page are resolved to
show the individual regions on this page. Then you can uncheck any region, or
regions, you want to exclude from the rule.
The final page of the wizard is a summary of your rule's settings. The name of the
rule defaults to the Date Search Token selected, but you can override it on this page.
Included is a resolved region list of which regions are used for this rule. Click Finish
if you are satisfied with the rule, or Back to make changes. Click Cancel to discard
all changes and return to a blank Rule Properties screen.
Click Next.
This is the last page of the RDP Rule wizard and represents a summary of the rule
definition you have built.
19
Chapter 3 – Working with Application Definition Files
116
Once you confirm that the information is correct, click Finish and the rule
information is saved to the form you previously selected.
The rule definition appears in the property area as you click on them under each
associated form.
You can change certain information in the property window or click on the Magic
Wand toolbar icon to go through the RPD Rule wizard again.
Note there is one property (at the bottom) that is not shown via the wizard. The Test
Rule Only field lets you define a rule for testing purposes only. If you check this
field, this rule only executes when you are running Studio’s Test manager. This
makes it easy to define your rules and work on them without interfering with other
users who might be running the batch program externally.
When you are ready for the RDP rule to be used during all runs, simply uncheck the
Test Rule Only field.
When you have added all the RDP rules you want, save and check in the Group file.
Note
You can see information about the RDP rules you have created when you run an
Application Definition report.
Documents you may be interested
Documents you may be interested
