pacs.009.001.08 mapper

The pacs.009 (pacs.009.001.08) mappers are used by T2 for sending and receiving FI to FI credit transfer (FICdtTrf) messages between RTGS and FTM for High Value Payments.

Overview

The pacs.009 mappers are a pair of inbound and outbound mappers.

pacs.009 inbound mapper: This mapper maps the FICdtTrf messages to ISF messages. The default mapper name is Pacs009ToISFMapper.
pacs.009 outbound mapper: This mapper maps the ISF messages to FICdtTrf messages. The default mapper name is ISFToPacs009Mapper.

The details of the mapping specification for these mappers are in separate documentation that is included in the documentation fix pack for High Value Payments. For more information about getting the documentation fix pack, see FTM support links for High Value Payments.

The inbound and outbound pacs.009 mappers can also be used along with the High Value Payments business application header mapper or the ISO message router mapper. For more information, see High Value Payments business application header mapper and ISO message router mapper.

Inbound mapper

The CONFIG=entry channel parameter is required for the inbound mapper. The mapper uses this parameter to locate the <msgTypeCfg> entry with a <type> child element that contains pacs.009.* in the value table. The <msgTypeCfg> entry contains the configuration parameters for the inbound mapper.

For example, the default Message From Target2 channel is configured with a CONFIG=HVP_MAP_CFG_MSG_FROM_TARGET2 parameter. When a pacs.009.001.08 message is received, the mapper searches the value table to find the <msgTypeCfg> entry to use for the message. It searches for a value table entry that meets the following conditions.

The category is HVP_MAP_CFG_MSG_FROM_TARGET2.
The <msgTypeCfg> entry has a <type> child element with the value of pacs.009.*.

If the <msgTypeCfg> entry cannot be found, the mapper causes an exception to report a subType not found error.

The default <msgTypeCfg> entry for HVP_MAP_CFG_MSG_FROM_TARGET2 is shown in the following example.

<msgTypeCfg>
   <class>PACS009</class>
   <subType>HVP_FROM_CSM_INSTR_FI</subType>
   <extendedCfg>
      <name>MASTER_FLAG</name>
      <value>Y</value>
   </extendedCfg>
   <extendedCfg>
      <name>BAT_FOR_SINGLE_TXN</name>
      <value>Y</value>
   </extendedCfg>
   <bat>
      <class>PACS009</class>
      <subType>HVP_FROM_CSM_INSTR_FI</subType>
   </bat>
   <pt>
      <class>PACS009</class>
      <subType>HVP_FROM_CSM_INSTR_FI</subType>
   </pt>
   <mapName>Pacs009ToISFMapper</mapName>
   <type>pacs.009.*</type>
</msgTypeCfg>

The following table shows the values from the <msgTypeCfg> entry that are used as configuration parameters by the inbound mapper.

Table 1. Values from `<msgTypeCfg>` that are used as configuration parameters by the inbound mapper
Element	Description
`<class>`	The value from this element is used as the value for TXN_PAYMENT_V.OBJ_CLASS.
`<subType>`	The value from this element is used as the value for TXN_PAYMENT_V.SUBTYPE and ISFMessage/Header/BusinessConcept.
`<extendedCfg>` element that has a `<name>` child element with the value MASTER_FLAG.	The value from the associated `<value>` child element is used as the value for MASTER_FLAG for TXN_PAYMENT_V and TRANSMISSION_V.
`<extendedCfg>` element that has a `<name>` child element with the value BAT_FOR_SINGLE_TXN.	The value from the associated `<value>` child element indicates whether a batch is created when the message contains one transaction. The default value is N if the element was not specified.
`<pt>`	The value from the `<class>` child element is used as the value for TRANSMISSION_V.OBJ_CLASS.
`<pt>`	The value from the `<subType>` child element is used as the value for TRANSMISSION_V.SUBTYPE.
`<bat>`	The value from the `<class>` child element is used as the value for BATCH_V.OBJ_CLASS.
`<bat>`	The value from the `<subType>` child element is used as the value for BATCH_V.SUBTYPE.

The following table shows the default configuration parameters for channels that use the pacs.009 inbound mapper.

Table 2. Default configuration parameters for channels that use the pacs.009 inbound mapper
Category	Class	SubType	MASTER_FLAG	Pt.class	Pt.subType
`HVP_MAP_CFG_MSG_FROM_TARGET2`	`PACS009`	`HVP_FROM_CSM_INSTR_FI`	`Y`	`PACS009`	`HVP_FROM_CSM_INSTR_FI`
`HVP_MAP_CFG_REQ_FROM_CHAN`	`PACS009`	`HVP_FROM_DBTR_INSTR_FI`	`Y`	`PACS009`	`HVP_FROM_DBTR_INSTR_FI`

The inbound mapper handles the datetime elements by using the following rules.

If a time zone offset is included in the datetime value, the datetime value is mapped to ISF with the UTC time zone.
If a time zone offset is not included in a datetime value, the following rules are used.
- If the time zone is configured in the Channel table, the input datetime value is recognized in the format of the channel time zone. It is mapped to ISF with the UTC time zone.
- If the time zone is not configured in the Channel table, the input datetime value is recognized in the format of the local time zone where the mapper is running. The input datetime is mapped to ISF with the UTC time zone.

Outbound mapper

The CONFIG=entry channel parameter is required for the outbound mapper. The mapper uses this parameter to locate the <msgTypeCfg> entry with a <subType> child element that contains the same value as the ISF business concept. The <msgTypeCfg> entry contains the configuration parameters for the outbound mapper.

When the outbound mapper is used along with the T2 message router mapper or ISO message router mapper, it uses a different method to find the <msgTypeCfg> entry in the value table. The mapper uses the setting that is stored in Environment.PMP.Variables.Rules.*[1].MAP_CONFIG instead of the configuration channel parameter to find the <msgTypeCfg> entry. For more information, see ISO message router mapper.

For example, the default Message To Target2 channel is configured with a CONFIG=HVP_MAP_CFG_MSG_TO_TARGET2 parameter. When an ISF message is received, the mapper searches the value table to find the <msgTypeCfg> entry to use for the message. It searches for a value table entry that meets the following conditions.

The category is one of the following values.
- The value from the Environment.PMP.Variables.Rules.*[1].MAP_CONFIG parameter, if the parameter is available.
- HVP_MAP_CFG_MSG_TO_TARGET2 is used when the Environment.PMP.Variables.Rules.*[1].MAP_CONFIG parameter is not available.
The <msgTypeCfg> entry has a <subType> child element with a value that is the same as the ISF business concept.

If the <msgTypeCfg> entry cannot be found, the mapper causes an exception to report a subType not found error.

The default <msgTypeCfg> entry for HVP_MAP_CFG_MSG_TO_TARGET2 is shown in the following example.

<msgTypeCfg>
   <class>PACS009</class>
   <subType>HVP_TO_CSM_INSTR_FI</subType>
   <extendedCfg>
      <name>MASTER_FLAG</name>
      <value>N</value>
   </extendedCfg>
   <extendedCfg>
      <name>MAP_FOR_HVP</name>
      <value>Y</value>
   </extendedCfg>
   <mapName>ISFToPacs009Mapper</mapName>
   <type>pacs.009.001.08</type>
</msgTypeCfg>

The following table shows the values from the <msgTypeCfg> entry that are used as configuration parameters by the outbound mapper.

Table 3. Values from `<msgTypeCfg>` that are used as configuration parameters by the outbound mapper
Element	Description
`<extendedCfg>` element that has a `<name>` child element with the value MAP_FOR_HVP.	The value from the associated `<value>` child element indicates whether the map is for High Value Payments.
`<type>`	The value from this element is used as the namespace of the output pacs.009 message. For T2, the value must be pacs.009.001.08.

The following table shows the default configuration parameters for the channels that use the pacs.009 outbound mapper.

Table 4. Default configuration parameters for channels that use the pacs.009 outbound mapper
Category	Class	SubType	Type
`HVP_MAP_CFG_MSG_TO_TARGET2`	`PACS009`	`HVP_TO_CSM_INSTR_FI`	`pacs.009.001.08`

The outbound mapper handles the datetime elements by using the following rules.

If the time zone is configured in the Channel table, the input datetime value is mapped from the UTC time zone to the format of the channel time zone.
If the time zone is not configured in the Channel table, the local time zone where the mapper is running is used. The input datetime value is mapped from the UTC time zone to the format of the local time zone.

The outbound mapper uses the TS_INCLUDE_OFFSET channel parameter to control whether the time zone offset is included in the output datetime values.

If TS_INCLUDE_OFFSET is set to Y, the time zone offset is included in the output datetime values.
If TS_INCLUDE_OFFSET is set to N or not configured, the time zone offset is not included in the output datetime values.