Connection Profile 3.5 - gflewis/sndml3 GitHub Wiki

The Connection Profile is a properties file that looks like this:

app.instance=dev00000
app.username=datapump.agent
app.password=******
app.agent=main

reader.instance=dev00000
reader.username=datapump.reader
reader.password=******

database.url=jdbc:mysql://localhost/sndm
database.schema=sndm
database.username=admin
database.password=******

The connection profile is specified with the -p (or --profile) command line option.

java -jar sndm-3.n.n-mysql.jar -p profile -y yamlfile

Beginning with release 3.5, the loader uses two separate connections for communicating with the ServiceNow instance. If you have installed and are using the DataPump App, then it is recommended that you use two separate user accounts.

• reader — These credentials are used to read data records from the instance. This account should be granted snc_read_only role, plus additional roles as required to access the records being exported. This account also requires soap_query.
• app — These credentials are used to connect to the DataPump App, but are not used to read data. This account should be granted x_108443_sndml.daemon role. This account is unnecessary if you are using the command line (YAML) loader.

If you are NOT using the DataPump App, then you only need to specify a reader account. However, you must insure that account has read access to the following ServiceNow tables in order to create new SQL tables in the database:

• sys_db_object
• sys_dictionary
• sys_glide_object

Database username, password and schema are required unless you are using SQLite. For SQLite you only need to provide a URL. The value of datamart.schema will vary based on the DBMS.

• For MySQL, datamart.schema should be the name of the database
• For Oracle, datamart.schema should be the name of the user
• For Microsoft SQL Server, datamart.schema should be dbo
• For SQLite, datamart.schema should be main or left blank

The loader will interpolate environment variables using the notation ${varname}. For example, if the environment variable SNDML_CONFIG has been defined, then you can do something like this:

loader.metrics_folder=${SNDML_CONFIG}/metrics

If the entire property value is enclosed in backticks, then it will be passed to Runtime.exec() for evaluation. For example, if you have the LastPass CLI installed in /usr/local/bin, then you may be able to do something like this:

reader.password=`/usr/local/bin/lpass show --password my.servicenow.reader.password`
app.password=`/usr/local/bin/lpass show --password my.servicenow.datapump.password`
database.password=`/usr/local/bin/lpass show --password my.database.password`

Alternate names are provided for some properties in order to maintain backwards compatibility with earlier versions of the code. The list of property default values and alternate names is maintained in the file property_names.xml.