FP_SMTP_SET_MODE_TRANSFER_LOG

データロギングファイルのSMTP転送モードの設定

このFP命令は、データロギングファイルが完了したときのメールのSMTPクライアント転送設定を定義します。

パラメータ

入力

nLogID (WORD, INT, UINT)

LOG番号(指定可能範囲: 0~15)。コンパイラは、ログファイル番号用の文字列を内部で生成します。例. 'LOG=0'

sGroupNumber_Subject (STRING)

宛先グループ番号とメールの件名を設定します。

キーワード構文'GRPNO=n1+n2+…+n8'を使用して、最大8つの宛先グループ番号を設定します。

値:0～7

次の2つのキーワード設定のいずれかを使用して件名を設定します(1バイト文字で最大64文字)。

'SUBJECT=xxxxxx': ユーザー定義の件名を設定します。

'SUBJECTAUTO': 送信トリガ種類に関する情報を含む、自動生成された件名。

自動生成された件名:

日本語	英語
ロギング／トレース (LOG0)	Logging/Trace (LOG0)
ロギング／トレース (LOG1)	Logging/Trace (LOG1)
...	...
ロギング／トレース (LOG14)	Logging/Trace (LOG14)
ロギング／トレース (LOG15)	Logging/Trace (LOG15)

注：

自動生成された情報に使用される言語は、命令FP_SMTP_SET_CONNECTIONで指定されます。パラメータsCommunicationを使用して、言語を日本語(デフォルト)から英語に切り替えます。
キーワード'GRPNO'と'SUBJECT'は、カンマで区切り、この順序で入力する必要があります。

変換例:

宛先グループ番号0、ユーザー定義件名「LogFileTransmission」： 'GRPNO=0,SUBJECT=LogFileTransmission'
宛先グループ番号1、3、4、7、ユーザー定義件名「LogFilesGroups」： 'GRPNO=1+3+4+7,SUBJECT=LogFilesGroups'
宛先グループ番号0~7、自動生成された件名: 'GRPNO=0+1+2+3+4+5+6+7,SUBJECTAUTO'

sBodyText (STRING)

メッセージ(1バイト文字で最大256文字)

メール本文または文字定数が格納されている変数を指定します。

sAttachment (STRING)

付加情報または添付ファイルを送信するかどうかを指定します。

次のいずれかのキーワード設定を使用して、メール本文に付加情報を含めます。

'INFO=NONE'：情報を自動的に付加しません
'INFO=AUTO': 自動生成テキストを付加します

次の情報がメール本文に付加されます。

日本語	英語
基本項目送信元 CPU 型番（例：CPS41E） IPv4 アドレス IPv6 アドレスロギングトレース(ID 番号) ファイル確定時刻	Basic information From CPU Part number (例：CPS41E) IPv4 address IPv6 address Logging Trace ID File fixed Time

日本語

英語

基本項目

送信元
CPU 型番（例：CPS41E）
IPv4 アドレス
IPv6 アドレス
ロギングトレース(ID 番号)
ファイル確定時刻

Basic information

From
CPU Part number (例：CPS41E)
IPv4 address
IPv6 address
Logging Trace ID
File fixed Time

注：

自動生成された情報に使用される言語は、命令FP_SMTP_SET_CONNECTIONで指定されます。パラメータsCommunicationを使用して、言語を日本語(デフォルト)から英語に切り替えます。
sAttachmentの文字列を生成する際、FP_SMTP_GET_DATA_FORMATを使用することもできます。

次のキーワード設定を使用して、データロギングファイル(LOGファイル)を添付します。

'ATT=NONE'：LOGファイルをメールに添付しません。
'ATT=FILE'：nLogIDで指定された番号のLOGファイルを添付します。

変換例:

情報を付加せず、LOGファイルを添付しない場合： 'INFO=NONE,ATT=NONE'
自動生成された情報を付加し、LOGファイルを添付する場合： 'INFO=ADD,ATT=FILE'

出力

bError (BOOL)

以下の条件でTRUEになります。

接続のタイムアウトが経過した場合
IPアドレスが無効な場合

エラーが発生した場合は、エラーコード番号のシステム変数sys_iEthernetConnectionErrorCodeを確認してください。

解説

テキスト自動生成とファイル添付のパラメータは省略することはできません。
すべてのキーワードは、カンマで区切って登録します。例. 'NAME=abcd,FROM=sender@server.com'
キーワードの順序を変更しないでください。キーワードと設定パラメータはここに記載されている順序で記述してください。
文字列データは、256文字以内にする必要があります。
この命令は、割り込みプログラム中で使用することはできません。
命令を実行する前に、FP_SMTP_SET_CONNECTIONまたはSMTPクライアントの設定ダイアログを使用してメール転送サーバーを指定する必要があります。
命令を実行する前に、FP_SMTP_SET_GROUPまたはSMTPクライアントの設定ダイアログを使用してグループおよびイベントメール設定を指定する必要があります。
指定するキーワードは、大文字、小文字とも使用することができます。ただし、件名、メール本文、添付ファイルのファイル名では大文字と小文字が区別されます。
命令を実行する前にsys_bIsEthernetInitializingがFALSEであることを確認してください。命令が実行されるとsys_bIsEthernetInitializingはTRUEになります。sys_bIsEthernetInitializingがTRUEのときに命令を実行すると、エラーが発生します。
この命令が正常に実行されると、システム変数sys_bIsCarryおよびsys_iEthernetConnectionErrorCodeがリセットされます。
命令は、指定したnLogID番号の転送要求フラグがFALSEの場合にのみ実行することができます。転送要求フラグがTRUEの場合、演算エラーが発生します。
命令は、nLogIDに指定されたLOGファイル番号について、sGroupNumber_Subject、sBodyText、sAttachmentのデータロギング用のメール設定を格納します。
エラーが発生した場合は、エラーコード番号のシステム変数sys_iEthernetConnectionErrorCodeを確認してください。

エラーフラグ

sys_bIsOperationErrorHold (TRUEになり、TRUEを保持)

指定したnLogID番号の転送要求フラグがTRUEの場合。例：sys_blsLog0DataRecordingActiveがTRUEの場合。
nLogIDで指定された番号のデータロギング条件が登録されていない場合。
パラメータに指定された値が許容範囲外の場合。
命令が割り込みプログラム内で実行された場合。
文字列データが256文字を超えた場合。
宛先グループ番号が命令FP_SMTP_SET_GROUPで定義されても、SMTPクライアントの設定ダイアログで指定されてもいない場合。
メール転送サーバーが指定されていない場合。
メール転送サーバーが命令FP_SMTP_SET_CONNECTIONで指定されても、SMTPクライアントの設定ダイアログで指定されてもいない場合。

sys_bIsOperationErrorNonHold (1回のスキャンに対してTRUE)

指定したnLogID番号の転送要求フラグがTRUEの場合。例：sys_blsLog0DataRecordingActiveがTRUEの場合。
nLogIDで指定された番号のデータロギング条件が登録されていない場合。
パラメータに指定された値が許容範囲外の場合。
命令が割り込みプログラム内で実行された場合。
文字列データが256文字を超えた場合。
宛先グループ番号が命令FP_SMTP_SET_GROUPで定義されても、SMTPクライアントの設定ダイアログで指定されてもいない場合。
メール転送サーバーが指定されていない場合。
メール転送サーバーが命令FP_SMTP_SET_CONNECTIONで指定されても、SMTPクライアントの設定ダイアログで指定されてもいない場合。

sys_bIsCarry (1回のスキャンに対してTRUE)

Ethernet初期化中に命令を実行した場合は、sys_iEthernetConnectionErrorCodeが「11：Ethernet初期化中」に設定されます。

例

POUヘッダ

POUヘッダには、このプログラムで使用するすべての入力変数と出力変数を宣言します。 POUヘッダは全プログラム言語で使用できます。

	VAR
		bIsError: BOOL:=FALSE;
		bSetLogTransferSMTP: BOOL:=FALSE;
		bDisableLogTransferSMTP: BOOL:=FALSE;
	END_VAR

POUボディ

bSetLogTransferSMTPとbDisableLogTransferSMTPがTRUEにセットされると、命令が実行されます。

LDボディ

BODY
    WORKSPACE
        NETWORK_LIST_TYPE := NWTYPELD ;
        ACTIVE_NETWORK := 0 ;
    END_WORKSPACE
    NET_WORK
        NETWORK_TYPE := NWTYPELD ;
        NETWORK_LABEL :=  ;
        NETWORK_TITLE :=  ;
        NETWORK_HEIGHT := 7 ;
        NETWORK_BODY
B(B_VARIN,,0,19,2,21,4,);
B(B_VARIN,,'GRPNO=0~SUBJECTAUTO',19,3,21,5,);
B(B_VARIN,,'Sent Log Files',19,4,21,6,);
B(B_VARIN,,'INFO=NON~ATT=NONE',19,5,21,7,);
B(B_VAROUT,,bIsError,39,2,41,4,);
B(B_CONTACT,,bSetLogTransferSMTP,5,1,7,3,);
B(B_F,FP_SMTP_SET_MODE_TRANSFER_LOG!,,21,0,39,7,,?DEN?DnLogID?DsGroupNumber_Subject?DsBodyText?DsAttachment?AENO?AbError);
L(1,2,5,2);
L(7,2,21,2);
L(1,0,1,7);
        END_NETWORK_BODY
    END_NET_WORK
    NET_WORK
        NETWORK_TYPE := NWTYPELD ;
        NETWORK_LABEL :=  ;
        NETWORK_TITLE :=  ;
        NETWORK_HEIGHT := 5 ;
        NETWORK_BODY
B(B_CONTACT,,bDisableLogTransferSMTP,5,1,7,3,);
B(B_F,FP_SMTP_TRANSFER_CONTROL_LOG!,,21,0,39,5,,?DEN?DnLogID?DsControl?AENO?AbError);
B(B_VARIN,,0,19,2,21,4,);
B(B_VARIN,,'DISABLE',19,3,21,5,);
B(B_VAROUT,,bIsError,39,2,41,4,);
L(1,2,5,2);
L(7,2,21,2);
L(1,0,1,5);
        END_NETWORK_BODY
    END_NET_WORK
END_BODY

STボディ

If (bSetLogTransferSMTP) Then
    FP_SMTP_SET_MODE_TRANSFER_LOG(nLogID := 0,
                                  sGroupNumber_Subject := 'GRPNO=0,SUBJECTAUTO',
                                  sBodyText := 'Sent Log Files', 
								  sAttachment := 'INFO=NON,ATT=NONE', bError => bIsError);
End_if;
If (bDisableLogTransferSMTP) Then
    FP_SMTP_TRANSFER_CONTROL_LOG(nLogID := 0,
                                 sControl := 'DISABLE', bError => bIsError);
End_if;