Creating Endpoints

Create an Endpoint - Walk Through

The first step to performing a sync is creating endpoints. To move content from a source repository to a destination repository you will need two separate endpoints. One for each repository.

Start by selecting "Endpoints" from the left. Then press the "Add Endpoints" button on the right.

This will take you to the create endpoint page. From here you can name the endpoint, select the associated connector, and set if the endpoint is active or not.

You can start by naming the endpoint, for this walk through the first endpoint will be named "my-source-endpoint", and setting the endpoint to active.

Do this by typing the name you want into the "Name" text box and pressing the "Active" checkbox. Note that endpoint names must be unique.

Selecting a Connector

Next you can select a connector to associate with the endpoint. To do this, press the"Select Option" drop down and choose a connector from the list. This walk through will use the "dotcms-connector".

After a connector is selected, a list of the properties for that connector will be listed. Properties are broken into two sections.

• source properties

  • Displayed for level 2 or 3 connectors

• destination properties

  • Displayed for level 1 or 3 connectors

If you want to use an endpoint as both a source and a destination endpoint in jobs, you will need to populate both source and destination properties. This is the best practice for creating an endpoint. For additional details about each property, view the related connector doc.

Note: If a connector is upgraded from level 1 or level 2 to level 3, you will need to update endpoint configurations that use this connector to include both source and destination config. Without updating to include all configuration, you will not be able to use the endpoint to have all functionality in Impulse.

For the purpose of this walk through, both source and destination properties will be populated.

Saving the Endpoint

Once the properties have been filled out you can save the endpoint. Press the "Add Endpoint" button to save the endpoint.

Once the endpoint is saved, you will be returned to the primary list endpoints page where you can see your new endpoint and create additional endpoints.

Create an Additional Endpoint

Now that one endpoint is created you can create a second endpoint. You will need two endpoints created to be able to create a job and perform a sync. To do this simply perform the same steps listed above for the new endpoint.

Endpoint Page Deep Dive

Viewing the Endpoints Page

To view a list of all the endpoints, select "Endpoints" on the left.

On this page, you can view all the endpoints you have created. There are a few pieces of information you can see for an endpoint from this page.

All endpoints will display their:

• Name

• Connector

• Related Jobs

• Status

• Additional actions for the endpoint

Filtering Endpoints

You can filter endpoints by if they are used as a source or destination in a job. As well as search by text.

Filter Source/Destination Endpoints

To filter by source/destination endpoints, select either "Sources" or "Destinations" above the list of endpoints.

To view all endpoints again, repress the highlighted option.

Filter by Name

You can filter the endpoints based on their names by inputting text into the "Search" text box. This will filter endpoints by name based on the input text.

More Actions

There are a number of additional actions that can be performed for an endpoint. Simply find the endpoint you want to perform the action for and press the downward arrow to view the list of actions.

Editing an Endpoint

To edit an endpoint, select the "Edit" action.

This action will show a similar screen as when you created the endpoint. From this screen you will be able to update the name, activity, connector, and properties for the endpoint.

To save the changes press the "Save Changes" button at the bottom of the page.

Note: These options will not appear if no changes were made.

If you made a change and do not want to save the change press the "Return to Endpoints" button at the top of the page.

Note: If a connector is upgraded from level 1 or level 2 to level 3, you will need to update endpoint configurations that use this connector to include both source and destination config. Without updating to include all configuration, you will not be able to use the endpoint to have all functionality in Impulse.