From a8842fc0b3164d60a4d31060f3e6e2413c826763 Mon Sep 17 00:00:00 2001 From: Joshua Shearer Date: Mon, 16 Sep 2019 14:02:11 -0400 Subject: [PATCH 1/6] Format table in README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e758a68..678b002 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ dotnet run ./bin/Debug/netcoreapp2.0/Compliance360.Import.dll [options] ``` The following lists the required command line options: + | Option | Description | | ------ | ----------- | | --filepath | The path to the *.CSV file to import | From 511bb8fa430ac4898fcb22356ca099c666cd34e6 Mon Sep 17 00:00:00 2001 From: Joshua Shearer Date: Mon, 16 Sep 2019 14:02:33 -0400 Subject: [PATCH 2/6] Remove trailing whitespace --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 678b002..9da4d41 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Compliance 360 Import (Simple batch import) ## Introduction The Compliance 360 Import application is a sample application that demonstrates importing data into Compliance 360 -in the simplest manner. It's focus is for third-party partners who intend on automating the importing of data into -a compliance 360 client organization on a regular basis. It first requires that the given C360 client organization -perform relevant integration configurations to permit this operation. +in the simplest manner. It's focus is for third-party partners who intend on automating the importing of data into +a compliance 360 client organization on a regular basis. It first requires that the given C360 client organization +perform relevant integration configurations to permit this operation. NOTE: This application is intended as a sample only. @@ -33,15 +33,15 @@ can configure mappings as needed. These would map an incoming field name to a cl mapping is required when the field names match. # Project Setup -The application is written in C# and is a .NET Core 2.0 based application. To build and run this application: -1. Ensure that you have the .Net Core Command-Line interface (CLI) tools installed. +The application is written in C# and is a .NET Core 2.0 based application. To build and run this application: +1. Ensure that you have the .Net Core Command-Line interface (CLI) tools installed. 2. Clone the repository. 3. From the command line run the following: ``` -- from the Compliance360.Import directory. dotnet restore dotnet build -``` +``` # Running the Application To run the app from the command lime: @@ -60,16 +60,16 @@ The following lists the required command line options: | --module | The module name of the target C360 Module. | | --component | The component name of the target C360 component. | -The command line options are in specified in the format: {option}[space]{value}. +The command line options are in specified in the format: {option}[space]{value}. ``` -Example: ---baseuri https://secure.compliance360.com --organization testorg --integrationkey DDIICZ1UORHTFNO5E8JTAVTEBWYH3ZGU9Y0JUPLKQHT --module inicidents --component incident --filepath Incidents-Incident-data.csv +Example: +--baseuri https://secure.compliance360.com --organization testorg --integrationkey DDIICZ1UORHTFNO5E8JTAVTEBWYH3ZGU9Y0JUPLKQHT --module inicidents --component incident --filepath Incidents-Incident-data.csv ``` # Processing Overview In general, this application posts all data to C360 in a single http request. The data to input is provided in the body of the authentication request in a simple json structure. ``` -Example: +Example: { "Incidents": { @@ -85,15 +85,15 @@ Example: "Name": "Sample Incident 02", "Resp. Party": "David Brown", "Description": "Description for Sample Incident 01" - } + } ] } } -``` +``` For convenience, this sample application reads data from a csv file and transforms it in to the above json structure. # API Documentation C360 APIs are documented in the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) format and can be found here: 1. [Security API](https://github.com/SAIGlobal/compliance360-security-api) 2. [Metadata API](https://github.com/SAIGlobal/compliance360-metadata-api) -3. [Data API](https://github.com/SAIGlobal/compliance360-data-api) +3. [Data API](https://github.com/SAIGlobal/compliance360-data-api) From 0e758172e78f530bd71ef64f5f9b4df119c262a9 Mon Sep 17 00:00:00 2001 From: Joshua Shearer Date: Mon, 16 Sep 2019 14:06:34 -0400 Subject: [PATCH 3/6] Indent nested lists --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9da4d41..19b526b 100644 --- a/README.md +++ b/README.md @@ -11,18 +11,18 @@ NOTE: This application is intended as a sample only. The C360 client organization must first do the following: 1. Create an Integration definition within the C360 website 2. This Integration will need configurations defined for it. Typically: - a. Unique identifier field (e.g. Import Id). This field can be used to supply a unique value to prevent duplicates. - b. Default Module Type (if other than 'Default') - c. Default Workflow Template - d. Default Division/Folder - e. Field Mappings (as needed) + - Unique identifier field (e.g. Import Id). This field can be used to supply a unique value to prevent duplicates. + - Default Module Type (if other than 'Default') + - Default Workflow Template + - Default Division/Folder + - Field Mappings (as needed) 3. Relay the following values for use in this application: - a. Organization - b. ApplicationKey + - Organization + - ApplicationKey 4. Relay the following target field information for use in this application: - a. Target C360 module name (e.g. Incidents) - b. Target C360 component name (e.g. Incident) - c. Target field names (e.g. Name, Description, etc.) + - Target C360 module name (e.g. Incidents) + - Target C360 component name (e.g. Incident) + - Target field names (e.g. Name, Description, etc.) ## Field Mappings C360 module components 'generally' have consistent fields and names from C360 client organization to From d94250eb2f50cf9c7fc4738ff25eb16dad6c7fd9 Mon Sep 17 00:00:00 2001 From: Joshua Shearer Date: Mon, 16 Sep 2019 14:07:20 -0400 Subject: [PATCH 4/6] Use correct header hierarchy --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 19b526b..864de8d 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ accommodated by configuring field mappings within the Integration definition. Ea can configure mappings as needed. These would map an incoming field name to a client field name. No mapping is required when the field names match. -# Project Setup +## Project Setup The application is written in C# and is a .NET Core 2.0 based application. To build and run this application: 1. Ensure that you have the .Net Core Command-Line interface (CLI) tools installed. 2. Clone the repository. @@ -42,8 +42,8 @@ The application is written in C# and is a .NET Core 2.0 based application. To bu dotnet restore dotnet build ``` +## Running the Application -# Running the Application To run the app from the command lime: ``` dotnet run ./bin/Debug/netcoreapp2.0/Compliance360.Import.dll [options] @@ -66,7 +66,7 @@ Example: --baseuri https://secure.compliance360.com --organization testorg --integrationkey DDIICZ1UORHTFNO5E8JTAVTEBWYH3ZGU9Y0JUPLKQHT --module inicidents --component incident --filepath Incidents-Incident-data.csv ``` -# Processing Overview +## Processing Overview In general, this application posts all data to C360 in a single http request. The data to input is provided in the body of the authentication request in a simple json structure. ``` Example: @@ -92,7 +92,7 @@ Example: ``` For convenience, this sample application reads data from a csv file and transforms it in to the above json structure. -# API Documentation +## API Documentation C360 APIs are documented in the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) format and can be found here: 1. [Security API](https://github.com/SAIGlobal/compliance360-security-api) 2. [Metadata API](https://github.com/SAIGlobal/compliance360-metadata-api) From cc8f22f12735bb7e493f06644b99fcaccbe12a12 Mon Sep 17 00:00:00 2001 From: Joshua Shearer Date: Mon, 16 Sep 2019 14:08:50 -0400 Subject: [PATCH 5/6] Add necessary whitespace around headings and lists --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 864de8d..672dcc0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Compliance 360 Import (Simple batch import) + ## Introduction The Compliance 360 Import application is a sample application that demonstrates importing data into Compliance 360 in the simplest manner. It's focus is for third-party partners who intend on automating the importing of data into @@ -8,7 +9,9 @@ perform relevant integration configurations to permit this operation. NOTE: This application is intended as a sample only. ## Configuration + The C360 client organization must first do the following: + 1. Create an Integration definition within the C360 website 2. This Integration will need configurations defined for it. Typically: - Unique identifier field (e.g. Import Id). This field can be used to supply a unique value to prevent duplicates. @@ -25,6 +28,7 @@ The C360 client organization must first do the following: - Target field names (e.g. Name, Description, etc.) ## Field Mappings + C360 module components 'generally' have consistent fields and names from C360 client organization to C360 client organization. However, C360 is highly customizable. Therefore it should be anticipated that field names 'could' differ. If it is critical to code to a standard specification this can be @@ -33,7 +37,9 @@ can configure mappings as needed. These would map an incoming field name to a cl mapping is required when the field names match. ## Project Setup + The application is written in C# and is a .NET Core 2.0 based application. To build and run this application: + 1. Ensure that you have the .Net Core Command-Line interface (CLI) tools installed. 2. Clone the repository. 3. From the command line run the following: @@ -67,6 +73,7 @@ Example: ``` ## Processing Overview + In general, this application posts all data to C360 in a single http request. The data to input is provided in the body of the authentication request in a simple json structure. ``` Example: @@ -90,10 +97,13 @@ Example: } } ``` + For convenience, this sample application reads data from a csv file and transforms it in to the above json structure. ## API Documentation + C360 APIs are documented in the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) format and can be found here: + 1. [Security API](https://github.com/SAIGlobal/compliance360-security-api) 2. [Metadata API](https://github.com/SAIGlobal/compliance360-metadata-api) 3. [Data API](https://github.com/SAIGlobal/compliance360-data-api) From e250952d5f9a78f3da6470b8cd6fcc0f043b1c75 Mon Sep 17 00:00:00 2001 From: Joshua Shearer Date: Mon, 16 Sep 2019 14:09:26 -0400 Subject: [PATCH 6/6] Specify language in code fences --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 672dcc0..bad9da2 100644 --- a/README.md +++ b/README.md @@ -43,15 +43,17 @@ The application is written in C# and is a .NET Core 2.0 based application. To bu 1. Ensure that you have the .Net Core Command-Line interface (CLI) tools installed. 2. Clone the repository. 3. From the command line run the following: -``` --- from the Compliance360.Import directory. -dotnet restore -dotnet build -``` + ```bash + # Run from the Compliance360.Import directory: + dotnet restore + dotnet build + ``` + ## Running the Application To run the app from the command lime: -``` + +```bash dotnet run ./bin/Debug/netcoreapp2.0/Compliance360.Import.dll [options] ``` @@ -75,7 +77,8 @@ Example: ## Processing Overview In general, this application posts all data to C360 in a single http request. The data to input is provided in the body of the authentication request in a simple json structure. -``` + +```json Example: { "Incidents":