Name

DECEDI_FETCH − This enables the caller to fetch one or more files from the DEC/EDI Server. These files may have come directly from the Communications Service, through the translator, or from the mapper. 

 
The type of file being fetched must be specified, and can be one of the following:
 
 

•Application_file -- files are fetched from the Mapper on the Server.  These files are also known as structured files. 
 
 

•Transmission_file -- files are fetched from the Communications Service on the Server, bypassing any translation or mapping. These files are also known as unstructured files. 
 
 

•Document -- files are fetched from the Translation Service on the Server. These files are also known as ’ihf’ files. 
 
 
 
 
 
 
 

C Binding

 #include    <decedi_api_def.h>
 unsigned long int DECEDI_FETCH (application,
                                overrides,
                                test_indicator,
                                relationship_flag,
                                files)
 char                          ∗application;
decedi_t_item_list            overrides;
unsigned long int             ∗test_indicator;
unsigned long int             ∗relationship_flag;
decedi_t_item_list            files;

Arguments

application
The name of the client application submitting the request to the Server.  This is a null-terminated character string. This argument is used by DEC/EDI as a means of authenticating the request; the client application must be registered as an authorized application on the Server. Applications are registered by using the CommandCenter Services Editor. For more information, refer to DEC/EDI Configuring.
 

overrides
An item list specifying the overrides to apply to all files in this request. Build the item list by using one or more calls to DECEDI_ADD_ITEM_LIST. Valid item identifier values for the item list are shown in Table 1.
 

Note that there are ’File overrides’ in addition to these command overrides.  The File overrides apply to each specific file fetched, whereas command overrides apply to the entire command. See the ’files’ argument for further information. 
 
 

Table 1: DECEDI_FETCH Override Item Identifiers

test_indicator
A returned flag indicating the test indicator of the selected files. The valid values for this flag are shown in Table 2.
 

Table 2: Values for Test Indicator

Note that only one test indicator type can be returned per call. 
 

relationship_flag
Not currently used.
 

files
An item list specifying the files to be fetched in this request. Build the item list using one or more calls to DECEDI_ADD_ITEM_LIST. The valid item identifier values for the item list are shown in Table 3.
 

Note that the DECEDI_ITM_FILE_NAME must be the first file item for each file. 
 

Table 3: DECEDI_FETCH File Override Identifiers

Table 4: Values for DECEDI_FETCH File

Table 5: Values for Match Flag

Table 6: Return Values for DECEDI_FETCH

Description

 
This routine issues a request to the Server to fetch one or more files from the Server. It then waits for the Server to fulfill the request and return the results.
 

 
Construct the request using one or more calls to DECEDI_ADD_ITEM_LIST. Once this call has been completed, use DECEDI_FREE_ITEM_LIST to release the associated item lists.
 
 

Return Values

DECEDI_BADITMLST
The request was rejected because the call had invalid, or missing item lists.
 

DECEDI_BADPARAM
The request was rejected because the call had invalid, or missing parameters.
 

DECEDI_INSUFVMInsufficient virtual memory available to complete request. 
 

DECEDI_INTERROR
Internal error
 

DECEDI_NOCLIENTLIC
No active client license present
 

DECEDI_NOEDISYSEDI server system not running
 

DECEDI_NOTAUTHNot authorized to access the EDI server system
 

DECEDI_OPENINPERR
Could not open one of the input files
 

DECEDI_OPENOUTERR
Could not open one of the output files
 

DECEDI_ORBBADNODE
Bad server selection node
 

DECEDI_ORBBUSYObjectBroker busy. 
 
 

DECEDI_ORBCOMMFAIL
Communications to server failed.
 

DECEDI_ORBDOWN
ObjectBroker not running
 

DECEDI_ORBERROR
ObjectBroker failure
 

DECEDI_ORBSAKERR
ObjectBroker "SAK" error.
 

DECEDI_ORBSRVDIED
Server process died
 

DECEDI_ORBSRVNOTFND
No server found
 

DECEDI_ORBTIMEOUT
Server timeout
 

DECEDI_ORBVERMISM
ObjectBroker version mismatch
 

DECEDI_SRVERROR
Server error
 

DECEDI_SUCCESSThe request was successfully processed by the server. 
 

DECEDI_WARNINGNot all the request was successfully processed.  Check the individual file statuses. 
 

DECEDI_ZEROMATCH
No records matched
 
 
 
 

Example

 #include    <decedi_api_def.h>
 unsigned long int status;
decedi_t_item_list item_list = (decedi_t_item_list) NULL;
decedi_t_ulong file_status;
unsigned long int test_indicator;
unsigned long int relationship;
  status = DECEDI_ADD_ITEM_LIST (&item_list,
               (unsigned long int) DECEDI_ITM_FILE_NAME,
               (unsigned long int) DECEDI_STRING,
               (unsigned long int) strlen("test_file.dat"),
               (char ∗) "test_file.dat",
               (unsigned long int) DECEDI_READ_ONLY);
if (status != DECEDI_SUCCESS)
{
}
 status = DECEDI_ADD_ITEM_LIST (&item_list,
                          (unsigned long int) DECEDI_ITM_PARTNER_NAME,
                          (unsigned long int) DECEDI_STRING,
                          (unsigned long int) strlen("THEIR-APPLICATION"),
                          (char ∗) "THEIR-APPLICATION",
                          (unsigned long int) DECEDI_READ_ONLY);
 if (status != DECEDI_SUCCESS)
{
}
 status = DECEDI_ADD_ITEM_LIST (&item_list,
                               (unsigned long int) DECEDI_ITM_TRACKING_REF,
                               (unsigned long int) DECEDI_STRING,
                               (unsigned long int) strlen("INVOICE #1234"),
                               (char ∗) "INVOICE #1234",
                               (unsigned long int) DECEDI_READ_ONLY);
 if (status != DECEDI_SUCCESS)
{
}
 status = DECEDI_ADD_ITEM_LIST (&item_list,
                               (unsigned int) DECEDI_ITM_TABLE_NAME,
                               (unsigned int) DECEDI_STRING,
                               (unsigned int) strlen("MY_MAP"),
                               (char ∗) "MY_MAP",
                               (unsigned long int) DECEDI_READ_ONLY);
 if (status != DECEDI_SUCCESS)
{
}
 status = DECEDI_ADD_ITEM_LIST (&item_list,
                               (unsigned long int) DECEDI_ITM_RETURN_STATUS,
                               (unsigned long int) DECEDI_UINTEGER,
                               (unsigned long int) sizeof(file_status),
                               (char ∗) &file_status,
                               (unsigned long int) DECEDI_WRITEABLE);
 if (status != DECEDI_SUCCESS)
{
}
 status = DECEDI_FETCH ( "MY-APPLICATION",          /∗ Application name ∗/
                        (decedi_t_item_list) NULL, /∗ Overrides ∗/
                        &test_indicator,           /∗ Test Indicator ∗/
                        &relationship,             /∗ Relationship ∗/
                        item_list);                /∗ Files to be fetched ∗/
 status = DECEDI_FREE_ITEM_LIST(&item_list);