Use this event to
| Excerpt |
|---|
Create new Configuration (collection of HeaderFields) or Add HeaderFields to existing headers. |
Headers are static data in Reference Data, meaning they are loaded on login and cannot change dynamically.
The header fields are the first thing the user sees when using any function at the mobile device.
Description
New ConfigurationKeys with HeaderFields can be added using a number of "Create"-methods from the input parameter-table.
...
Supersedes OnGetReferenceData_OnAfterAddListDataAsXml
Template
...
Use this event to
| Excerpt |
|---|
Create new DataTables ("ListData") that can be used from Steps and HeaderConfigurations. |
DataTables are static data in Reference Data, meaning they are loaded on login and cannot change dynamically.
Description
A DataTable is a lists of "entries" sharing a common DataTableId, usually used to fill choices in dropdown-lists at the Mobile Device. DataTables can be referenced from Steps or HeaderConfigurations.
See also: OnGetReferenceData_OnAfterAddDataTableEntry
DataTable or listValues?
An alternative to DataTables is listValues that has advantages and disadvantages as compared to DataTables:
| DataTable | listValues |
|---|---|
| Static, loaded only once at login | Can be dynamic, is created at time of XmlResponse |
| Can be reused, is referenced only by its key (DataTableId) | Lists must be created and sent with XmlResponse |
| Most efficient, is created and loaded only once at login | Less efficient, in particular if lists are large |
| Can contain multiple fields per entry ie. Code and Name | Contains only one field per entry |
| Requires this addtional eventsubscriber to create the DataTable | Requires no extra eventSubscriber to create the listValues |
Consider using Steps.Create_ListStepFromListValues() or HeaderField.Create_ListFieldFromListValues() if your lists are short, only requires one field per entry - or needs to be dynamic.
Template
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Reference Data", 'OnGetReferenceData_OnAddDataTables', '', true, true)]
local procedure OnGetReferenceData_OnAddDataTables(var _DataTable: Record "MOB DataTable Element"; _MobileUserID: Code[50])
begin
with _DataTable do begin
InitDataTable_DataTable.InitDataTable('MyCustomDataTableId'); // Replace with your own dataTable identifier to be used with Set_dataTable(...) from Steps and HeaderConfigurations
// Create your DataTable entries here
// ...
;
end;
end;
Example (1)
// [Example] 01 - Create new custom DataTable based on BC table using a Create_XXX template
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Reference Data", 'OnGetReferenceData_OnAddDataTables', '', true, true)]
local procedure My01OnGetReferenceData_OnAddDataTables(var _DataTable: Record "MOB DataTable Element"; _MobileUserID: Code[50])
var
CountryRegion: Record "Country/Region";
begin
with _DataTable do begin
InitDataTable_DataTable.InitDataTable('MyCountries');
if CountryRegion.FindFirstFindSet() then
repeat
Create _DataTable.Create_CodeAndName(CountryRegion.Code, CountryRegion.Name);
until CountryRegion.Next() = 0;
end;
end;
Example (2)
// [Example] 02 - Create new custom DataTable based on with no use of templates
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Reference Data", 'OnGetReferenceData_OnAddDataTables', '', true, true)]
local procedure My02OnGetReferenceData_OnAddDataTables(var _DataTable: Record "MOB DataTable Element"; _MobileUserID: Code[50])
var
CountryRegion: Record "Country/Region";
begin
with _DataTable do begin
InitDataTable_DataTable.InitDataTable('MyCountryDetails');
if CountryRegion.FindFirstFindSet() then
repeat
Create _DataTable.Create();
SetValue('Code', CountryRegion.Code);
SetValue('ISOCode _DataTable.SetValue('Code', CountryRegion."ISO Code"Code);
SetValue _DataTable.SetValue('EUCode', CountryRegion."EU Country/Region Code");
until CountryRegion.Next() = 0;
end;
end;
Example (3)
// [Example] 03 - Create new custom DataTable based on optionfield
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Reference Data", 'OnGetReferenceData_OnAddDataTables', '', true, true)]
local procedure My03OnGetReferenceData_OnAddDataTables(var _DataTable: Record "MOB DataTable Element"; _MobileUserID: Code[50])
var
SalesHeader: Record "Sales Header";
OptionIdx MobCommonMgt: Codeunit "MOB Common Mgt.";
MobToolbox: Codeunit "MOB Toolbox";
OptionIndex: Integer;
begin
with _DataTable do begin
InitDataTable_DataTable.InitDataTable('MyDocumentTypes');
for OptionIdx for OptionIndex := MobToolbox.AsInteger(SalesHeader."Document Type"::Quote to SalesHeaderQuote) to MobToolbox.AsInteger(SalesHeader."Document Type"::"Return Order") do begin
SalesHeader SalesHeader."Document Type" := OptionIdxMobCommonMgt.AsSalesDocumentTypeFromInteger(OptionIndex);
Create
_DataTable.Create();
SetValue _DataTable.SetValue('DocumentType', Format(SalesHeader."Document Type"));
end;
end;
end;
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Version History
| Version | Changes |
|---|---|
| MOB5.15 | Introduced (supersedes OnGetReferenceData_OnAfterAddListDataAsXml) |
| MOB5.26 | Parameter _MobileUserID added. |