Integration Model to CinC Generation

This sample workflow will lead the user to generate FACE 3 CinC after creating necessary Mains, UoP Instances, and UoPs.

Create a UoP

A UoP (Unit of Portability) represents your application. It defines all the inputs and outputs of the application by associating the data types (the queries and views defined in the data model) with the UoP.

Start by creating a UoP. CREATE >> INTEGRATION >> UOP

Enter an appropriate name for the UoP and choose a parent package.

After description, there are three drop down boxes. These are options specified by the FACE Technical Standard. At this point, you can choose any value. However, you may need to choose specific values when you run the UoP through the conformance test suite. See FACE UoP Options for more details.

Message Ports / Connections In the data model, the views (queries) define the data types that are ultimately sent and received by the UoP (applications). Click "+ Add New Message Port" to add the corresponding data type to this application.

• Name Enter a name for the message port
• Message Pattern This describes the general way messages are transmitted and works in conjunction with the Exchange Type (message direction).
  • Publish/Subscribe Publish/Subscribe indicates the messages will be (effectively) streamed.
  • Client indicate that some other pattern will be used and this message port will play act as a client
  • Server indicate that some other pattern will be used and this message port will play act as a server
• Exchange Type Indicates if the data will be sent or received.
• Message Type Select the view (query) corresponding to the data that will be sent/received.
• Synchronization Indicates if the application blocks when sending or awaiting data.
• Communication Style Indicates if the application sends a single message or manages a queue of messages
• Period (s) The period (in seconds) indicates the rate the message should be sent/received

For this first demonstration, choose:

• Publish/Subscribe for the messaging pattern
• Outbound for Exchange Type

Click SAVE (near the upper right).

Now, run through all the steps again to create a complementary UoP. Make sure you choose the same Message Type, but this time, choose Inbound for the Exchange Type.

Create a UoP Instance

Once the user has created their UoP it is now time to create the UoP Instance that will be used in CinC generation. This UoP Instance is going to be very important for later steps.

Similarly, new UoP Instance can be created by selecting the corresponding option in the 'Create>Integration' dropdown and then saving after inputting the required data .

Create a Context

The context is a visual diagram of the interactions between a UoP and the configurable elements of CinC.

1. Add UoP Instance to the context.
   1. Find the UoP Instance in the navigation tree and select it
   2. Drag it onto the context.
2. Add a Transporter to the context.
   1. In the horizontal toolbar on the left side of the diagram find and select the transporter block
   2. Drag the transporter block onto the diagram.
3. Create a Transport Channel
   1. With the transporter block selected, on the right side find the Transport Channel control and click on the '+' to add a new channel
   2. Give the channel a name and click the save icon.
   3. Once the save completes, click on the transport channel drop down and select the name of the channel you just created.
4. Connect the blocks
   1. Select the Uop Instance block in the diagram
   2. click on the up arrow at the upper right corner of the block and drag it over to the transporter block.
   3. A popup dialog will allow you to select the UoP port to connect to the transporter, select the port from the drop down list and click on save.
5. Commit the changes.
   1. Click the Commit button under the heading Model on the diagram tool bar. This saves the changes to the Integration Model (IM) elements but does NOT save the diagram.
6. Save the diagram
   1. click the middle disk icon under diagram in order to save the layout of the elements in the diagram. This saves the layout of the items in the diagram but does NOT save changes to the Integration or Deployment models that may have been made while editing the diagram elements.

Create a Main

The Main Program represents the executable program containing one (or more) UoPs and CinC.

1. A new Main Program can be created by selecting the corresponding option in the 'Create>Deployment' dropdown and then saving after inputting the needed data including the UoP Instance.

Add a TPM

The transport protocol module is responsible for the serialization and deserialization of messages and their transport from one TPM to another or another system.

This step is optional as PHENOM will generate a UDP TPM by default.

1. Within the Main detail page, after saving the main, click on the Create TPM button.
2. Give the TPM a name ('tpm' is fine).
3. Click the save button.
4. Commit the changes to the main by clicking the disk icon in the upper right.

Generate CinC

1. Next the user needs to open the 'Generate' section and click on the CinC submenu.
2. The user should select 'CinC' as the artifact.
3. Select the version of CinC you would like to generate
4. Select include CinC Source and choose Yes.
5. Select the Main and UoP Instances for the context we created above and make sure they are both checked
6. Select the appropriate license.
7. Click on the Generate button and a zip file will be created. The .zip file will contain the cinc source, the data modeled FACE types used by the UoP and the CinC configuration files. Save the file and extract the generated code.