Configure an OIEP for VCSI with Change Packages

To support Version Control System Integration (VCSI), this section describes how to configure an event-based outbound integration endpoint (OIEP) to be used for publishing the system configuration when using change packages and the Change Package Git Delivery method.

Alternately, an OIEP can be configured using REST Direct on a source system with a corresponding REST Receiver IIEP on a target system. For details, refer to the Configure Direct Integration Between STEP Systems for Change Packages topic.

Note: To compare the configurations from multiple STEP systems, the endpoint configurations should be identical except for the Directory Template, or they can be delivered in a separate branch, if desired.

For first-time setup of the Change Package Git Delivery option, it is recommended to create and use a test repository containing only a README.md file. This allows you to verify the STEP-specific Git behavior before enabling a production repository.
From System Setup, select a setup group configured to hold OIEPs, right-click, and select Create Outbound Integration Endpoint to launch the Outbound Integration Endpoint Wizard.
In the 'Identify Endpoint' step:
- For Endpoint ID, Endpoint Name, and Description, enter basic information.
- For User, select a system user who has view privileges to the configuration objects to be exported.
If the Change Package Git Delivery method is to be used, in the 'Choose Data Source' step:
- For Choose Data Source, select the 'Event Queue Data Source' option.
  
  Note: Sealing a change package generates an event which can trigger the OIEP when the schedule is running.
- For Event Batching, select 'No event batching' to separately export change packages to the VCS.
- For Bundle Messages, select ‘No message bundling’ to separately deliver each message.
  
  Note: Volume of change packages is relatively low compared to other integrations; therefore, event batching and message bundling are unnecessary.
In the 'Configure Endpoint' step:
- For Processing Engine, select 'STEP Exporter.'
  
  For information on Transactional settings parameter, refer to the Integration Endpoint Transactional Settings topic and for the Number of threads parameter, refer to the Event-Based OIEP Multithreading Support topic, both in the Data Exchange documentation.
- For Workspace, select 'Approved' since the approved version of objects is included with the change package when sealed.
- For Contexts, if configuration data that is dimension dependent is to be published, select all relevant contexts.
Click the Finish button to close the wizard.
On the 'Configuration' tab of the newly created endpoint, configure the schedule, queue, and process retention settings as desired. For more information, refer to the OIEP - Configuration Section topic in the Data Exchange documentation.
In the 'Output Templates' section, add a single configuration and browse or search for 'Change Package (Sealed).

Note: The Change Package Git Delivery method only works with an Output Template configuration with Object-Eventtype using 'Change Package (Sealed),' which was previously named ‘Verified package content.’ Since the Change Package object type has three states: Dormant, Open, and Sealed, and only Sealed change packages can be exported, although using the ‘Change Package’ object does generate events, it does not export the change package when used in the output template.
For 'Format,' the VCSI Change Package option works with 'Advanced STEPXML' format, as defined below with the desired value for Export Data for Selected Contexts.

Add the following Advanced STEPXML template:
Copy
```
1
2
3
4
<?xml version='1.0'?> 
<STEP-ProductInformation ResolveInlineRefs="true"> 
<ChangePackages ExportSize="Selected"/> 
</STEP-ProductInformation>     
```
Refer to the OIEP - Event-Based - Output Templates Section topic in the Data Exchange documentation.
On the Event Triggering Definitions tab, set the following options:

For Triggering Object Types section, add the 'Change Package (Sealed).'

Since sealing a change package triggers the event, no other event triggers are useful; however, an event filter or generator can be configured, if desired.
Configure the 'Change Package Git Delivery' method. Refer to the VCSI: Change Package Git Delivery Method in OIEP topic.
To collect and deliver events from sealed change packages,
- Set the OIEP Queue Status to 'Read Events.'
- Modify the Schedule parameter if needed. By default, the schedule is set to run every minute.
- Enable the OIEP.