Codeunit 1280 Map Currency Exchange Rate

Base Application, Microsoft.Finance.Currency

src/Layers/W1/BaseApp/Finance/Currency/MapCurrencyExchangeRate.Codeunit.al337 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace Microsoft.Finance.Currency;using Microsoft.Utilities;using System.IO;using System.Reflection;using System.Utilities;/// <summary>/// Maps imported exchange rate data to currency exchange rate records./// Processes data exchange records and creates or updates currency exchange rates/// based on field mappings configured in the Data Exchange Framework./// </summary>/// <remarks>/// Integrates with Data Exchange Framework for structured data import./// Validates mandatory field mappings and provides integration events/// for custom exchange rate processing logic./// </remarks>codeunit 1280 "Map Currency Exchange Rate"{    TableNo = "Data Exch.";    trigger OnRun()    var        CurrencyExchangeRate: Record "Currency Exchange Rate";    begin        MapCurrencyExchangeRates(Rec, CurrencyExchangeRate);    end;    var        FieldNotMappedErr: Label 'Mandatory field %1 is not mapped. Map the field by choosing Field Mapping in the Currency Exchange Rate Sync. Setup window.', Comment = '%1 - Field Caption';    [Scope('OnPrem')]    procedure MapCurrencyExchangeRates(DataExch: Record "Data Exch."; var CurrencyExchangeRate: Record "Currency Exchange Rate")    var        DataExchField: Record "Data Exch. Field";        CurrentLineNo: Integer;    begin        CheckMandatoryFieldsMapped(DataExch);        DataExchField.SetAutoCalcFields("Data Exch. Def Code");        DataExchField.SetRange("Data Exch. No.", DataExch."Entry No.");        if DataExchField.IsEmpty() then            exit;        Commit();        CurrentLineNo := -1;        if DataExchField.FindSet() then            repeat                if CurrentLineNo <> DataExchField."Line No." then begin                    CurrentLineNo := DataExchField."Line No.";                    if UpdateCurrencyExchangeRate(CurrencyExchangeRate, DataExchField) then;                end;            until DataExchField.Next() = 0;        OnAfterMapCurrencyExchangeRates(DataExch, CurrencyExchangeRate);    end;    local procedure UpdateCurrencyExchangeRate(var CurrencyExchangeRate: Record "Currency Exchange Rate"; DefinitionDataExchField: Record "Data Exch. Field"): Boolean    var        RecordRef: RecordRef;    begin        Clear(CurrencyExchangeRate);        RecordRef.GetTable(CurrencyExchangeRate);        if not SetFields(RecordRef, DefinitionDataExchField) then            exit(false);        RecordRef.SetTable(CurrencyExchangeRate);        Commit();        exit(true);    end;    local procedure SetFields(var RecordRef: RecordRef; DefinitionDataExchField: Record "Data Exch. Field"): Boolean    var        CurrencyExchangeRate: Record "Currency Exchange Rate";    begin        if not GetAndAssignCurrencyCode(RecordRef, DefinitionDataExchField) then            exit(false);        if not GetAndAssignValue(RecordRef, CurrencyExchangeRate.FieldNo("Starting Date"), DefinitionDataExchField, Today) then            exit(false);        if not GetAndAssignValue(RecordRef, CurrencyExchangeRate.FieldNo("Relational Currency Code"), DefinitionDataExchField, '') then            exit(false);        if not GetAndAssignValue(RecordRef, CurrencyExchangeRate.FieldNo("Exchange Rate Amount"), DefinitionDataExchField, 1) then            exit(false);        if not GetAndAssignValue(RecordRef, CurrencyExchangeRate.FieldNo("Relational Exch. Rate Amount"), DefinitionDataExchField, 0) then            exit(false);        OnSetFieldsOnBeforeCurrencyExchangeRateSetTable(RecordRef, DefinitionDataExchField, CurrencyExchangeRate);        RecordRef.SetTable(CurrencyExchangeRate);        if not GetAndAssignValue(             RecordRef, CurrencyExchangeRate.FieldNo("Adjustment Exch. Rate Amount"), DefinitionDataExchField,             CurrencyExchangeRate."Exchange Rate Amount")        then            exit(false);        if not GetAndAssignValue(             RecordRef, CurrencyExchangeRate.FieldNo("Relational Adjmt Exch Rate Amt"), DefinitionDataExchField,             CurrencyExchangeRate."Relational Exch. Rate Amount")        then            exit(false);        if not GetAndAssignValue(             RecordRef, CurrencyExchangeRate.FieldNo("Fix Exchange Rate Amount"), DefinitionDataExchField,             CurrencyExchangeRate."Fix Exchange Rate Amount"::Currency)        then            exit(false);        exit(InsertOrModifyRecordRef(RecordRef, DefinitionDataExchField));    end;    local procedure InsertOrModifyRecordRef(var RecordRef: RecordRef; DefinitionDataExchField: Record "Data Exch. Field") Result: Boolean    var        IsHandled: Boolean;    begin        IsHandled := false;        OnBeforeInsertOrModifyRecordRef(RecordRef, DefinitionDataExchField, Result, IsHandled);        if IsHandled then            exit(Result);        if not RecordRef.Insert(true) then            exit(RecordRef.Modify(true));        exit(true);    end;    local procedure GetAndAssignCurrencyCode(var CurrencyExchangeRecordRef: RecordRef; DefinitionDataExchField: Record "Data Exch. Field"): Boolean    var        Currency: Record Currency;        DataExchField: Record "Data Exch. Field";        CurrencyExchangeRate: Record "Currency Exchange Rate";        DataExchFieldMapping: Record "Data Exch. Field Mapping";        TransformationRule: Record "Transformation Rule";        CurrencyCode: Text[250];    begin        if not GetFieldValue(CurrencyExchangeRecordRef, DataExchField, DefinitionDataExchField, DataExchFieldMapping, CurrencyExchangeRate.FieldNo("Currency Code")) then            exit(false);        if DataExchField.Value = '' then            exit(false);        CurrencyCode := DataExchField.Value;        if DataExchFieldMapping."Transformation Rule" <> '' then            if TransformationRule.Get(DataExchFieldMapping."Transformation Rule") then                CurrencyCode := CopyStr(TransformationRule.TransformText(DataExchField.Value), 1, MaxStrLen(CurrencyCode));        if not (Currency.Get(CopyStr(CurrencyCode, 1, MaxStrLen(Currency.Code)))) then            exit(false);        exit(AssignValue(CurrencyExchangeRecordRef, DataExchField, DataExchFieldMapping, false, '', CurrencyExchangeRate.FieldNo("Currency Code")));    end;    procedure GetAndAssignValue(var CurrencyExchangeRecordRef: RecordRef; FieldNo: Integer; DefinitionDataExchField: Record "Data Exch. Field"; DefaultValue: Variant): Boolean    var        DataExchField: Record "Data Exch. Field";        DataExchFieldMapping: Record "Data Exch. Field Mapping";        UseDefaultValue: Boolean;    begin        UseDefaultValue := not GetFieldValue(CurrencyExchangeRecordRef, DataExchField, DefinitionDataExchField, DataExchFieldMapping, FieldNo);        exit(AssignValue(CurrencyExchangeRecordRef, DataExchField, DataExchFieldMapping, UseDefaultValue, DefaultValue, FieldNo));    end;    [TryFunction]    local procedure AssignValue(var CurrencyExchangeRecordRef: RecordRef; var DataExchField: Record "Data Exch. Field"; var DataExchFieldMapping: Record "Data Exch. Field Mapping"; UseDefaultValue: Boolean; DefaultValue: Variant; FieldNo: Integer)    var        TempFieldIdsToNegate: Record "Integer" temporary;        ProcessDataExch: Codeunit "Process Data Exch.";        CurrencyExchFieldRef: FieldRef;    begin        if UseDefaultValue then begin            CurrencyExchFieldRef := CurrencyExchangeRecordRef.Field(FieldNo);            CurrencyExchFieldRef.Validate(DefaultValue);        end else begin            ProcessDataExch.SetField(CurrencyExchangeRecordRef, DataExchFieldMapping, DataExchField, TempFieldIdsToNegate);            ProcessDataExch.NegateAmounts(CurrencyExchangeRecordRef, TempFieldIdsToNegate);        end;    end;    local procedure GetFieldValue(var CurrencyExchangeRecordRef: RecordRef; var DataExchField: Record "Data Exch. Field"; var DefinitionDataExchField: Record "Data Exch. Field"; var DataExchFieldMapping: Record "Data Exch. Field Mapping"; FieldNo: Integer): Boolean    begin        if not GetFieldValue(DefinitionDataExchField, FieldNo, DataExchField) then            exit(false);        if not DataExchFieldMapping.Get(           DataExchField."Data Exch. Def Code",           DataExchField."Data Exch. Line Def Code",           CurrencyExchangeRecordRef.Number,           DataExchField."Column No.",           FieldNo)        then            exit(false);        exit(true);    end;    local procedure GetFieldValue(DefinitionDataExchField: Record "Data Exch. Field"; FieldNo: Integer; var DataExchField: Record "Data Exch. Field"): Boolean    var        DataExchFieldMapping: Record "Data Exch. Field Mapping";        ColumnNo: Integer;    begin        if not GetColumnNo(FieldNo, DefinitionDataExchField, ColumnNo) then            exit;        DataExchField.SetRange("Data Exch. No.", DefinitionDataExchField."Data Exch. No.");        DataExchField.SetRange("Data Exch. Line Def Code", DefinitionDataExchField."Data Exch. Line Def Code");        DataExchField.SetRange("Line No.", DefinitionDataExchField."Line No.");        DataExchField.SetRange("Column No.", ColumnNo);        DataExchField.SetAutoCalcFields("Data Exch. Def Code");        if DataExchField.FindFirst() then            exit(true);        DataExchFieldMapping.SetRange("Data Exch. Def Code", DefinitionDataExchField."Data Exch. Def Code");        DataExchFieldMapping.SetRange("Data Exch. Line Def Code", DefinitionDataExchField."Data Exch. Line Def Code");        DataExchFieldMapping.SetRange("Column No.", ColumnNo);        DataExchFieldMapping.SetRange("Use Default Value", true);        DataExchFieldMapping.SetFilter("Default Value", '<>%1', '');        if DataExchFieldMapping.FindFirst() then begin            DataExchField.Copy(DefinitionDataExchField);            DataExchField."Column No." := ColumnNo;            DataExchField.Value := DataExchFieldMapping."Default Value";            exit(true);        end;        exit(false);    end;    local procedure GetColumnNo(FieldNo: Integer; DataExchField: Record "Data Exch. Field"; var ColumnNo: Integer): Boolean    var        DataExchFieldMapping: Record "Data Exch. Field Mapping";    begin        DataExchField.CalcFields("Data Exch. Def Code");        DataExchFieldMapping.SetRange("Data Exch. Line Def Code", DataExchField."Data Exch. Line Def Code");        DataExchFieldMapping.SetRange("Data Exch. Def Code", DataExchField."Data Exch. Def Code");        DataExchFieldMapping.SetRange("Table ID", DATABASE::"Currency Exchange Rate");        DataExchFieldMapping.SetRange("Field ID", FieldNo);        if not DataExchFieldMapping.FindFirst() then            exit(false);        ColumnNo := DataExchFieldMapping."Column No.";        exit(true);    end;    local procedure CheckMandatoryFieldsMapped(DataExch: Record "Data Exch.")    var        DataExchFieldMapping: Record "Data Exch. Field Mapping";        TempField: Record "Field" temporary;    begin        GetMandatoryFields(TempField);        TempField.FindSet();        repeat            DataExchFieldMapping.SetRange("Data Exch. Def Code", DataExch."Data Exch. Def Code");            DataExchFieldMapping.SetRange("Field ID", TempField."No.");            if DataExchFieldMapping.IsEmpty() then                Error(FieldNotMappedErr, TempField.FieldName);        until TempField.Next() = 0;    end;    procedure GetSuggestedFields(var TempField: Record "Field" temporary)    begin        GetMandatoryFields(TempField);        GetCommonlyUsedFields(TempField);    end;    procedure GetMandatoryFields(var TempField: Record "Field" temporary)    var        CurrencyExchangeRate: Record "Currency Exchange Rate";    begin        InsertMandatoryField(TempField, CurrencyExchangeRate.FieldNo("Currency Code"), DATABASE::"Currency Exchange Rate");        InsertMandatoryField(TempField, CurrencyExchangeRate.FieldNo("Relational Exch. Rate Amount"), DATABASE::"Currency Exchange Rate");    end;    local procedure GetCommonlyUsedFields(var TempField: Record "Field" temporary)    var        CurrencyExchangeRate: Record "Currency Exchange Rate";    begin        InsertMandatoryField(TempField, CurrencyExchangeRate.FieldNo("Starting Date"), DATABASE::"Currency Exchange Rate");        InsertMandatoryField(TempField, CurrencyExchangeRate.FieldNo("Exchange Rate Amount"), DATABASE::"Currency Exchange Rate");    end;    local procedure InsertMandatoryField(var TempField: Record "Field" temporary; FieldID: Integer; TableID: Integer)    var        "Field": Record "Field";    begin        Field.Get(TableID, FieldID);        TempField.Copy(Field);        TempField.Insert();    end;    [EventSubscriber(ObjectType::Table, Database::"Service Connection", 'OnRegisterServiceConnection', '', false, false)]    local procedure HandleCurrencyExchangeRateRegisterServiceConnection(var ServiceConnection: Record "Service Connection")    var        CurrExchRateUpdateSetup: Record "Curr. Exch. Rate Update Setup";        RecRef: RecordRef;        InStream: InStream;        ServiceURL: Text;    begin        CurrExchRateUpdateSetup.SetupService();        if CurrExchRateUpdateSetup.FindSet() then            repeat                RecRef.GetTable(CurrExchRateUpdateSetup);                ServiceConnection.Status := ServiceConnection.Status::Disabled;                if CurrExchRateUpdateSetup.Enabled then                    ServiceConnection.Status := ServiceConnection.Status::Enabled;                CurrExchRateUpdateSetup.CalcFields("Web Service URL");                if CurrExchRateUpdateSetup."Web Service URL".HasValue() then begin                    CurrExchRateUpdateSetup."Web Service URL".CreateInStream(InStream);                    InStream.Read(ServiceURL);                end;                ServiceConnection.InsertServiceConnection(                      ServiceConnection, RecRef.RecordId, CurrExchRateUpdateSetup.Description, ServiceURL, PAGE::"Curr. Exch. Rate Service Card");            until CurrExchRateUpdateSetup.Next() = 0;    end;    [IntegrationEvent(false, false)]    local procedure OnAfterMapCurrencyExchangeRates(DataExch: Record "Data Exch."; var CurrencyExchangeRate: Record "Currency Exchange Rate")    begin    end;    [IntegrationEvent(false, false)]    local procedure OnBeforeInsertOrModifyRecordRef(var RecordRef: RecordRef; DefinitionDataExchField: Record "Data Exch. Field"; var Result: Boolean; var IsHandled: Boolean)    begin    end;    [IntegrationEvent(false, false)]    local procedure OnSetFieldsOnBeforeCurrencyExchangeRateSetTable(var RecordRef: RecordRef; var DefinitionDataExchField: Record "Data Exch. Field"; var CurrencyExchangeRate: Record "Currency Exchange Rate")    begin    end;}