User Tools

Site Tools


nucleus

Nucleus

Nucleus allows you to seamlessly integrate one service directly to another service using our common document model by mapping your data end-to-end. Please ensure you have fulfilled the before integration requirements for the integrations you are planning on deploying. You can check the requirements by using the directory links below. After completing the requirements for your specified endpoint, you may continue to the setup instructions.

You will need to set up an adapter configuration for each endpoint you are integrating with.

Integration Setup

1. Contact Perspectium support at support@perspectium.com for instructions on setting up user profiles on Nucleus.

2. Dashboard

  • A. Clicking this will allow you to create a new integration process. Integration processes are IT service management processes such as incident, change request and problem.
  • B. Customize an existing integration process such as the name and process type.
  • C. Add a new adapter configuration for this integration process. Adapter configurations are used to map data between an endpoint and our common document model.
  • D. This will delete an integration process and all subsequent adapter configurations.
  • E. View and/or customize the details of an existing adapter configuration.

3. Integration Process

  • A. Select the integration process you would like to integrate. Integration processes are used as a common model for mapping information from one endpoint to another endpoint.
  • B. Give a descriptive title that will give you an indication of what integration it is. Generally, you want to describe the action and context of this integration and how it relates to your overall system.

4. Choose your endpoint

  • A. Select the endpoint you will be using in this integration. These are the services that you can map information from/to.

5. Configure your endpoint

Field Description Example
A. Client The client name for your endpoint. This will be used as the primary means of identification for this adapter configuration. The client name must only consist of letters and numbers. testclient01
B. Endpoint URL The URL for connecting to the selected endpoint. For more information on location your endpoint URL, refer to the pre-integration directions below. https://sampleurl.atlassian.net/rest/api/2/issue/
C. Endpoint User The username for your selected endpoint. myuser
D. Endpoint Password The password for your selected endpoint. mypassword
E. Use Repeater Agent Check to enable the Repeater Agent to replicate data to your local instance.

6. Inbound Mapping

Field Description Example
A. Action Define an action that will be used for this integration. insert, issue_created, etc.
B. Source Define the source defines the body this mapping will be originating. issue, common_incident, etc.
C. Adapter Field This is the adapter/API field that will be mapped. This must match the outbound API body exactly. Fields that have a parent structure such as JSON should be dot-walked according to the pre-integration instructions. reporter.name
D. Mapping Action → Copy Selecting this will copy the value of the mapped field one-to-one with no changes.
D. (cont.) Mapping Action → Scripted Selecting this field will engage user-defined scripts to transform values in a predefined pattern.
E. Common Object Field This is the common object field. It will be used as a common value to map outbound. priority
F. Delete Mapping Deletes the current mapping selected.
G. When the scripted option is selected, you may press the small button to the right of the dropdown to display the scripting modal.

7. Inbound Triggers

Field Description Example
A. Add “AND” Clause Adds a condition that must be true.
B. Add “OR” Clause Adds a condition that may be true.
C. Choose Field Choose the field in witch the condition will be dependent on. correlation ID
D. Choose Operator Choose the operator that will be used by the trigger. starts with, is, is not, etc.
E. Value The value that is used for the condition builder to determine if the record should be processed. 1234567
F. Delete Trigger Deletes the current trigger selected.

8. Outbound Mapping

  • The Outbound Mapping page is aesthetically the same as the Inbound Mapping page. However, when you set up mappings in this page, you are mapping the outbound payload from the common object field.





9. Outbound Triggers

  • The Outbound Triggers page is aesthetically the same as the Inbound Triggers page. However, when you set up triggers in this page, they will only affect records going outbound.

10. Finish

  • You will then receive a notification that your integration has been successfully setup. Remember, in order to do end-to-end data replication you must setup at least two adapter configurations for the same integration process.

Endpoint Requirements

These are the requirements for the supported endpoints for Nucleus (in no particular order).

Jira

ServiceNow to Jira Installation Configuration

Perspectium's ServiceNow to Jira SIAM integration allows for the replication of Issues and Incidents between your ServiceNow and Jira instances.

This integration of workflow between ServiceNow and Jira is vital to development efforts. With Perspectium's integration solutions you can enable DevOps through the seamless bi-directional data movement of Service requests, incidents, problem tasks, and much more.

The following are steps to install and configure the various components to implement the Jira SIAM integration for ServiceNow for the first time.

ServiceNow Installation and Configuration

Jira Installation and Configuration

2017/03/01 13:47 · Torren Sampson

2. Nucleus ID Custom Field

The Nucleus ID custom field in Jira will allow for the bonding of the Nucleus ID with the Jira ID. This needs to be done to ensure that both Nucleus and Jira can identify the issues/incidents being replicated. To set up a custom field you will need a Jira account with administrative access to your Jira instance or the project you wish to share from. View the Atlassian documentation for general information on creating or configuring a custom field. To create the Nucleus ID field:

  1. Create the field as a Text Field(single line)
  2. Name the field Nucleus ID exactly as it is shown here.
    1. The name of the field you create should have the exact capitalization shown here, as well as a space between Nucleus and ID.
  3. Set the screens that the field will be seen on. The fields should be prefaced by the project that you are sharing from.
    1. If you are doing multiple projects or adding projects make sure that that each project is listed here.
    2. More projects can be added by hitting the gear icon, selecting “Screens”, and then by hitting the checkbox for the respective projects.

Once the Nucleus ID field has been created and configured you will now need to find the customFieldId for it and provide that to Perspectium Support. This field is needed for the Nucleus setup and can be obtained in two ways:

  1. Obtaining the Nucleus ID field I.D. from the configure page URL
    1. Go to your ServiceNow Identifer field on the Custom Fields link under the Issues tab as an administrator
    2. Click on the settings menu for the Nucleus ID field
    3. Click the configure link
    4. Once on the configure page notice that the customFieldId is at the end of the URL for that page.
    5. This is the number that should be given to Perspectium Support.
  2. Obtaining it from the rest API
    1. Enter this URL https://yourInstanceName/rest/api/2/field substituting yourInstanceName for the name of your Jira instance.
    2. It should return a JSON file which you should then search for Nucleus ID
    3. On the line you find the Nucleus ID you should see customfield_#####
    4. The ##### you see is the customFieldId that should be given to Perspectium support.

If you are using any other custom fields that you wish to replicate provide Perspectium Support with the exact name of the field, the type of field, and the field's customFieldId.

Your Jira instance should now be set up to replicate to and from your ServiceNow instance.

For more information for setting up the ServiceNow Identifier field or other mapping features please see here.

ServiceNow to Jira Installation Configuration

Perspectium's ServiceNow to Jira SIAM integration allows for the replication of Issues and Incidents between your ServiceNow and Jira instances.

This integration of workflow between ServiceNow and Jira is vital to development efforts. With Perspectium's integration solutions you can enable DevOps through the seamless bi-directional data movement of Service requests, incidents, problem tasks, and much more.

The following are steps to install and configure the various components to implement the Jira SIAM integration for ServiceNow for the first time.

ServiceNow Installation and Configuration

Jira Installation and Configuration

2017/03/01 13:47 · Torren Sampson

Rally

1. Custom Fields
Defects

The Defects field only needs one custom field for ExternalID like this:

2017/03/15 18:09 · Paul Nguyen

User Stories and Features

Integration for Rally User Stories and Features need the following custom fields to be created: External ID, Priority, Assigned To, and Opened By.

To create these fields click the settings button in the top right corner.

Then select the “Workspace and Projects” option on the top menu. Next click your desired workspace.

Click the Projects option on the far left menu to view a list of all your projects. Select your desired project and click the Fields option on the far left menu to view a list of all the fields in that project.

Then use the dropdown to select type User Story or Feature and use the “+ New Field” button.

Note for fields like Assigned To and Opened By the Name needs to use an underscore for the space. For example:

For the Priority the configuration should be a Drop Down List with the options “1”, “2, “3” and “4” like this:

2. Create a dedicated Perspectium User

Click the settings button in the top right corner. Then click the ”+ Add New“ button. Make a dedicated Perspectium Integration user with Workspace Administrator permissions.

This user should not be a user account that a person would use to interactively log into Rally through the browser and create or update records.

2017/03/15 18:09 · Paul Nguyen
3. Create an API key

Create an API key, which you can create here.

2017/03/15 18:09 · Paul Nguyen

Remedy

Remedy for Nucleus will work without any prior setup.

Running multiple Remedy adapter configurations simultaneously for the same process and same endpoint will result in undefined behavior.

Salesforce

When creating an integration with Salesforce, your endpoint client name should be your [instance name].[organization name]

For example, you would set client to na00.Perspectium for the salesforce URL: https://c.na00.visual.force.com/ with the organization name as Perspectium.

nucleus.txt · Last modified: 2018/12/26 21:50 by seung.suh