Context data

In the IBM PEM Portal, context data allows a sponsor to set up certain text data in an activity that becomes default data. This default data can be mapped to values in a mapping window. Context data is provided in XML format only.

Activity context data provides a way to specify, at the activity level, the information that is common between some of the components. To add items to all screens of the activity, you can map them to one of the elements in the context data. Items that you can add include your company logo, company name, company website link, help site link, API configuration, and one or more documents. During the processing of the activity, the image, API configuration, or document are retrieved from the mapped context data element and displayed.

To add a footer to all the UI dialogs in an activity, create a label for all the UI dialogs and map it to one of the elements in the context data. However, in the PEM Partner Provisioner, no UI dialogs are used, only API dialogs are used.

Mapping of context data is supported for the following activity elements:
  • API dialog fields: API configuration, URL, Request mapping, and File attachment
  • Custom field tasks (only in the PEM Portal)
  • Entry or exit validation

Context data in an activity is maintained if the activity definition is exported. The references keys are retained in the context data when the activity definition is exported if there is anything mapped during definition. But if the references keys are not available in the system where you import the activity definition, when you try to mark as final, it fails with an invalid mapping error. This is because only references keys are exported and not the references entities.

XML example

The following example shows a sample of context data in correct XML format:
<RolloutCustomization>
<Constants>
<Pass>Pass</Pass>
<Fail>Fail</Fail>
<True>True</True>
<False>False</False>
<PartnerInitiateConnection>I will initiate the connection</PartnerInitiateConnection>
<PartnerListenConnection>I will listen for the connection</PartnerListenConnection>
</Constants>

<UICustomization>
<HeaderLogo type="logofiles">SampleLogo</HeaderLogo>
<FooterLeft>Sample Footer Left</FooterLeft>
<FooterRight>Sample Footer Right</FooterRight>
<PartnerConnectionDirections>
<PartnerConnectionDirection>
${ActivityContext.ContextData.RolloutCustomization.Constants.PartnerInitiateConnection}
</PartnerConnectionDirection>
<PartnerConnectionDirection>
${ActivityContext.ContextData.RolloutCustomization.Constants.PartnerListenConnection}
</PartnerConnectionDirection>
</PartnerConnectionDirections>
</UICustomization>

<FlowCustomization>
<PRAPIConfiguration type="APIConfig">SamplePRAPIConfiguration</PRAPIConfiguration>
<PEMAPIConfiguration type="APIConfig">SamplePEMAPIConfiguration</PEMAPIConfiguration>
<SponsorContext>SampleSponsorContext</SponsorContext>
<EnableInboundPGP>True</EnableInboundPGP>
<EnableOutboundPGP>True</EnableOutboundPGP>
<ConsolidateInboundPushAndOutboundPullUI>False</ConsolidateInboundPushAndOutboundPullUI>
<RegeneratePassword>False</RegeneratePassword>
<AuthenticationHost/>
</FlowCustomization>

<SFGSponsorConfiguration>
    <CommunityName>SampleCommunity</CommunityName>
    <InboundStaticRCT>SampleIBStaticRCT</InboundStaticRCT>   
<InboundStaticRCConsumerName>SampleIBStaticRCTConsumerName</InboundStaticRCConsumerName>
   <OutboundStaticRCT>SampleOBStaticRCT</OutboundStaticRCT> 
<OutboundStaticRCProducerName>SampleOBStaticRCTProducerName</OutboundStaticRCProducerName>
   <DynamicRCT>SampleDynamicRCT</DynamicRCT>
</SFGSponsorConfiguration>

 <InboundPGP>
  <TestEncryptionKey type="activityfiles">SampleTestEncryptionKey</TestEncryptionKey>
 <ProductionEncryptionKey 
type="activityfiles">SampleProductionEncryptionKey</ProductionEncryptionKey>
</InboundPGP>
 <OutboundPGP>
   <TestVerificationKey type="activityfiles">SampleTestVerificationKey</TestVerificationKey> 
<ProductionVerificationKey 
type="activityfiles">SampleProductionVerificationKey</ProductionVerificationKey> 
</OutboundPGP>

<InboundPush>
<TestConfiguration ActivePortRange="80-90" BaseDir="/Inbox" ConnectionType="ACTIVE" 
Host="localhost" IntervalBetweenRetries="10" NoOfRetries="5" Port="21" 
PassivePortRange="200-300"/>
<ProductionConfiguration ActivePortRange="80-90" BaseDir="/Inbox" ConnectionType="ACTIVE" 
Host="localhost" IntervalBetweenRetries="10" NoOfRetries="5" Port="21" 
PassivePortRange="200-300"/>
</InboundPush>

<OutboundPull>
<TestConfiguration ActivePortRange="80-90" BaseDir="/Outbox" ConnectionType="ACTIVE" 
Host="localhost" IntervalBetweenRetries="10" NoOfRetries="5" Port="21" 
PassivePortRange="200-300"/>
<ProductionConfiguration ActivePortRange="80-90" BaseDir="/Outbox" ConnectionType="ACTIVE" 
Host="localhost" IntervalBetweenRetries="10" NoOfRetries="5" Port="21" 
PassivePortRange="200-300"/>
</OutboundPull>

<IntroductionCustomization>
<Header>Introduction to Cash Bank's Service onboarding initiative</Header>
<Step1>The Cash Bank Managed File Services Transmissions group is in the process of 
onboarding partners to our new Cash Bank Secure File Transfer system that uses the FTP 
protocol. New features of the system include the following self service capabilities - 
change password, subscribe to alerting and operational reporting. The primary differences 
are improved service notifications, file transmission visibility and disaster recovery 
handling.</Step1>
<Step2>In order to onboard to the new system, we will need to configure our connections with 
your network. Understand that there may be issues connecting using the new configurations if 
there are local firewall rules in place on your network. Testing will verify whether there 
are any issues.</Step2>
<Step3>As is our standard practice, the changes related to the new system will be tested and 
verified to be working correctly before we conclude the onboarding. In support of the 
change, we also ask you to confirm your company contacts. Once you click Close below, 
continue through each of the remaining tasks. This will provide us with the information 
needed to plan and schedule the necessary actions.</Step3>
<Step4>For questions, you can contact our help desk at 1-800-777-CASH and select option 
1.</Step4>
</IntroductionCustomization>

</RolloutCustomization>