This documentation supports the 21.05 version of BMC Helix CMDB.To view an earlier version, select the version from the Product version menu

Creating a data store connection for the data transfer


Before you import data into Atrium Integrator you must create a source data store connection. Atrium Integrator supports database and file-based (CSV and XML) types of data stores for the source data store. The next step is to create a connection to communicate with the BMC CMDB server (AR System), which is the destination for the data. 

The following diagram illustrates the steps involved in creating a data store connection for the data transfer.

Creating a store connection

AI_Datastore_diagram.png

Before you begin

  • You must have Administrator user or AI Admin user permissions to create and manage data stores.
  • For XML and CSV connection, the source files must be on the same or remote computer on which you have installed Atrium Integrator.
  • You must structure your XML source file based on the sample PULL_MONITOR.xml file that is located in the ARInstallationDirectory\diserver\data-integration\NGIE-Sample directory.
  • To enable you to create CSV or XML file data sources, Job_FileMetaLoader job is provided in Atrium Integrator sample jobs. Verify that you still have this job, or you will not be able to create CSV or XML data store connections with Atrium Integrator Carte server. For more information, see Atrium-Integrator-sample-jobs.
  • For a database connection, if you plan to create a response-enabled transformation, ensure that you have permissions to access the associated tables in the database.


To create a source data store

  1. On CMDB Portal, select Jobs > Manage Atrium Integrator
    The Data Imports page opens.
  2. Click Manage Data Stores.
    The Data Stores page opens and displays a list of defined data sources. 
  3. Click +Create Data Store.
    The Create Data Store section appears on the right side of the page.
  4. Select the Data Store Type.
    Enter information based on the data store type that you selected.

    For a database type of data store, enter the following information:


    Field

    Action

    Data Store Name

    Specify a name for the data store. Example: CFS_DB

    Database Host Name

    Specify only the server name, and not the fully qualified domain name in this field.
    Example: vm-aus-17382

    Database Name

    Enter the name of the database you want to connect to.

    Database Type

    Select the database type.

    Port

    The default port for the specified database is displayed.

    (optional) Database Instance Name

     For a SQL Server database, enter the instance name.

    Database User ID

    Enter the user ID and password to log in to the database.

    Database Password

    The following short animation shows the steps to create a database type of data store connection.

    DBDatastore_Trimmed_30July.gif

    For a CSV type of data store, enter the following information:


    Field

    Action

    Data Store Name

    Specify a name for the data store. Example: CFS_CSV

    Directory Path

    Specify the path to the folder that contains the source file.

    Carte Server

    Select the Atrium Integrator Carte server.

    The following short animation shows the steps to create a CSV type of data store connection.

    CSVDatastoreTrimmed_30July.gif

    For an XML type of data store, enter the following information:


    Field

    Action

    Data Store Name

    Specify a name for the data store. Example: CFS_XML

    Directory Path

    Specify the path to the folder that contains the source file.

    Carte Server

    Select the Atrium Integrator Carte server.


    The following short animation shows the steps to create an XML data store connection.

    XMLDatastore_trimmed_28thJuly.gif

  5. (optional) Click Test Data Store to verify the source data store connection parameters.
    If the server is not reachable, you can still save the data store and test it later on. 
  6. Click Save.
    The data store connection is created and displayed in the Data Stores section.


To create a source data store in BMC Helix CMDB

If you have deployed BMC Helix CMDB as a container image in your on-premises environment, or if you are a SaaS subscriber, you cannot copy flat files, such as CSV and XML directly on the server. You must first create entries in the UDM attachment form. While creating a CSV or XML data store, these attachment files are available in the Attachment Set Name list.  

  1. On AR System server, open the UDM:Attachments form by using the URL http://<server-name>:<port>/arsys/forms/<server-name>/UDM:Attachments.
    UDMFormAttachment.png
  2. Add the CSV or XML file as an attachment.

    Perform the following steps:

    a. Click New Request.

    b. Specify a name for the Attachment Set Name.
     An attachment set can have more than one attachments.

    c. To add an attachment, click Add.

    d. Click Choose File.

    e. Click OK.

    f. Click Save.

    g. (optional) To add another file to this attachment set, click New request..

    h. (optional) Select the attachment set name from the Attachment Set Name drop-down list.

    i. (optional) Repeat steps c to f.

  3. Log in to CMDB Portal. 
  4. Select Jobs > Manage Atrium Integrator
    The Data Imports page opens.
  5. Click Manage Data Stores
    The Data Stores page opens and displays a list of defined data sources. 
  6. Click +Create Data Store
    The Create Data Store section appears on the right side of the page.
  7. Select the Data Store Type.
    Enter information based on the data store type that you selected.

    Field

    Action

    Data Store Name

    Specify a name for the data store.

    Attachment Set Name

    Select the attachment from the list.

    Carte Server

    Select the Atrium Integrator Carte server.

    CreateDataStore_container.png

  8. (optional) Click Test Data Store to verify the source data store connection parameters.
    If the server is not reachable, you can still save the data store and test it later. 
  9. Click Save.
    The data store connection is created and displayed in the Data Stores section.

For more information about BMC Helix ITSM, see:


Important

  • If you are using MySQL database version 8.0.19, you might have issues with creating a data store. Upgrade to a latest version of MySQL and create the data store.
  • If you are using MySQL database version 8.0.14 or 8.0.23 and later, you must set the variable Global Time Zone to an appropriate time zone on server-side.

To create a target data store

  1. On CMDB Portal, select Jobs > Manage Atrium Integrator
    The Data Imports page opens.
  2. Click Manage Data Stores
    The Data Stores page opens and displays a list of defined data sources. 
  3. Click +Create Data Store
    The Create Data Store section appears on the right side of the page as shown in the following figure.
  4. Select the Data Store Type as ARSYSTEM because the data will be imported in the AR System only.
  5. Type a name for the Datastore in the Data Store Name field.
    The data store name is a meaningful name for the data store that is used when creating a job.
  6. In the AR Server Name field, type the name of your AR System server.
    The default port for the specified database is displayed. 
  7. Specify the Remedy App Service password.
    The following short animation shows the steps to create a target data store connection.

    ARSystemDatastoreTrimmed.gif

  8. (optional) Click Test Data Store to ensure that you can connect to BMC Helix CMDB.
    If the server is not reachable, you can still save the data store and test it later on. 
  9. Click Save.



About editing a data store connection

You can edit the details of a data store but you cannot edit the data store name. When you edit the details of a data store, such as port number,  jobs that were created before this data store was edited still have the previous details and are not updated automatically. Hence, you must manually update the details of previously created jobs.


About deleting a data store connection

You can delete a data store that you created. If you delete a data store on which the jobs are dependent, it does not impact the jobs because the details of the data store are embedded in the job. But, if you make changes to the data store, you must update your jobs manually because the jobs are not updated automatically.  


To refresh a data store connection

For file-based data stores, such as CSV files and XML files, you must manually refresh the data store.

To manually refresh a data store, select the data store, and then click Refresh.
When you refresh a data store, the application recreates all the file-based mappings and creates reference data, which is then used in future for creating a job.