Difference between revisions of "Fusion Registry Command Line"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Created page with "= Overview = The Fusion Registry command line client (FusionRegistryCL) runs on a Windows or UNIX command line, to support loading content to the Fusion Registry via the Fusi...")
 
(→‎Structures)
Line 9: Line 9:
  
 
== Structures ==
 
== Structures ==
−
To Publish structures call the publishStructures.bat (or sh) with the following commands:
+
To Publish structures call the '''publishStructures.bat''' (or sh) with the following commands:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 42: Line 42:
 
|-
 
|-
 
| u || false  || Username of a Fusion Registry user with permissions to load the structure file.<br/>
 
| u || false  || Username of a Fusion Registry user with permissions to load the structure file.<br/>
−
Not required if using Certificates for Authentication.|| -u myuser
+
Not required if using Certificates for Authentication.  
 +
|| -u myuser
 +
|-
 +
| p || false || Password of a Fusion Registry user with permissions to load the structure file. <br/>Not required if using Certificates for Authentication. || -p mypass
 +
|-
 +
| o || false || An output file to record which structures were added, modified or removed. || -o "C:/temp/Result.csv"
 +
|-
 +
| cert || false || File of Certificate to be used to authenticate with server (if username and password not used). <br/>Not required if using Username/Password for Authentication. || -cert "C:/Cert/mycert.p12"
 +
|-
 +
| certPwd || false || The Certificate Password. || -certPwd "password"
 +
|-
 +
| certType|| false || The Certificate Type to use. Defaults to PKCS12 if not specified || -certType "PKCS12"
 +
|}
 +
 
 +
 
 +
== Data ==
 +
To Publish structures call the '''publishData.bat''' (or sh) with the following commands:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Argument !! Required !! Purpose !! Example
 +
|-
 +
| uri || true || The location of the Data to load. <br/>This can resolve to a web URL or local file system. <br/>The format of the data file can be any supported Fusion Registry format. <br/>The file may also be in zip format. <br/>If this URI resolves to a folder on the file system, all the files in the folder will be submitted for import via a single zip file. <br/>It is possible to load multiple files/folder’s by supplying multiple Uris each separated by a semicolon
 +
||
 +
'''File''' <br/>
 +
-uri "file:///C:/Sample/Data.xml" <br/>
 +
-uri "file:///C:/Sample/Data.zip" <br/><br/>
 +
'''Folder''' <br/>
 +
-uri "file:///C:/SampleDir" <br/><br/>
 +
'''URL''' <br/>
 +
-uri "http://myserver/rest/data" <br/>
 +
-uri "http://myserver/file/data.xml" <br/><br/>
 +
'''Multiple''' <br/>
 +
-uri "http://myserver/rest/data; http://myserver/file/data.xml; file:///C:/SampleDir"
 +
|-
 +
| ref|| false || Optionally a Provision Agreement reference can be supplied, so the server can identify the Dataflow and Data Provider.
 +
This is not required if the data file contains this information.<br/>
 +
The format is Agency Id, Provision Id, Provision Version.
 +
|| -ref "ACY,PROV_ID,1.0"
 +
|-
 +
| u || false  || Username of a Fusion Registry user with permissions to load the structure file.<br/>
 +
Not required if using Certificates for Authentication.
 +
|| -u myuser
 
|-
 
|-
 
| p || false || Password of a Fusion Registry user with permissions to load the structure file. <br/>Not required if using Certificates for Authentication. || -p mypass
 
| p || false || Password of a Fusion Registry user with permissions to load the structure file. <br/>Not required if using Certificates for Authentication. || -p mypass

Revision as of 02:09, 19 June 2020

Overview

The Fusion Registry command line client (FusionRegistryCL) runs on a Windows or UNIX command line, to support loading content to the Fusion Registry via the Fusion Registry secure web services.

FusionRegistryCL is distributed with a single properties file fusionregistrycl.properties. This file needs to be modified to point to the server URL of the Fusion Registry to communicate with.

Batch files (Windows) and sh files (UNIX) are provided to support loading (and deleting) structures, data, and reference metadata.

Publishing Content

Structures

To Publish structures call the publishStructures.bat (or sh) with the following commands:

Argument Required Purpose Example
uri true The location of the Structures to load.
This can resolve to a web URL or local file system.
The format of the structure file can be any supported Fusion Registry format.
The file may also be in zip format.

File
-uri "file:///C:/Sample/Structures.xml"
-uri "file:///C:/Sample/Structures.zip"
URL
-uri "http://myserver/rest/conceptscheme"
-uri "http://myserver/file/structures.xml"

ds false The Data Source argument will create a link between all submitted Provision Agreements and a Data Source in the Fusion Registry. See Data Source Manager of Fusion Registry.

If not provided the Provision Agreements will default to using the REST or File Data Registration mechanism for data.

Fusion Store

-ds FUSION
Custom Data Store
-ds MY_SQL_STORE

a false Action – allowable actions are:
  • Append
  • Replace
  • FullReplace
  • Delete

The publish action, defaults to Replace.

Delete
-a DELETE
REPLACE
-a REPLACE
FullReplace
-a FullReplace

u false Username of a Fusion Registry user with permissions to load the structure file.

Not required if using Certificates for Authentication.

-u myuser
p false Password of a Fusion Registry user with permissions to load the structure file.
Not required if using Certificates for Authentication.		 -p mypass
o false An output file to record which structures were added, modified or removed. -o "C:/temp/Result.csv"
cert false File of Certificate to be used to authenticate with server (if username and password not used).
Not required if using Username/Password for Authentication.		 -cert "C:/Cert/mycert.p12"
certPwd false The Certificate Password. -certPwd "password"
certType false The Certificate Type to use. Defaults to PKCS12 if not specified -certType "PKCS12"


Data

To Publish structures call the publishData.bat (or sh) with the following commands:

Argument Required Purpose Example
uri true The location of the Data to load.
This can resolve to a web URL or local file system.
The format of the data file can be any supported Fusion Registry format.
The file may also be in zip format.
If this URI resolves to a folder on the file system, all the files in the folder will be submitted for import via a single zip file.
It is possible to load multiple files/folder’s by supplying multiple Uris each separated by a semicolon

File
-uri "file:///C:/Sample/Data.xml"
-uri "file:///C:/Sample/Data.zip"

Folder
-uri "file:///C:/SampleDir"

URL
-uri "http://myserver/rest/data"
-uri "http://myserver/file/data.xml"

Multiple
-uri "http://myserver/rest/data; http://myserver/file/data.xml; file:///C:/SampleDir"

ref false Optionally a Provision Agreement reference can be supplied, so the server can identify the Dataflow and Data Provider.

This is not required if the data file contains this information.
The format is Agency Id, Provision Id, Provision Version.

-ref "ACY,PROV_ID,1.0"
u false Username of a Fusion Registry user with permissions to load the structure file.

Not required if using Certificates for Authentication.

-u myuser
p false Password of a Fusion Registry user with permissions to load the structure file.
Not required if using Certificates for Authentication.		 -p mypass
o false An output file to record which structures were added, modified or removed. -o "C:/temp/Result.csv"
cert false File of Certificate to be used to authenticate with server (if username and password not used).
Not required if using Username/Password for Authentication.		 -cert "C:/Cert/mycert.p12"
certPwd false The Certificate Password. -certPwd "password"
certType false The Certificate Type to use. Defaults to PKCS12 if not specified -certType "PKCS12"
Retrieved from "https://wiki.sdmxcloud.org/index.php?title=Fusion_Registry_Command_Line&oldid=1790"