Integration Model to CinC Generation: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
(Created initial IM -> CinC Generation tutorial page)
 
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Sample Workflow ==
This sample workflow will lead the user to generate FACE 3 CinC after creating necessary Mains, UoP Instances, and UoPs.
This sample workflow will lead the user to generate FACE 3 CinC after creating necessary Mains, UoP Instances, and UoPs.


Firstly, the user needs to create a UoP to be used by a UoP Instance within the model. A new UoP can be created by selecting the corresponding option in the 'Create>Integration' dropdown and then saving after inputting the necessary data.
== Create a UoP ==
[[File:Generate_-_CreateUoP.png|none|thumb|800x800px]]
First, create a UoP to be used by a UoP Instance within the model. A new UoP can be created by selecting the corresponding option in the 'Create>Integration' dropdown and then saving after inputting the necessary data.
[[File:Generate_-_CreateUoP.png|border|800x800px]]
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.
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, A 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 UoP Instance ==
[[File:Generate_-_CreateUoPInstance2.png|none|thumb|800x800px]]
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 .
Next, the user needs to create a Main Program to be used during CinC. This is the Main Program that will house our UoP Instance and should be selected during creation.
[[File:Generate_-_CreateUoPInstance2.png|border|800x800px]]


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.
== Create a Context ==
The context is a visual diagram of the interactions between a UoP and the configurable elements of CinC.
[[File:Generate - CreateContext.png|none|thumb|800px]]
# Add UoP Instance to the context.
## Find the UoP Instance in the navigation tree and select it
## Drag it onto the context.
# Add a Transporter to the context.
## In the horizontal toolbar on the left side of the diagram find and select the transporter block
## Drag the transporter block onto the diagram.
# Create a Transport Channel
## With the transporter block selected, on the right side find the Transport Channel control and click on the '+' to add a new channel
## Give the channel a name and click the save icon.
## Once the save completes, click on the transport channel drop down and select the name of the channel you just created.
# Connect the blocks
##Select the Uop Instance block in the diagram
## click on the up arrow at the upper right corner of the block and drag it over to the transporter block.
## 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.
#Commit the changes.
##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.
# Save the diagram
##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.
#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.
[[File:Generate_-_CreateMainProgram2.png|none|thumb|800x800px]]
[[File:Generate_-_CreateMainProgram2.png|none|thumb|800x800px]]
Next the user needs to open the 'Generate' section and click on the CinC submenu.


The user should select 'CinC' as the artifact. For the generation config, the user should decide which changes to make depending on their setup. Only include CinC source if you have the required filesAfter setting up the CinC config, the user needs to now select their Mains and UoPs by using their checkboxes. Next, for each Main Program, the user will select an available CinC license. The user doesn't need to make any node selections to generate FACE 3 CinC but will here for demonstration.
== 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.'''
 
[[File:Generate - MainCreateTPM2.png|thumb|none|800px]]
# Within the Main detail page, after saving the main, click on the Create TPM button. 
# Give the TPM a name ('tpm' is fine).
# Click the save button.   
# Commit the changes to the main by clicking the disk icon in the upper right.


Finally, click the 'Generate' button after setting up the config and selection to generate FACE 3.0 CinC and a .zip file will be created for download.
== Generate CinC ==
# Next the user needs to open the 'Generate' section and click on the CinC submenu.
# The user should select 'CinC' as the artifact.
# Select the version of CinC you would like to generate
# Select include CinC Source and choose Yes.
# Select the Main and UoP Instances for the context we created above and make sure they are both checked
# Select the appropriate license.
# 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.
[[File:Generate_-_CinC.png|none|thumb|800x800px]]
[[File:Generate_-_CinC.png|none|thumb|800x800px]]
== Code Generation ==
CinC generation targets a different type of element called a '''Main Program'''. These are created from the main 'CREATE' dropdown.
[[File:Imeditor_-_Codegen1.png|none|thumb|830x830px]]
Once your Main Program exists, you can associate UoP Instances to it so they become part of the generated code.
[[File:Imeditor_-_Codegen2.png|none|thumb|834x834px]]
Similarly, Main Programs can be placed in '''Processing Elements''' - but these are not incorporated into generation yet.

Latest revision as of 09:53, 26 September 2024

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

Create a UoP

First, create a UoP to be used by a UoP Instance within the model. A new UoP can be created by selecting the corresponding option in the 'Create>Integration' dropdown and then saving after inputting the necessary data. 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.

Create a UoP Instance

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.