Configure an OIEP for VCSI with Git Delivery

To support Version Control System Integration (VCSI), this section describes how to configure an outbound integration endpoint (OIEP) to be used for publishing the system configuration to a remote Git repository.

Note: To compare the configurations from multiple STEP systems, the endpoint configurations should be identical except for the Git branch 'Git Delivery' method information.

  1. For first-time setup of the 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.

  2. 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.

  3. 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.

  4. In the 'Choose Data Source' step:

    • For Choose Data Source, select the 'Select Objects' option.

      Note: All configurations and settings to be held in Git must be published each time the OIEP is invoked. Refer to the VCSI: Git Delivery Method in OIEP topic.

    • Click the Add Objects link and select the relevant root nodes for the types of data objects to be published.

      Note: Even if no product, entity, or classification objects are to be published, a 'dummy' selection must be made, namely, the root nodes.

  5. In the 'Configure Endpoint' step:

    • For Processing Engine, select 'STEP Exporter.'

      For information on the 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, most configuration objects are not workspace revised. If data objects like products, entities, and classifications are to be published, in most cases, it is the approved version of these objects that should be exported, so select the 'Approved' workspace.

    • For Contexts, if configuration data that is dimension dependent is to be published, select all relevant contexts.

  6. Click the Finish button to close the wizard.

  7. 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.

  8. In the 'Output Templates' section, add a single configuration and select the object types of the nodes selected for publishing, including configurations with 'dummy' (root node) selections.

    Note: The Git delivery method only works with a single output template.

  9. For 'Format', the VCSI options work with either the 'STEPXML' format or the 'Advanced STEPXML' format with object type filtering, as defined below.

    When using STEPXML:

    • Select 'Yes' or 'All' for each configuration type to publish.

    • Select 'Minimum' for products, entities, and classifications (if these are to be published).

    • Select 'No' or 'None' for all types that should not be published.

    • To make obfuscated configurations (such as business rules) comparable outside STEP, on the 'Definitions As Comments' parameter, select 'Yes.'

    When using Advanced STEPXML, data objects are published and filtered by object type.

    • Enter a template and set the STEP-ProductInformation tag 'DefinitionsAsComments' attribute to 'true.'

      A full example configuration with object type filtering is shown below. Remove any object types that should not be published.

      Copy 
      <?xml version='1.0'?>
      <STEP-ProductInformation DefinitionsAsComments='true'>
        <TagGroupList/>
        <TagList/>
        <Qualifiers/>
        <GlobalSettings/>
        <UserTypes ExportSize='All'/>
        <Keys/>
        <DerivedEventTypes/>
        <EdgeTypes/>
        <CrossReferenceTypes ExportSize='All'/>
        <DimensionList/>
        <ContextList/>
        <UnitList ExportSize='All'/>
        <CollectionList ExportSize='All'/>
        <ListOfValuesGroupList/>
        <ListsOfValues ExportSize='All'/>
        <IntegrationEndpoints/>
        <EventProcessors/>
        <SetupGroups/>
        <SetupEntities/>
        <AttributeGroupList ExportSize='All'/>
        <AttributeList ExportSize='All'/>
        <DataContainerTypes ExportSize='All'/>
        <ActionSetList/>
        <UserGroupList/>
        <UserList/>
        <SystemSetup ExportSize='All'/>
        <TableColors ExportSize='All'/>
        <TableRules ExportSize='All'/>
        <TableTypeGroupList ExportSize='All'/>
        <TableTypeDefinitions ExportSize='All'/>
        <ECatalogs/>
        <EventQueues/>
        <STEPWorkflows ExportSize='All'/>
        <BusinessLibraries ExportSize='All'/>
        <BusinessRules ExportSize='All'/>
        <MatchCodes/>
        <MatchingAlgorithms/>
        <PortalConfigurations ExportSize='All'/>
        <AttributeTransformationGroups/>
        <ImportConfigurations ExportSize='All'/>
        <ExportConfigurations ExportSize='All'/>
        <BulkUpdateConfigurations ExportSize='All'/>
        <TransformationLookupTableConfigurations ExportSize='All'/>
        <ComponentModels/>
        <Products ExportSize='Minimum'>
          <FilterUserType ID='Level1'/>
          <FilterUserType ID='Level2'/>
          <FilterUserType ID='Level3'/>
          <Product/>
        </Products>
        <Classifications ExportSize='Minimum'/>
      </STEP-ProductInformation>    

  10. Configure the 'STEPXML Splitter' post-processor. For more information, refer to the 'STEPXML Splitter Post-processor for OIEP' heading in the topic.

  11. Configure the 'Git Delivery' delivery method. Refer to the 'Git Delivery Method for OIEP' heading in the topic.