Channel scheduling functionality can be used to group channels and maintain times when these channels shall be available. Availability means if a channel is part of channel schedule, then it will automatically be up and running within times as per configuration of schedule.
Outside Channel schedule time, the channel will be in status stopped.
With PI 7.31, Introduction of a new view/tab in Communication Channel Monitor is done where scheduling information would be visualized in a calendar view.
Name of the tab "Schedule”
Allow to select a single channel or a set of channels and display their scheduling details in one view
If a channel is scheduled and schedule is Active, tab “Availability Times” will have information about duration when channel will be up and running
Creating a Schedule
Creation of Schedule can be done in Communication Channel Monitoring 1. Go to PI Start Page via http(s)://<host>:<port>/dir.
2. Click on link Configuration and Monitoring Home.
3. Click on the tab Monitoring and then on sub-tab Adapter Engine.
4. And then Click on link Communication Channel Monitor.
5. In new window, Click on Tab Availability Planning.
6. Create a Schedule of Type “Once”. Click on Button New and Select Once from drop down values
7. In Description field enter name of Schedule ParamMap_Once. If another schedule exists with the same name, delete it first before creation.
8. Select Start Date as <CurrentDate>, Start Time as <nextHour>, End Date as
<CurrentDate> and End Time as <nextHour + 1>
9. Click on Communication Channels tab within Schedule creation to add channels to the schedule.
10. Enter XiPatternChannel_FileSender_ParamMap in Communication Channel field and press Use Filter. Result will be only Channel
XiPatternChannel_FileSender_ParamMap being displayed in table Scheduled Channels.
11. Select checkbox Active and then click on Save. You will get a confirmation message for the same.
12. Now Create another Schedule of type “Daily”. Click on Button New and Select Daily from drop down values
13. In Description field enter name of Schedule ParamMap_Daily. If another schedule exists with the same name, delete it first before creation.
14. Select Start Date as <CurrentDate>, Start Time as <nextHour>, End Date as
<CurrentDate>, End Time as <nextHour + 1> and End By as <CurrentDate + 2> so as to make this schedule as recurring for 3 days (<CurentDate> till <CurrentDate + 2>).
15. Click on Communication Channels tab within Schedule creation to add channels to the schedule.
16. Enter XiPatternChannel_FileReceiver_ParamMap in Communication Channel field and press Use Filter. Result will be only Channel
XiPatternChannel_FileReceiver_ParamMap being displayed in table Scheduled Channels.
17. Select checkbox Active and Save. You will get a confirmation message for the same.
Execution of a Schedule
You perform the following steps to check that View of Channel Schedule in Channel Monitoring and Channel Schedule functionality is executed without errors.
3. Open Channel Monitoring for both channels XiPatternChannel_FileSender_ParamMap and
XiPatternChannel_FileReceiver_ParamMap in two different browser windows.
4. Check if Control Data of both the above channels is Automatic. If not, click on Automatic Control to change control data of channels to Automatic.
5. The moment control data of above channels is Automatic, channel will be in status Stopped. This happens as per settings of created Channel Schedule
ParamMap_Once and ParamMap_Daily.
6. Perform below step 5 - step15 within Channel Monitoring browser for both channels.
7. A newly introduced tab called Channel Availability can be seen in main table of channel.
8. Click on Tab Channel Availability
9. All the buttons Start, Stop, Automatic Control, External Control, Mass Change and Ping Channel will be disabled in this view.
10. Two frames are available. One displays Monthly and another Weekly Schedule for the selected Channel.
11. Monthly Schedule by default will display information for the current month. There are buttons to check Schedule Information for previous and next months as well. It will contain 1 block for each day of the month.
12. Weekly Schedule by default will display information for current week starting Sunday.
It will have 1 block for each day with 1 row for each hour of the day starting from 12:00 AM and ending with 11:00 PM.
13. The block for schedule of current date will be available in orange background color, green color for future schedule (in case of recurring) and will not be displayed for recurring schedule in past.
14. To display Schedule information for other weeks of the month, click on a block of day from Monthly Schedule. Weekly schedule information will change to week containing the selected day.
15. Created Schedule ParamMap_Once or ParamMap_Daily can be seen as one block as per configured date and time. The schedule block has information about Schedule Validity, Schedule Name and Schedule Type. The format of information is <Schedule Start Time> :<Schedule Name> (<Schedule Time Period>) <Schedule End Time>
(<Schedule Type>).
16. Click on Channels Tab to return back to Channels display.
17. Now in Channel details table, another newly introduced tab called Schedule can be seen.
18. Click on tab Schedule.
19. The new view is similar to view of Channel Availability tab as above except that basic
20. Check if current time is still non-availability time of schedule. Wait until current time is reached to available time of schedule.
21. Channel XiPatternChannel_FileSender_ParamMap and
XiPatternChannel_FileReceiver_ParamMap will start automatically once current time is equal to schedule available time. The same can be checked by reaching tab Administration Information on Channel details table. Information regarding Time Stamp, Action (Started/Stopped) and Person Responsible (Schedule
<ScheduleName> will be available.
22. In directory XiPattern1, Rename the file ZXiPatternSenderFileParamMap.xml to XiPatternSenderFileParamMap.xml. The file will be moved from the directory within the next 60 seconds.
23. Check whether a file has arrived in directory XiPattern2. Open the latest arrived file.
The structure will have changed: the first and the second name of the person have been concatenated and prefixed with Title; the field for the MobileNumber has a new name ContactNumber prefixed with CountryCode. The value of Field Title and CountryCode in received message is as per defined in Integrated Configuration tab Receiver Interface.
24. Rename the file XiPatternSenderFileParamMap.xml back to
ZXiPatternSenderFileParamMap.xml to stop continuous flow of messages.
25. For next 1 hour (Schedule available time), both the channels will be in started status.
Once Schedule available time is over, Channels will again be stopped as per action performed by underlying Schedule (ParamMap_Once and ParamMap_Daily).
26. Since schedule ParamMap_Daily is a recurring schedule, check again on
<currentDate +1> and <CurrentDate + 2>. The channel
XiPatternChannel_FileReceiver_ParamMap will be started during its schedule available time. Start channel XiPatternChannel_FileSender_ParamMap manually and rename file in sender directory to check flow of message for the scenario.
27. Rename the file XiPatternSenderFileParamMap.xml back to
ZXiPatternSenderFileParamMap.xml to stop continuous flow of messages.
18 Variant 16: One Sender and Two Receivers using Advanced Adapter Engine Extended – with Message Order at Runtime
This variant enables you to configure and execute message exchange with Message Order at Runtime:
One sender (file directory XiPattern1) sends a message to two receivers (file directory
XiPattern2 and XiPattern2). Hereby, the message is exchanged between sender and receiver adapter by using one Advanced Adapter Engine Extended. The order in which messages are retrieved in Receiver File Directory is defined by the order in the “Receiver Interfaces” panel of Integrated Configuration within Integration Directory.
In this variant, configuration of Sender Channel with EOIO (Exactly Once In Order) setting is done and an additional receiver channel is added so as to handle multiple receivers for EOIO messages. Hence two messages will be sent out for respective receivers.
Message Order at Runtime settings provide an option to define an order for received messages to follow. The checkbox for the same is available within Receiver Interface tab of Integrated Configuration while configuring the scenarios in Directory.
18.1 Design Objects Used
As described under 3.1, you can navigate to all design objects used in this variant in ESR.
The following explains the design objects that play a role while configuring this variant.
Interface Objects
In this case outbound interface and inbound interfaces are different. If you navigate further to the message type and data type used, you will see that the data structure on the sender side is different than the previous variants (defined by the data type XiPatternDataType6).
However, the asynchronous service interface XiPatternInterface7 and XiPatternInterface8 is entered as the inbound interface at the receiver. This service interface references the message types XiPatternMessage7 and XiPatternMessage8 respectively. The data structure of the message is defined by the data types XiPatternDataType7 and XiPatternDataType8 respectively. The structure of data types XiPatternDataType7 and XiPatternDataType8 is more of subsets of structure of data type XiPatternDataType6 defined in the following ways:
In data type XiPatternDataType6, two separate elements are used to specify the person‟s first and last name, whereas in data type XiPatternDataType7, only one element is used (FullName) which is concatenation of FirstName and LastName.
In data type XiPatternDataType6, two separate elements are used to specify the person‟s Address (AddressLine1 and AddressLine2), whereas in data type XiPatternDataType8, only one element FullAddress is used which is concatenation of AddressLine1 and AddressLine2.
Mapping Objects
A mapping between the sender and receiver data structures must therefore be executed for the message to be processed.
In ESR, navigate to the relevant mapping objects. Double-click on name of the operation mapping (XiPatternInterface6ToInterface7and8) to open it. The names of the source and target interface, as well as the source and target message are displayed. The message mapping used is displayed under Mapping Program. Double-click to open the message mapping (XiPatternMessage6ToMessage7and8).
In the message mapping editor, the tab page Design displays the source and target structures.
You have the option of displaying for which elements of the source and target structure mappings are to be executed. To do so, choose Display
Dependencies Display All ( ).
Summary of Design Objects Used
The following table summarizes the design objects used.
Design Objects Used
Object Type (Name) Description
Service interface (XiPatternInterface6) Describes the interface and data structure of the sender and receiver. The data structure of receiver is different to the data structure of the sender.
Service interface (XiPatternInterface7) Service interface (XiPatternInterface8)
Message Type (XiPatternMessage7) Message Type (XiPatternMessage8)
Data Type (XiPatternDataType6) Describes the data structure of the sender message Data Type (XiPatternDataType7) Describes the data structure of the receiver message Data Type (XiPatternDataType8)
Operation mapping
(XiPatternInterface6ToInterface7and8)
Describes the mapping between the source and target interface
Message Mapping
(XiPatternMessage6ToMessage7and8)
Describes the mapping between the source and target structure in detail. Mapping with Message split is done here.
Communication Channel Templates for Sender and Receiver
(XiPatternChannel_FileSenderO_MultiRe ceiver,
XiPatternChannel_FileReceiverO_MapR untime)
Specifies the sender (and receiver) adapter configuration details, which are defined at design time. Communication channel templates enable a communication channel to be preconfigured at design time.