Integration Model to CinC Generation - Revision history

Chris at 17:50, 13 January 2026

2026-01-13T17:50:59Z

← Older revision		Revision as of 13:50, 13 January 2026
Line 34:		Line 34:

	== Create a UoP Instance ==		== 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~~.		Since UoPs can be used in many different applications, UoP Instances are used to explicitly connect a UoP to an application.

			A new UoP Instance can be created by selecting the corresponding option in the CREATE >> INTEGRATION >> UOP INSTANCE.

			After providing an appropriate name, select the UoP that corresponds to this instance. Click SAVE near the upper right corner.

			Repeat this process for the complementary UoP that you created in the previous section.

	~~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 .~~
	[[File:Generate_-_CreateUoPInstance2.png\|border\|800x800px]]		[[File:Generate_-_CreateUoPInstance2.png\|border\|800x800px]]

	== Create a Context ==		== Create an Integration Context ==
	The ~~context~~ is a visual diagram of the interactions between a UoP and the configurable elements of CinC.		The Integration Context is a visual diagram of the interactions between a UoP and the configurable elements of CinC.

	[[File:Generate - CreateContext.png\|none\|thumb\|800px]]		[[File:Generate - CreateContext.png\|none\|thumb\|800px]]
	# Add UoP ~~Instance~~ to the context.
	## Find the UoP ~~Instance~~ in the navigation tree and select it		Add UoP Instances that you created to the context.
	## Drag it onto the context.		* Find the UoP Instances in the navigation tree and select it
	~~# Add~~ a Transporter ~~to the context~~.		* Drag it onto 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.		At this point, the two UoP (instances) exist, but they do not know how to communicate with each other. In this simplest of examples where the two UoPs are communicating using the same message, they can easily be integrated by using a Transporter block.
	~~# 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		* In the toolbar on the left side of the diagram find and select the transporter block
	## Give the channel a name and click the save icon.		* Drag the transporter block onto the diagram.
	## Once the save completes, click on the transport channel drop down and select the name of the channel you just created.
	~~# Connect~~ the blocks		A Transporter is a represents where the flow of data is occurring. However, it is a somewhat generic concept that needs further configuration. This is where you select the ''transport protocol''.
	##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.		* With the transporter block selected, on the right side find the Transport Channel control and click on the '+' to add a new channel
	## 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.		* Give the channel a name and click the save icon.
	~~#Commit~~ the changes.		* Once the save completes, click on the transport channel drop down and select the name of the channel you just created.
	##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		Now you are ready to connect the blocks to each other.
	~~##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.
			* Select the first UoP Instance block in the diagram (this should be the "outbound" application)
			* Click on the up arrow at the upper right corner of the block and drag it 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 (in this case, there is only one)
			* Select the Transporter block in the diagram
			* Click on the up arrow at the upper right corner of the transporter block and drag it to the second UoP Instance (this should be the "inbound" application)

			Up to this point, we have relied on the SAVE button to persist most of our changes. However, diagrams work a little differently. In order to persist diagrammed changes, you need to 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.
			* Now, 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 ==		== Create a Main ==
	The Main Program represents the executable program containing one (or more) UoPs and CinC.		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~~.
			A new Main Program can be created by selecting the corresponding option in the CREATE >> DEPLOYMENT.

			After setting an appropriate name, 'the most important thing' is to add your UoP Instances to the executable. Look halfway down the page and there is a '''Contains UOP Instances''' heading with a list of UoP Instances. Use the drop down box at the bottom of that section to add your UoP Instances.

			Click SAVE near the upper right corner.

	[[File:Generate_-_CreateMainProgram2.png\|none\|thumb\|800x800px]]		[[File:Generate_-_CreateMainProgram2.png\|none\|thumb\|800x800px]]

Line 79:		Line 100:

	== Generate CinC ==		== Generate CinC ==
	~~# Next~~ the ~~user needs to open~~ the 'Generate' section and click on the CinC submenu.		This is the step where you will actually be transforming your model into a downloadable source code package.
	# ~~The user should select~~ 'CinC' as the artifact.
			* Open the 'Generate' section and click on the CinC submenu.
			# Select 'CinC' as the artifact.
	# Select the version of CinC you would like to generate		# Select the version of CinC you would like to generate
	# Select include CinC Source and choose Yes.		# 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 Main and UoP Instances for the context we created above and make sure they are both checked
	# Select the appropriate license.		# 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.		# 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]]

	[[Category:UserGuide\|0044_Integration_Model_to_CinC_Generation]]		[[Category:UserGuide\|0044_Integration_Model_to_CinC_Generation]]

Chris at 16:33, 13 January 2026

2026-01-13T16:33:32Z

@@ Line 2: / Line 2: @@
 == 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.
+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.
 [[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.
-== 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 .
 [[File:Generate_-_CreateUoPInstance2.png|border|800x800px]]

Jen at 18:16, 22 October 2025

2025-10-22T18:16:33Z

← Older revision		Revision as of 14:16, 22 October 2025
Line 57:		Line 57:
	# 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.		# 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]]

			[[Category:UserGuide\|0044_Integration_Model_to_CinC_Generation]]

Nathalie: /* Add a TPM (OPTIONAL) /

2024-09-26T14:53:46Z

Add a TPM (OPTIONAL*)

← Older revision		Revision as of 10:53, 26 September 2024
Line 37:		Line 37:
	[[File:Generate_-_CreateMainProgram2.png\|none\|thumb\|800x800px]]		[[File:Generate_-_CreateMainProgram2.png\|none\|thumb\|800x800px]]

	== Add a TPM ~~(OPTIONAL*)~~ ==		== 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.		The transport protocol module is responsible for the serialization and deserialization of messages and their transport from one TPM to another or another system.

	'''* PHENOM will generate a UDP TPM by default ~~so this step may be skipped~~.'''		'''This step is optional as PHENOM will generate a UDP TPM by default.'''

	[[File:Generate - MainCreateTPM2.png\|thumb\|none\|800px]]		[[File:Generate - MainCreateTPM2.png\|thumb\|none\|800px]]
	# Within the Main detail page, after saving the main, click on the Create TPM button.		# Within the Main detail page, after saving the main, click on the Create TPM button.

Nathalie: /* Generate CINC */

2024-08-26T15:18:46Z

Generate CINC

← Older revision		Revision as of 11:18, 26 August 2024
Line 47:		Line 47:
	# Commit the changes to the main by clicking the disk icon in the upper right.		# Commit the changes to the main by clicking the disk icon in the upper right.

	== Generate ~~CINC~~ ==		== Generate CinC ==
	# Next the user needs to open the 'Generate' section and click on the CinC submenu.		# Next the user needs to open the 'Generate' section and click on the CinC submenu.
	# The user should select 'CinC' as the artifact.		# The user should select 'CinC' as the artifact.

Nathalie: /* Add a TPM (OPTIONAL) /

2024-08-26T15:17:58Z

Add a TPM (OPTIONAL*)

← Older revision		Revision as of 11:17, 26 August 2024
Line 40:		Line 40:
	The transport protocol module is responsible for the serialization and deserialization of messages and their transport from one TPM to another or another system.		The transport protocol module is responsible for the serialization and deserialization of messages and their transport from one TPM to another or another system.

	'''* ~~Phenom~~ will generate a UDP ~~tpm~~ by default so this step may be skipped.'''		'''* PHENOM will generate a UDP TPM by default so this step may be skipped.'''
	[[File:Generate - MainCreateTPM2.png\|thumb\|none\|800px]]		[[File:Generate - MainCreateTPM2.png\|thumb\|none\|800px]]
	# Within the Main detail page, after saving the main, click on the Create TPM button.		# Within the Main detail page, after saving the main, click on the Create TPM button.
	# Give the ~~tpm~~ a name ('tpm' is fine).		# Give the TPM a name ('tpm' is fine).
	# ~~click~~ the save button.		# Click the save button.
	# Commit the changes to the main by clicking the disk icon in the upper right.		# Commit the changes to the main by clicking the disk icon in the upper right.

Nathalie: /* Create a main */

2024-08-26T15:16:09Z

Create a main

← Older revision		Revision as of 11:16, 26 August 2024
Line 32:		Line 32:
	##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.		##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~~ ==		== Create a Main ==
	The Main Program represents the executable program containing one (or more) UoPs and CinC.		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.		#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.

Nathalie: /* Create a UoP Instance */

2024-08-26T15:11:32Z

Create a UoP Instance

← Older revision		Revision as of 11:11, 26 August 2024
Line 7:		Line 7:

	== Create a UoP Instance ==		== Create a UoP Instance ==
	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 .		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 .
	[[File:Generate_-_CreateUoPInstance2.png\|~~none\|thumb~~\|800x800px]]		[[File:Generate_-_CreateUoPInstance2.png\|border\|800x800px]]

	== Create a Context ==		== Create a Context ==

Nathalie: /* Create a UoP */

2024-08-26T15:11:18Z

Create a UoP

← Older revision		Revision as of 11:11, 26 August 2024
Line 3:		Line 3:
	== Create a UoP ==		== 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.		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\|~~none\|thumb~~\|800x800px]]		[[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.

Shawn: /* Add a TPM */

2024-08-23T15:50:11Z

Add a TPM

← Older revision		Revision as of 11:50, 23 August 2024
Line 37:		Line 37:
	[[File:Generate_-_CreateMainProgram2.png\|none\|thumb\|800x800px]]		[[File:Generate_-_CreateMainProgram2.png\|none\|thumb\|800x800px]]

	== Add a TPM ==		== Add a TPM (OPTIONAL*) ==
	The transport protocol module is responsible for the serialization and deserialization of messages and their transport from one TPM to another or another system.		The transport protocol module is responsible for the serialization and deserialization of messages and their transport from one TPM to another or another system.

			'''* Phenom will generate a UDP tpm by default so this step may be skipped.'''
	[[File:Generate - MainCreateTPM2.png\|thumb\|none\|800px]]		[[File:Generate - MainCreateTPM2.png\|thumb\|none\|800px]]
	# Within the Main detail page, after saving the main, click on the Create TPM button.		# Within the Main detail page, after saving the main, click on the Create TPM button.

Integration Model to CinC Generation - Revision history

Chris at 17:50, 13 January 2026

Chris at 16:33, 13 January 2026

Jen at 18:16, 22 October 2025

Nathalie: /* Add a TPM (OPTIONAL*) */

Nathalie: /* Generate CINC */

Nathalie: /* Add a TPM (OPTIONAL*) */

Nathalie: /* Create a main */

Nathalie: /* Create a UoP Instance */

Nathalie: /* Create a UoP */

Shawn: /* Add a TPM */

Nathalie: /* Add a TPM (OPTIONAL) /

Nathalie: /* Add a TPM (OPTIONAL) /