共通マクロ書式

読み取りデータ書式 | シンボル情報取得書式 | 配信先取得書式 | 処理結果取得書式 | ユーザデータ書式 |
グローバルデータ書式 | プラグインデータ書式 | 日付書式 | ファイル名書式 | 文字列書式 |
数学書式
| 制御書式 | 実行書式 | データベース書式 | DocuWorksAPI書式 | ブラウザフォーム書式

読み取りデータ書式

プレーンデータ取得
{%P_DATA(設定名.番号)}

QRコード読み取りで取得した文字、又は、OCR読み取りで取得した指定タグの文字を返却します。
この書式1では、取得した文字、全てが返却されます。(プレーンデータ)

設定名には、QRコード読み取り、OCR読み取り、アノテーション読み取り、マクロ実行等の設定名を記述します。設定名のあとに続けて.数字を記述します。

番号は、読み取った処理での何番目に取得した文字かを指定します。

例えば、QRコードが1ページの中に2つ存在した場合、この数字は、1番目に見つけたQRコードなのか、2番目に見つけたQRコードなのかを指定することになります。QRコードを読み取る順は、左上から右下の順になります。

OCR処理の読み取り結果であれば、識別タグで取り出した文字や、正規表現で取り出した文字が取得できます。

実行時に指定した番号の文字が存在しない場合はエラーになります。

例1
処理名「QRコード読み取り1」で検出した内容が「ZX0001」の場合
{%P_DATA(QRコード読み取り1.1)}.xdw -> ZX0001.xdw
名前付きデータ取得
{%N_DATA(設定名.名前)}

QRコード読み取りで取得した文字、又は、OCR読み取りで取得した指定タグの文字を返却します。
この書式2では、下記のルールで名前を付けた文字から、指定の名前の文字を返却します。(名前付きデータ)
したがって、QRコードの内容があらかじめ下記のルールに従った文字になっている必要があります。

名前1[データ1]
名前2[データ2]

例えば、「{%N_DATA(QRコード読み取り1.名前1)}」と指定した場合、「データ1」が返却されます。

設定名には、QRコード読み取り又は、OCR読み取りの設定名を記述します。設定名のあとに続けて.名前を記述します。実行時に指定した名前の文字が存在しない場合はエラーになります。

例1
処理名「QRコード読み取り1」で検出した内容が「name[山田] age[21]」の場合
{%N_DATA(QRコード読み取り1.name)} -> 山田
{%N_DATA(QRコード読み取り1.age)} -> 21
NAME プレーンデータ設定
FORMAT {%SET_P_DATA(設定名,ページ,データ[,番号])}

読み取り結果に任意のデータを書き込むことができます。
文書移動やコピー処理で、分割するページを任意に指定したい場合などに使用します。

例1
文書を1ページ目と2ページ目以降で分割することを目的としたデータを作成する場合
{%IF({%DW_TOTAL_PAGE}>1,
{%SET_P_DATA(マクロ実行1,1,1Page)}
{%SET_P_DATA(マクロ実行1,2,2PageAfter)}
,
{%SET_P_DATA(マクロ実行1,1,1PageOnly)}
)}

このマクロ実行の次の処理に、文書移動やコピーを設定し、「QRコード又は検出文字の検出ページで文書を分割する」にチェックをいれ、対象処理名にこのマクロ実行の処理名を選択すると、文書が分割されます。
また、ファイル名をリネームするにチェックをいれ、ファイル名に
「{%P_DATA(マクロ実行1.1)}.xdw」と記述すると、上記マクロで指定した、3番目の引数が名前になります。

NAME プレーンデータ存在チェック
FORMAT {%P_EXISTS(設定名.番号)}

QRコード読み取り、又は、OCR読み取りでデータが取得できたかどうかをチェックします。データが存在する場合は、「True」を、存在しない場合は、「False」を返却します。

例1
処理名「OCR読み取り1」で1番目に検出した内容が「山田」の場合
{%P_EXISTS(OCR読み取り1.1)} -> True
NAME 名前付きデータ存在チェック
FORMAT {%N_EXISTS(設定名.名前)}

QRコード読み取りで取得した文字、又は、OCR読み取りで取得した指定タグの名前が存在するかチェックします。指定した名前が存在する場合は、「True」を、存在しない場合は、「False」を返却します。

主に、文書コピー、文書移動、コマンド実行の条件欄に使用します。

例1
処理名「QRコード読み取り1」で検出した内容が「name[山田] age[21]」の場合
{%N_EXISTS(QRコード読み取り1.name)} -> True
{%N_EXISTS(QRコード読み取り1.age)} -> True
{%N_EXISTS(QRコード読み取り1.address)} -> False

シンボル情報取得書式

NAME シンボル位置取得
FORMAT {%SYMBOL_POSITION(設定名.番号,位置,座標)}

QRコード読み取りで取得したシンボル(QRコード)の検出位置を取得します。取得できる情報は、シンボルの左上,右上,左下,右下のX,Y座標です。

番号には、検出したQRコードの番号を指定できます。
位置には、左上,右上,左下,右下の何れかを指定します。
座標には、X,Yの何れかを指定します。

例1
処理名「QRコード読み取り1」で1番目に検出したシンボルの左上のX座標を取得する場合
{%SYMBOL_POSITION(QRコード読み取り1.1,左上,X)}
シンボル角度取得
{%SYMBOL_ANGLE(設定名.番号)}

QRコード読み取りで取得したシンボル(QRコード)の角度(左回りで90度単位)を取得します。

番号には、検出したQRコードの番号を指定できます。
返却値を DW_ROTATE_PAGE マクロの引数にそのまま渡して、自動正立を行うことが可能です。
結果は0, 90, 180, 270 の何れかの数値が返却されます。

例1
処理名「QRコード読み取り1」で検出した1番目のシンボルの角度を取得する場合
{%SYMBOL_ANGLE(QRコード読み取り1.1)}
シンボル数取得
{%SYMBOL_COUNT(設定名)}

QRコード読み取りで取得したシンボル(QRコード)の検出個数を取得します。

例1
処理名「QRコード読み取り1」で検出したシンボルの個数を取得する場合
{%SYMBOL_COUNT(QRコード読み取り1)}
シンボル検出ページ取得
{%SYMBOL_PAGE(設定名.番号)}

QRコード読み取りで取得したシンボル(QRコード)の検出ページを取得します。

番号には、検出したQRコードの番号を指定できます。

例1
処理名「QRコード読み取り1」で1番目に検出したシンボルのページ数を取得する場合
{%SYMBOL_PAGE(QRコード読み取り1.1)}
シンボル連結情報取得
{%SYMBOL_CONCATENATION(設定名.番号,項目名)}

QRコード読み取りで取得したシンボル(QRコード)の連結情報を取得します。

番号には、検出したQRコードの番号を指定できます。

項目名には、「SEQ_NUMBER」、「TOTAL_NUMBER」、「CHECK_DIGIT」の何れかを指定できます。

「SEQ_NUMBER」を指定した場合、連結番号を取得します。例えば、3個で構成されたQRコードの1番目のQRコードの場合は「1」となります。

「TOTAL_NUMBER」を指定した場合、連結個数を取得します。例えば、3個で構成されたQRコードの場合は「3」となります。

「CHECK_DIGIT」を指定した場合、分割前のデータのXORによるチェックサムパリティ(8ビット)が16進文字列で返却されます。

QRコードが分割されていない場合は、全て「0」が返却されます。

例1
処理名「QRコード読み取り1」で1番目に検出したシンボルの連結情報を取得する場合
{%LOG_OUT(SEQ_NUMBER:{%SYMBOL_CONCATENATION(QRコード読み取り1.1,SEQ_NUMBER)})}
{%LOG_OUT(TOTAL_NUMBER:{%SYMBOL_CONCATENATION(QRコード読み取り1.1,TOTAL_NUMBER)})}
{%LOG_OUT(CHECK_DIGIT:{%SYMBOL_CONCATENATION(QRコード読み取り1.1,CHECK_DIGIT)})}

配信先取得書式

NAME 移動、コピー先パス取得
FORMAT {%FILE_TO(設定名.番号)}

文書コピー、又は文書移動で、実際にコピー、又は移動を行った後のフルパスファイル名を取得します。

番号には、コピー、又は移動を行ったファイルの番号を指定できます。

例1
処理名「文書移動1」で1番目に移動したファイルのフルパスファイル名を取得する場合
{%FILE_TO(文書移動1.1)}
NAME 移動、コピー先数取得
FORMAT {%FILE_TO_COUNT(設定名)}

文書コピー、又は文書移動で、実際にコピー、又は移動を行ったファイルの数を取得します。文書の分割を行った場合に、分割の数と同じ値になります。(移動後のファイルが同名になった場合でも、1つと数えます。)

例1
処理名「文書移動1」で移動したファイルの個数を取得する場合
{%FILE_TO_COUNT(文書移動1)}

処理結果取得書式

NAME DocuWorks文書変換の処理結果取得
FORMAT {%DW_CREATE_DW_RESULT(DocuWorks文書変換設定名)}

DocuWorks文書変換の処理結果を取得します。引き数で指定されたDocuWorks文書変換設定の処理が成功した場合はTrue、失敗した場合はFalseが返却されます。

例1
処理名「DocuWorks文書変換1」の処理結果を取得する。
{%DW_CREATE_DW_RESULT(DocuWorks文書変換1)}