De-envelope a document (-DEENVELOPE) command

Edit online

The -DEENVELOPE (-DENV) command de-envelopes a document as specified in the Standards Processing Engine (SPE) database and returns a response from SPE in XML format.

The XML response file contains the document IDs of the de-enveloped documents. The metadata schema of the XML response file is defined by the wtx_install_dir\Response.xsd file.

-DEENVELOPE command syntax

>>-+- -DBURL-+--+-db_URL------+--+---------------------+-------->
   '- -DURL--'  '-db_cfg_file-'  +- -DBUSER--user_name-+   
                                 '- -U--user_name------'   

>--+--------------------+-- -DBDRIVER--driver_name-------------->
   +- -DBPSWD--password-+                            
   '- -P--password------'                            

>--+-------------------------+---------------------------------->
   '- -DBSCHEMA--schema_name-'   

>--+- -URL--file_URL--------------+--+- -DEENVELOPE-+----------->
   +-+- -DOCID-+--doc_ID----------+  '- -DENV-------'   
   | '- -ID----'                  |                     
   |               .-;--------.   |                     
   |               V          |   |                     
   '-+- -BATCH-+-+---file_URL-+-+-'                     
     '- -H-----' | .-;------.   |                       
                 | V        |   |                       
                 '---doc_ID-+---'                       

>--+--------+--+-----------+--+---------------+----------------><
   '- -KEEP-'  '- -ALLDOCS-'  '-data_from_map-'

-DBURL

-DURL: Identifies the SPE database by either the database URL or the file URL of a configuration file that contains the database connection information. If you specify a configuration file, the SPE adapter uses only the database connection information in the configuration file. The adapter ignores any -DBDRIVER, -DBUSER, -DBPSWD, or -DBSCHEMA keywords on the adapter command line. The -DBURL keyword is required.

-DBUSER

-U: Specifies the SPE database user name. The -DBUSER keyword is required only for certain types of databases.

-DBPSWD

-P: Specifies the SPE database password. The -DBPSWD keyword is required only for certain types of databases.

-DBDRIVER: Specifies the name of the JDBC driver that connects to the SPE database. The -DBDRIVER keyword is required for all database types.

-DBSCHEMA: Specifies the name of the SPE database schema. The -DBSCHEMA keyword is required only for certain types of databases.

-URL: Specifies the file URL of the document to de-envelope. A relative path for the file URL resolves to the directory of the map that invokes the -DEENVELOPE command. The -URL keyword is optional, but you must specify one of the -URL, -DOCID, -BATCH or data_from_map options.

-DOCID

-ID: Specifies the document ID of a single document to de-envelope. The -DOCID keyword is optional, but you must specify one of the -URL, -DOCID, -BATCH or data_from_map options.

-BATCH

-H: Specifies a list of documents to de-envelope with semi-colon-delimited (;) file URLs or document IDs. The -BATCH keyword is optional, but you must specify one of the -URL, -DOCID, -BATCH or data_from_map options.

-KEEP: Retains the documents that are returned in the SPE response. The SPE adapter stores the documents in the local file system and uses the document ID as the file name. The -KEEP keyword is optional. If you omit it, the SPE adapter does not save documents after the map or card transaction completes.

-ALLDOCS: Specifies that SPE is to return all documents in the XML response file, including type=INTERMEDIATE documents. The -ALLDOCS keyword is optional. If you omit it, SPE returns only type=FINAL documents in the XML response file.

data_from_map: Specifies the data bytes to be de-enveloped. The data_from_map bytes are returned from the third parameter of a GET function in the map.