The Data Mapper tool is available in multiple locations within Nextworld, including the Application Links, Search Actions, and Composite Application Links sub-tables in the Application Builder application.
The tool is comprised of a series of option and input fields for identifying the data you want to map and which targets you want populate. This is represented in the Data Mapper tool as source (left section) and destination (right section) components. The options available in the source section classify as mappable data and the options available in the destination section classify as a target location. The end result is the source data populating the target.
For example, an application setting exists over the Apply Customer Credits application with a data mapping definition configured. The end result of the data mapping is that when you open to the list form of the Apply Customer Credits application, the value Customer Credit automatically populates the Cash Receipt Type filter field, which is the data item CashReceiptType.
| From (source) | To (destination) | ||
|---|---|---|---|
| Source Type | Constant | Destination Type | Filter Field |
| Source Value | Customer Credit | Destination Region | List |
| Destination Value | CashReceiptType |
Source and destination options
All data mappings follow the same basic rule of mapping source data to a destination target. However, there are multiple ways in which you can map data because there are various combinations of source and target options that can be selected based on different situations and dependencies. Some of these options depend on where you are accessing the Data Mapper tool from, as well as the type and style of the source and destination applications. The options available for the source and destination value can also vary based on the the source type, destination type, or destination region selected.
Where the data mapper is used
The data mapper is used to configure different things in Nextworld including:
- Common Context
Learn more in Common Context and Common Context configuration - Application settings
Learn more in Application settings. - Field mappings in application actions
Learn more in Configure actions for an application.
Field data mapper source
The value of a field in the source application. Selecting Field for the Source Type displays the options for the Source Value as a drop-down menu containing all the data items in the source application table.
When you choose this source type, you can map the data to these destination types:
- Default Field
- Filter Field
- Title
- Subtitle
- nwId (only if the value of the Source Value Related field is
nwId)
Once a field is selected as the Source Value, the value of that field for a given record in the source application is mapped to the destination target. The data mapped in is in the format of the data item type of the Source Value.
Table Lookup fields
If the data item selected as the Source Value is a table lookup, then the Source Value Related options display as an additional drop-down containing all the related fields for that table lookup. When a Source Value Related is selected, the mapped data is the value of that related field for a given record. The data mapped is in the format of the data Item type in the Source Value Related.
You can select the table lookup's nwId as well, which results in the data being the nwId for that table lookup. A nwId can be mapped to a target where the Destination Type value is nwId, or if the destination fields are configured as such:
| To (destination) | |
|---|---|
| Destination Type | Field |
| Destination Value | table lookup |
| Destination Value Related | nwId |
Constant data mapper source
A value that is mapped as-is. Selecting Constant for the Source Type displays the Source Value as an input field where static values can be entered.
When you choose this source type, you can map the data to these destination types:
- Default Field
- Filter Field
- Title
- Subtitle
The Source Value is exactly what is entered in the input field. This value can vary based on the selection of destination options. For example if the target is a list lookup data item, the value displays as a list lookup. The Source Value with a list lookup target is always a multiple selection if the Destination Region is List. If the region is not in list form, then the multiple selection setting is based on the target data item.
The other constant type Source Type value is Constant (Translatable). This value works exactly like a constant but can be translatable.
Module setting data mapper source
The value of a field in a Module Settings type application.
When you choose this source type, you can map the data to these destination types:
- Default Field
- Filter Field
- Title
- Subtitle
- nwId (only if the value of the Source Value Related field is
nwId)
System value data mapper source
Select System Value as the Source Type when you want to map a Nextworld system value to the target destination. After selecting System Value, a lookup containing Nextworld supported system values displays.
When you choose this source type, you can map the data to these destination types:
- Default Field
- Filter Field
- Title
- Subtitle
- nwId (only if the value of the Source Value Related field is
nwId)
The following are the system values that you can use as a source type in the data mapper component:
| System value | Display name | Value | Data Item type |
|---|---|---|---|
| nwsvtrue | True | True | TrueFalse |
| nwsvfalse | False | False | TrueFalse |
| nwsvcurrentdate | Current Date (Today) | Today | Date |
| nwsvcurrentdatetime | Current Date Time (Now) | Current date and time | DateTime |
| nwsvcurrenttime | Current Time | Current time | Time |
| nwsvlifecycle | Lifecycle | The lifecycle currently in use | Text |
| nwsvusername | Username | The username of the current user | Text |
| nwsvuserrecordid | User ID Record | The ID of the user record associated with the current user | TableLookup |
| nwsvuserdirectoryid | User Directory ID | The ID of the directory record associated with the current user (might not exist) | TableLookup |
| nwsvoregunitid | User Org Unit ID | The ID of the directory record associated with the org unit of the current user (might not exist) | TableLookup |
| nwsvnamespace | Tenant Namespace | The Tenant Namespace for the current session | Text |
| nwsvdefaultvalue | System Value Default | The default value for the specified field as configured in the Data Item Definitions application | The data item type of the destination field |
nwId and nwHeaderId data mapper source
Select nwId or nwHeaderId as the Source Type to map the nwId or nwHeaderId for a given record in the source application.
When you choose these source types, you can map the data to these destination types:
- nwId
- Default Field (only if the value of the Source Value Related field is
nwId)
You can also map a nwId to a target that fits the following requirements:
- The the Destination Type is
Field - The Destination Value is a table lookup
- The Destination Value Related is
nwId
Workflow data mapper source
Select Workflow as the Source Type to map a workflow status from the source application to a destination application. This source type results in Source Value options displayed as a multiple selection drop-down menu of valid workflow options based on the destination application.
A Workflow Source Type can only map to a Destination Type of Workflow in a List Region. This is because you can filter on a workflow, but the value of a workflow can only be changed manually, not by an application setting or application link.
Input data mapper source
Select Inputs as the Source Type to configure input options for Report Builder.
When you choose this source type, you can map the data to these destination types:
- Default Field
- Filter Field
- Title
- Subtitle
- nwId
Common Context data mapper source
Select Common Context as the Source Type to configure options for common context applications.
This data mapper source type is only available when configuring common context on the Field Dependencies page in the Application Builder application. When you choose this source type, you can only map the data to the Common Context destination type.
Relative Field data mapper source
Select Relative Field as your Source Type when you want to map a date value or range of values relative to the current date.
When you choose Relative Field as your source type, you can map the data to these destination types:
- Default Field
- Filter Field
Use the Relative Filter source type to map a specific time value or range of values. In the example below, the value is one calendar day:
| Value | Mapping | Description |
|---|---|---|
| Up to today |
| All values prior to and including the start of the current day. |
| Today | Start of range
End of range
| Range of values starting at 12:00:00 AM on the current day and continuing for 24 hours. |
| Yesterday | Start of range
End of range
| Range of values starting at 12:00:00 AM on the day before the current day and continuing for 24 hours. |
| Tomorrow | Start of range
End of range
| Range of values starting at 12:00:00 AM on the day after the current day and continuing for 24 hours. |
You can also define the range of time that is mapped for a custom number of days, weeks, months, or years by specifying the number of units. See the table below for an example of how the Relative Field source type can be used to show values for a six month range in relation to the current date:
| Value | Mapping | Description |
|---|---|---|
| Previous 6 months | Start of range
End of range
| Starts at 12:00:00 AM on the first day of the month that started 6 months before the current month and continues up to 11:59 PM on the last day of the month before the current month. |
| Next 6 months | Start of range
End of range
| Starts at 12:00:00 AM on the first day of the month after the current month and continues until the end of the 6th month. |
Default field data mapper destination
Select Default Field as the Destination Type to display the Destination Value options as a drop-down of data items that exist in the destination application's table. Default fields require a Destination Region Selection, which must be a detail or advanced list region.
When you choose this destination type, you can map data from these source types:
- Field
- Constant
- Module Setting Field Mapping
- System Value
- Input
- nwId (only if the Destination Value Related field is
nwId)
Data can be mapped in to Advanced Lists such as detail lists in Header Detail applications and Relationship pages in Relationship applications.The data is mapped in to the target field when you click the Add Row button.
Default mode (no selection)
If no mode is selected in Application Links, then the target is used to retrieve an existing record in the destination application. You are telling the target to find the record where the data item in destination application equals the data that is passed in from the source.
This is a configuration where Mode is undefined:
| Source (from) | Destination (to) | ||
|---|---|---|---|
| Source Type | Field | Destination Type | Default Field |
| Source Value | NWTDataItemTypeNumber | Destination Region | Detail |
| Source Value Related | undefined | Destination Value | NWTStandardApplicationNUMBER |
| Destination Value Related | undefined | ||
| Destination Filter Prefix | undefined |
The result is that when you follow the application link, the record that has the value of the NWTDataItemTypeNumber field in the source application record, opens in the destination application. For instance, if the value of NWTDataItemTypeNumber is 123456, then the record in the destination application that has that same number in the field specified in the Destination Value opens upon selecting the application link.
Create mode
If the mapping is not being configured in application links, or if Mode is set to Create, the data from the source section is defaulted in to the data item selected as the Destination Value on a new record in the destination application.
This configuration where Mode is set to Create: opens a new record in the destination application and defaults the value 123456 into NWTStandardApplicationNUMBER:
| Source (from) | Destination (to) | ||
|---|---|---|---|
| Source Type | Field | Destination Type | Default Field |
| Source Value | NWTDataItemTypeNumber | Destination Region | Detail |
| Source Value Related | undefined | Destination Value | NWTStandardApplicationNUMBER |
| Destination Value Related | undefined | ||
| Destination Field Prefix | undefined |
The result is that when you follow the application link or any other source data that has Mode set to Create, a new record opens in the destination application where the value of the NWTDataItemTypeNumber field in the source application defaults into the field specified in the Destination Value. For instance, if the value of NWTDataItemTypeNumber is 123456, then 123456 automatically populates the NWTSTandardApplicationNUMBER field in the newly opened destination record.
Table lookup default fields data mapper source
Select a table lookup Default as the Destination Value to map data from the source table lookup to the destination table lookup.
If the data item selected as the Destination Value is a table lookup, then the options in the Destination Value Related field display as a drop-down menu containing all the related fields for that table lookup. The selected table lookup becomes the target. As long as the data mapped in to the table lookup exists, all table lookup fields are populated.
One of the Destination Related Field options is nwId. When this option is selected it only accepts an nwId as the data, either with an nwId Source Type or Source Value Related.
Filter field data mapper destination
Select Filter Field as the Destination Type to display the Destination Value options as a drop-down of data items that exist in the destination application's table. Use the range picker component to select a range of data to filter for.
When you choose this destination type, you can map data from these source types:
- Constant
- Module Setting Field Mapping
- System Value
- Field (only if the Source Value Related field is NOT
nwId)
Once a data item is selected as the Destination Value the target becomes the filter for that data item on a List Region. Filter Field destination values can be table lookups as well, so there can be options for Destination Value Related containing all the related fields. The only valid Destination Value Related selection in this case is the main typeahead search field on the table lookup's table.
Mapping an nwId to a filter field is never valid.
The fields in the header of an advanced list application are considered filters, and follow the same mapping rules as filters on a table.
Destination filter prefix
The Destination Filter Prefix provides additional specificity for Filter Field targets.
Date, DateTime, Currency, Time, Number data Item types have a Range Picker component in table filters. The Range Picker lets you define a value so that a range of data can be filtered. When mapping data to a filter that has a Range Picker, the Destination Filter Prefix options display to allow you to specify the the >= From and <= To inputs. The Destination Filter Prefix options for Range Picker are captured in the table below.
| Destination Filter Prefix | Target |
|---|---|
| = Exact Match | Sets the target for the data to be both >=From and <=To resulting in an exact match filter |
| >= Starting from and including | Maps to the >=From input in the Range Picker |
| <= Up to and including | Maps to the <=To input in the Range Picker |
You can map to just the >= From, or just the <= To, or you can do one mapping for each to get a full range to filter on. Here are some examples for >=From and <=To:
| Source (from) | Destination (to) | ||
|---|---|---|---|
| Source Type | Constant | Destination Type | Filter Field |
| Source Value | 1 | Destination Region | List |
| Source Value Related | undefined | Destination Value | NWTStandardApplicationNUMBER |
| Destination Value Related | undefined | ||
| Destination Filter Prefix | >= Starting from and including | ||
| Data | Target | ||
| 1 | Filter Field > List > NWTStandardApplicationNUMBER > '>=From' | ||
The result is a mapping that configures the >=From part of the range. The lowest number that a user can choose for the field is now 1.
| Source (from) | Destination (to) | ||
|---|---|---|---|
| Source Type | Constant | Destination Type | Filter Field |
| Source Value | 100 | Destination Region | List |
| Source Value Related | undefined | Destination Value | NWTStandardApplicationNUMBER |
| Destination Value Related | undefined | ||
| Destination Filter Prefix | <= Up to and including | ||
| Data | Target | ||
| 100 | Filter Field > List > NWTStandardApplicationNUMBER > '>=From' | ||
The result is a mapping that configures the <=To part of the range. The lowest number that a user can choose for the field is now 100.
The combination of these two mappings results in a range of 1 to 100.
Text filters
If the filter target does not have a Range Picker, then = Exact Match is only one option for Destination Filter Prefix.
Selecting = Exact Match adds an = to the front of the text data being mapped in. This makes your filter an exact match instead of a partial match. You can also leave Destination Filter Prefix undefined, which is the default, and it maps the data to the target filter as is, resulting in a partial match filter.
| Source (from) | Destination (to) | ||
|---|---|---|---|
| Source Type | Constant | Destination Type | Filter Field |
| Source Value | 'test' | Destination Region | List |
| Source Value Related | undefined | Destination Value | NWTStandardApplicationTEXT |
| Destination Value Related | undefined | ||
| Destination Filter Prefix | = Exact Match | ||
| Data | Target | ||
| 'test' | Filter Field => List => NWTStandardApplicationText | ||
The result is that when you open the list form of the destination application, the value of =test appears within the destination specified data item, NWTStandardApplicationTEXT.
Mode data mapper destination
Select Mode as the Destination Type to configure a destination application to open a new record when setting up an application link to a detail form. This destination type only applies to application links where the form configured is Detail.
This destination type applies to the Application Links subtable on the Actions page in the Application Builder application. Once you choose Mode as the destination type, configure the source data as either Default (undefined) or Create.
Default mode (no selection)
The Default Mode requires no selection. It takes whatever data is mapped from the source to a destination where the Type is a Default Field, and uses it to find an existing record in the destination application that matches the mappings. If a record is found then the application link opens the found record on the destination application when executed.
Create mode
The Create mode is configured by selecting Mode for the Destination Type and Create for the Source Type. Executing an application link with Create Mode configured opens a new blank record on the detail form of the destination application. All other data mappings configured are defaulted in to the new record.
nwId and nwHeaderId data mapper destination
Select nwId or nwHeaderId as the Destination Type to map the nwId or nwHeaderId for a given record in in the source application to the destination application. The Destination Type only accepts an nwId value if the Source Type field is nwId or the Source Value Related field is nwId.
When you choose this destination type, you can map data from these source types:
- nwId
- Field
- Module Setting Field Mapping
- System Value (only if the Source Value Related is
nwId)
Open an existing record based on the Source Value when application linking to a detail form. Open an existing record based on the Source Value when application linking to a detail form.
The data mapping looks for an existing record in the destination application that matches the nwId provided by the source data. If a record is found, then the application link opens to the found record on the destination application when executed.
Workflow data mapper destination
Select Workflow as the Destination Type to make the target the workflow filter field on the destination application list form. The only valid selection for Destination Region is List.
When you choose this destination type, you can only map data from the Workflow source type.
Title and subtitle data mapper destination
Select Title as the Destination Type to set the target to be the title of the destination application. Select Subtitle as the Destination Type to set the target to be the subtitle of the destination application.
The subtitle is only valid if the destination application is a mini app. No other selections are needed in the destination section when configuring titles or subtitles.
When you choose this destination type, you can map data from these source types:
- Field (only if the Source Value Related field is NOT
nwId) - Constant
- Module Setting Field Mapping
- System Value
Common Context data mapper destination
Select Common Context as the Destination Type to configure options for common context applications.
This data mapper destination type is only available when configuring common context on the Field Dependencies page in the Application Builder application. When you choose this source type, you can only map the data from the Common Context source type.
Data mapper destination regions
Destination regions allow you to select the specific region of your target, such as application forms.
For default and filter field destination types a Destination Region is required. For example in a relationship app, there are specific options for list, relationship page, and tree region. This is key for specifying your exact target. Destination Region options vary based on the destination application type and style, as well as the destination type (filter or default). The table below breaks down the options.
| Application type/style | Destination filter options | Destination default options |
|---|---|---|
| Standard | List | Detail |
| Standard/Detail | Detail List | Detail |
| Standard/Header | List | Header |
| Relationship | List, Relationship page, and Tree region | Detail and Relationship page |
| Report | Container | Container |
This example is a mapping to default data in the list on the relationship page:
| Source (from) | Destination (to) | ||
|---|---|---|---|
| Source Type | Constant | Destination Type | Default Field |
| Source Value | ASSETS | Destination Region | Relationship Page |
| Source Value Related | undefined | Destination Value | NwtGIAccount |
| Destination Value Related | NwtAccountName | ||
| Destination Filter Prefix | undefined | ||
| Data | Target | ||
| ASSETS | Default => Relationship Page => NwtGIAccount_NwtAccountName | ||
The result is that the value is defaulted into the list when the Add Relationship button is selected.