生成されるドキュメントに対するカスタム送信先の実装

[アーティクル]
03/23/2023

電子申告 (ER) フレームワークのアプリケーションプログラミングインターフェイス (API) により、ER 形式で生成されるドキュメントを格納する ER 送信先のリストを拡張できます。この記事には、カスタマイズされた ER 送信先を実装するために完了する必要のある主要なタスクに関する概要が含まれます。

必要条件

継続的ビルドをサポートするトポロジを配置する必要があります。詳細については、継続的ビルドとテストの自動化をサポートするトポロジの配置を参照してください。次のいずれかのロールに対応するこのトポロジにアクセスできる必要があります:

電子申告開発者
電子申告機能コンサルタント
システム管理者

また、このトポロジの開発環境にもアクセスできる必要があります。

ER フォーマット構成の作成またはインポート

現在のトポロジでは、新しい ER フォーマットを作成して、カスタマイズされた ER 送信先を使用して格納したいドキュメントを生成します。または、既存の ER フォーマットをこのトポロジにインポートできます。

形式デザイナーページで ER 形式の構造を確認する。

重要

作成またはインポートする ER フォーマットには、次のフォーマットエレメントのうち少なくとも 1 つを含める必要があります。

Common\File
Common\File attachment
Common\Folder
Excel\File
PDF\Merger
PDF\File

ソースコードの拡張

Microsoft Visual Studio プロジェクトに新しいクラス (この例では ERFileDestinationFolder) を追加し、ERIFileDestination パブリックインターフェイスを使用してカスタム送信先を実装するコードを記述します。次の例では、クラスは、生成されたドキュメントをローカルファイルシステムのフォルダーにファイルとして格納するように設計されています。

using Microsoft.Dynamics365.LocalizationFramework;

public class ERFileDestinationFolder implements ERIFileDestination
{
    private str folderPath;
    private boolean overwrite;

    public str parmFolderPath(str _value = folderPath)
    {
        folderPath = _value;
        return folderPath;
    }

    public boolean parmOverwrite(boolean _value = overwrite)
    {
        overwrite = _value;
        return overwrite;
    }

    [Hookable(false)]
    public System.IO.Stream saveFile(System.IO.Stream _stream, str _filePath)
    {
        this.sendFileToFolder(_stream, System.IO.Path::GetFileName(_filePath));
        return _stream;
    }

    [Hookable(false)]
    public System.IO.Stream newFileStream(str _filePath)
    {
        return new System.IO.MemoryStream();
    }

    private str getFileName(str _fileName)
    {
        if (overwrite)
        {
            return _fileName;
        }
        System.DateTime now = DateTimeUtil::utcNow();
        return strFmt('%1_%2%3', System.IO.Path::GetFileNameWithoutExtension(_fileName), now.ToString('yyyy-M-d_HH_mm_ss'), System.IO.Path::GetExtension(_fileName));
    }

    private void sendFileToFolder(System.IO.Stream _stream, str _fileName)
    {
        var resultPath = System.IO.Path::Combine(this.folderPath, this.getFileName(_fileName));
        using(var fileStream = System.IO.File::Create(resultPath))
        {
            if( _stream.CanSeek)
            {
                _stream.Seek(0, System.IO.SeekOrigin::Begin);
            }
            _stream.CopyTo(fileStream);
        }
    }

    /// <summary>
    /// Finalizes files processing.
    /// </summary>
    [Hookable(false)]
    public void finalize()
    {
    }
}

Visual Studio プロジェクト (この例では ERFormatDestinationSaveInFolderSettings) に新しいクラスを追加し、ERIFormatFileDestinationSettings パブリックインターフェイスを使用して、カスタム送信先の作成方法、パラメーターをストレージ用にパックする方法、およびパラメーターをユーザーインターフェイス (UI) に表示するためにアンパックする方法を指定するコードを記述します。

using Microsoft.Dynamics365.LocalizationFramework;

public class ERFormatDestinationSaveInFolderSettings implements ERIFormatFileDestinationSettings
{
    internal const str SettingsKey = classStr(ERFormatDestinationSaveInFolderSettings);
    public const int CurrentVersion = 1;

    private boolean isEnabled;
    private boolean overwrite;
    private str folderPath;

    [Hookable(false)]
    public str parmFolderPath(str _value = folderPath)
    {
        folderPath = _value;
        return folderPath;
    }

    [Hookable(false)]
    public boolean parmIsEnabled(boolean _value = isEnabled)
    {
        isEnabled = _value;
        return isEnabled;
    }

    [Hookable(false)]
    public boolean parmOverwrite(boolean _value = overwrite)
    {
        overwrite = _value;
        return overwrite;
    }

    [Hookable(false)]
    public void setEnabled(boolean _value)
    {
        isEnabled = _value;
    }

    [Hookable(false)]
    public boolean isEnabled()
    {
        return isEnabled;
    }

    [Hookable(false)]
    public str getName()
    {
        return 'Save in folder';
    }

    [Hookable(false)]
    public void validate()
    {
    }

    [Hookable(false)]
    public ERIFileDestination createDestination(ERDestinationExecutionContext _destinationContext, boolean _isGrouped)
    {
        ERFileDestinationFolder ret = new ERFileDestinationFolder();
        ret.parmFolderPath(this.parmFolderPath());
        ret.parmOverwrite(this.parmOverwrite());
        return ret;
    }

    [Hookable(false)]
    public str getKey()
    {
        return SettingsKey;
    }

    [Hookable(false)]
    public container pack()
    {
        return [CurrentVersion, isEnabled, folderPath];
    }

    [Hookable(false)]
    public boolean unpack(container packedClass)
    {
        int version = RunBase::getVersion(packedClass);
        switch (version)
        {
            case CurrentVersion:
                [version, isEnabled, folderPath] = packedClass;
                return true;
            default:
                return false;
        }
    }

    /// <summary>
    /// Creates a new instance of an objected from a packed class container.
    /// </summary>
    /// <param name = "_packedClass">A packed class container.</param>
    /// <returns>The new instance of an object.</returns>
    public static ERFormatDestinationSaveInFolderSettings create(container _packedClass)
    {
        var ret = new ERFormatDestinationSaveInFolderSettings();
        ret.unpack(_packedClass);
        return ret;
    }
}

メモ

上記のコードでは、ERFormatDestinationSaveInFolderSettings クラスが static クラスとして導入されます。実装オブジェクトには、オブジェクトを作成し、オブジェクトが正しくパックおよび展開プロセスに必要なコンテナーを展開する static create(container) メソッドが必要です。詳細についてはパック-アンパックデザインパターンを参照してください。

Visual Studio プロジェクトで、ERFormatDestinationSettings フォームに新しい拡張子を追加し、カスタム送信先のカスタム UI を実装するコードを記述します。次の図は、この UI が Visual Studio デザイナーでどのように表示されるかを示しています。

Visual Studio プロジェクトに新しいクラス (この例では、ERFormatDestinationSettingsEventHandlers) を追加し、拡張送信先フォームのイベントハンドラーコードを記述します。この手順は、パブリック ERIFormatFileDestinationSettingsStorage インターフェイスを実装する必要があります。

public class ERFormatDestinationSettingsEventHandlers
{
    [PostHandlerFor(formStr(ERFormatDestinationSettings), formMethodStr(ERFormatDestinationSettings, init))]
    public static void ERFormatDestinationSettings_Post_init(XppPrePostArgs args)
    {
        FormRun formRun = args.getThis();
        ERIFormatFileDestinationSettingsStorage settingsStorage = args.getThis();
        var settings = ERFormatDestinationSettingsEventHandlers::getSaveInFolderSettings(settingsStorage);

        FormStringControl folderPathControl = formRun.design().controlName(formControlStr(ERFormatDestinationSettings, SaveInFolder_FolderPath));
        folderPathControl.text(settings.parmFolderPath());

        FormCheckBoxControl enabledControl = formRun.design().controlName(formControlStr(ERFormatDestinationSettings, SaveInFolderEnable));
        enabledControl.checked(settings.isEnabled());

        FormCheckBoxControl overwriteControl = formRun.design().controlName(formControlStr(ERFormatDestinationSettings, SaveInFolder_Overwrite));
        overwriteControl.checked(settings.parmOverwrite());
    }

    [PreHandlerFor(formStr(ERFormatDestinationSettings), formMethodStr(ERFormatDestinationSettings, closeOk))]
    public static void ERFormatDestinationSettings_Pre_closeOk(XppPrePostArgs args)
    {
        FormRun formRun = args.getThis();
        ERIFormatFileDestinationSettingsStorage settingsStorage = args.getThis();
        var settings = ERFormatDestinationSettingsEventHandlers::getSaveInFolderSettings(settingsStorage);

        FormStringControl folderPathControl = formRun.design().controlName(formControlStr(ERFormatDestinationSettings, SaveInFolder_FolderPath));
        settings.parmFolderPath(folderPathControl.text());

        FormCheckBoxControl enabledControl = formRun.design().controlName(formControlStr(ERFormatDestinationSettings, SaveInFolderEnable));
        settings.setEnabled(enabledControl.checked());

        FormCheckBoxControl overwriteControl = formRun.design().controlName(formControlStr(ERFormatDestinationSettings, SaveInFolder_Overwrite));
        settings.parmOverwrite(overwriteControl.checked());
    }

    private static ERFormatDestinationSaveInFolderSettings getSaveInFolderSettings(ERIFormatFileDestinationSettingsStorage _settingsStorage)
    {
        ERFormatDestinationSaveInFolderSettings ret = _settingsStorage.getSettingsByKey(ERFormatDestinationSaveInFolderSettings::SettingsKey);
        if (ret == null)
        {
            ret = new ERFormatDestinationSaveInFolderSettings();
            _settingsStorage.addSettings(ret);
        }
        return ret;
    }
}

Visual Studio プロジェクトを再構築します。

作成またはインポートした ER 形式の ER の出力送信先を構成する

作成またはインポートした ER 形式について、前述のコンポーネント (ファイル、フォルダー、マージ、または添付ファイル) の 1 つに対してアーカイブ送信先を構成します。詳細については、ER ER コンフィギュレーション先を参照してください。
選択した ER 形式の同じコンポーネントについて、カスタムのフォルダーに保存の保存先を有効にして構成します。

メモ

AOS サービスを実行するサーバーのローカルファイルシステムに、指定したカスタム送信先フォルダー (この例では c:\0) が存在することを確認してください。それ以外の場合は、DirectoryNotFoundException 例外が実行時にスローされます。

作成またはインポートした ER フォーマットの実行

作成またはインポートした ER 形式を実行します。
組織管理 > 電子申告 > 電子申告ジョブに移動し、この実行ジョブに対して作成され、生成されたファイルが関連付けられているレコードを検索します。
ローカルの C:\0 フォルダーを参照して、生成ファイルを見つけます。

追加リソース

電子申告 (ER) 行先

電子申告10.0.19用のフレームワークAPI変更の更新

次の方法で共有

生成されるドキュメントに対するカスタム送信先の実装

必要条件

ER フォーマット構成の作成またはインポート

ソースコードの拡張

作成またはインポートした ER 形式の ER の出力送信先を構成する

作成またはインポートした ER フォーマットの実行

追加リソース

フィードバック

その他のリソース

次の方法で共有

生成されるドキュメントに対するカスタム送信先の実装

必要条件

ER フォーマット構成の作成またはインポート

ソース コードの拡張

作成またはインポートした ER 形式の ER の出力送信先を構成する

作成またはインポートした ER フォーマットの実行

追加リソース

フィードバック

その他のリソース

ソースコードの拡張