Managing Endpoints

Endpoints are the source or destination for Data Flows. They define how CIC connects to external systems, partners, and data sources. This section explains how to create, configure, and manage endpoints to support your integration workflow.

Viewing the Endpoint List

Navigate to Network > Endpoints to view a list of Endpoints on your system.

For each Endpoint, you can see the following attributes:

• Name of the Endpoint.
• Name of the Access Point on which the Endpoint resides (only valid for File System).
• Creator of the Endpoint.
• Date the Endpoint was last modified.

The Endpoints page includes a Subdomain column in the following cases:

• For AS2, OFTP, and Partner Mailbox Endpoints, if you have more than one subdomain.
• For FTP and SFTP Endpoints, if you have more than one subdomain and Cleo has configured one of them to be associated with a static IP.

Filtering the Endpoint List

You can control what is displayed on the list of Endpoints through filtering available on the left side of the Endpoint List page. When you specify a value for one or more of the filter attributes, the Endpoint list is updated accordingly.

Note: Filters you apply are retained when you leave the Endpoint List page and subsequently return to it.

As you type in any of the filter fields (except for the Endpoint Type field, which requires selecting a predefined value), CIC dynamically displays matching results based on your input. You can then select a value from the list of suggestions.

Drop-down menu entries are limited to the values available on the current page. For example, if you select a name from the Access Point menu, only File System endpoints will appear in the Endpoint Type menu because Access Points are associated exclusively with File System endpoints.

Currently applied filters are displayed at the top of the list. You can remove an individual filter by clicking the X next to it, or click Clear All to remove all filters at once.

You can click the Hide/Unhide button to toggle the Filter by panel.

Creating an Endpoint

Create Endpoints to define how CIC connects to external systems or partners as a source or destination for Data Flows.

1. On the Endpoints page, click the Add Endpoint button.

   

   The New Endpoint page displays.

   

2. Enter a name for your Endpoint and select an Endpoint type.

3. Enter attribute values.

   Endpoint attributes vary depending on type. Click an Endpoint type below to read about its attributes:|

   • AS2
   • AzureBlob
   • Email
   • File System
   • FTP(S)
   • GCS
   • OFTP
   • Partner Mailbox
   • RNIF
   • S3
   • SFTP
   • API Consumer and Provider

   Note: The following Endpoint types are visible on the Endpoint page, but are not editable from CIC Cockpit. Click to read more about them.

   • Application
   • Database
4. When you finish specifying attribute values, click Save.

Editing Endpoints

Edit Endpoints to reflect changes in connection details and requirements.

On the Network > Endpoints page, click an existing Endpoint to display the Endpoint Edit page, where you can edit the Endpoint's attributes.

Endpoint attributes vary depending on Endpoint type. Click an Endpoint type below to read about its attributes.

• AS2
• AzureBlob
• Email
• File System
• FTP(S)
• GCS
• OFTP
• Partner Mailbox
• RNIF
• S3
• SFTP 

Enabling and Disabling Endpoints

Endpoints are enabled by default. In rare instances, it might be necessary to disable one, for example, during migration from a hybrid on-prem/cloud configuration.

Note: Be careful when you disable Endpoints. Data Flows that use disabled Endpoints are also disabled and Jobs involving disabled Endpoints will not run.

You can enable or disable Endpoints one at a time using the Enable button on the Endpoint Edit page.

Alternatively, you can enable or disable multiple Endpoints by going to the Network > Endpoints page, selecting some Endpoints, and clicking the Enable button.

Browsing an Endpoint

For File System, FTP, SFTP, S3, and Partner Mailbox Endpoints, CIC Cockpit supports directory browsing from the Endpoint Edit page. In addition to being an easy way to navigate to a directory on the Endpoint, this is also an easy way to ensure you can connect to your Endpoints.

Notes:

• The Browse Endpoint button becomes enabled only when values have been provided for all required fields.
• Endpoint browsing for a Partner Mailbox Endpoint is only available after it has been saved.

1. On the Edit Endpoint page, click the Browse Endpoint button to display a dialog box containing a directory listing. 

   

   For File System Endpoints, click the Connect button to display a directory listing.

   

2. Click the folders to navigate through the Endpoint.

   Note: You can still click the pencil tool and manually specify a path. The ability to browse by clicking on a folder provides a way to see the contents of an Endpoint without having to know about an exact path.

   

Defining the Event in Transformation Endpoints

Configure the Transformation Endpoint to include an Event—an object created in CIC Studio—that defines how data can be brought into the Integration Server for further transformation using your Data Flow.

To do this, simply set an Event (and related Business Process) from within the CIC Cockpit as part of Data Flow creation (with a Transformation Endpoint), shown below.  Any deployed Event in your workspace will be available for selection as you build the Data Flow.  

Note on parameters passed to the Event: While some pre-supplied Events (ReceiveEDI, for example) are preset with certain parameters, you can create custom events to pass other CIC metadata parameters - a requirement for non-EDI transformations. Parameters that can be passed include: 

• payload
• endpointId
• endpointName
• jobId
• fieId
• fileName

Note: You'll need to configure the Event parameters so that these reserved words are captured. For example, if you plan to use fileName to capture the name from an Endpoint (for example, partner mailbox), then you would configure a parameter called fileName on the Event object in Studio.