4.5.1 Conversation Parameter

The responseDataFileSetCode parameter influences the standard request-response mechanism for an activity, it is therefor referred to as a conversation parameter.

As is the case with any activity parameters, conversation parameters can only be used if they are defined for the activity type. The following is an example of a start activity request that makes use of the responseDataFileSetCode parameter:

<activity level="" code="">
  <parameters>
    <parameter name="responseDataFileSetCode" value="RESPONSE_DFS"/>
  </parameters> 
</activity>

Assuming that the parameters and values are valid, the request in this example creates an activity. As part of the execution a response data file set with code "RESPONSE_DFS" is created. The response to the status monitoring requests i.e. get activity status and the call back response (<resultDataFileset > element will be added to the above response) will have the following structure:

Response Message

<activity level="" status="">  
   <links>    
     <link rel='messages' href='/activities/{activityid}/messages'/>
     <link rel='file' href='datafilesets/{datafilesetcode}/datafile/{datafilecode}/data'/>
   </links>
</activity>

The response file can be downloaded by using "Get details of a data file"  request from data file integration point : URI : datafilesets/{datafilesetcode}/datafile/{datafilecode}/data should be use to initiate a request to download the response file. 

The response file will have the following structure:

<{rootElelement}>
  <resultMessages result="" elementId="">    
     <resultMessage 
       code =""
      >
      Text Message
    </resultMessage>
  </resultMessages>  
</{rootElelement}>

The {rootElelement} for the response file is described in the activity type.

4.5.1.1 Error Messages

The following error messages, that are specific to the activity integration point may be returned in the response messages:

Message code	Scenario	Message	Severity
ACT-IP-ACTY-001	Create or Create & Start activity	Activity code {0} is unknown	Fatal
ACT-IP-ACTY-002	Create or Create & Start activity	Activity type level {0} is unknown	Fatal
ACT-IP-ACTY-003	Create or Create & Start activity	Parameter set code {0} is unknown	Fatal
ACT-IP-ACTY-004	Status monitoring and get result messages	Activity Id {0} is unknown	Fatal
ACT-IP-ACTY-005	Create or Create & Start activity	Use either a parameter set or parameters but not both	Fatal

4.5.1.2 Examples

4.5.1.2.1 Create or Start Activity request - SELECT_TRANSACTIONS_IN_SET

<activity
  level="GL"  
  code="SELECT_TRANSACTIONS_IN_SET" 
  description="Select processed transaction in a new set"> 
    <parameters> 
     <parameter   name="financialTransactionSetCode" value="FINANCIALTRANSACTIONSRUN_20141107"/> 
     <parameter   name="financialTransactionSetDescr" value="Financial transactions set for Nov-07, 2014"/> 
     <parameter   name="transactionCreatedDateFrom" value="2010-01-01"/>   
     <parameter   name="transactionCreatedTimeFrom" value="0800"/>
     <parameter   name="transactionCreatedDateTo" value="2014-11-06"/> 
     <parameter   name="transactionCreatedTimeTo" value=""/>
     <parameter   name="paymentDueDateFrom" value="2010-01-01"/>  
     <parameter   name="paymentDueDateTo" value="2014-11-14"/> 
     <parameter   name="includeUnfinalized" value="Y"/>    
     .....
   </parameters> 
</activity>

4.5.1.2.2 Create or Start Activity request - SUPERSEDE

<activity
  level="TS"  
  code="SUPERSEDE" 
  description="Supersede applicable transaction in the set FINANCIALTRANSACTIONSRUN_20141107"> 
    <contextFields> 
      <contextField  
        name="transactionSet"  
        value="FINANCIALTRANSACTIONSRUN_20141107"/> 
    <contextFields>   
</activity>

4.5.1.2.3 Create or Start Activity request - PROVIDER_IMPORT 

<activity
  level="GL"  
  code="PROVIDER_IMPORT" 
  description="Processed data file set 001V11"> 
   <parameters> 
     <parameter   name="dataFileSetCode" value="001V11"/> 
     <parameter   name="responseDataFileSetCode" value="response001V11"/> 
   </parameters>    
</activity>