From 4b880683f7430f40c8fc40ef1e8fc2cc90b33e6a Mon Sep 17 00:00:00 2001 From: Hah Chung Khen Date: Mon, 20 Jul 2020 16:21:24 +0800 Subject: [PATCH 1/6] enhance README.md for 2.3.0 --- README.md | 47 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 08ab319..b2a4c5d 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,15 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl - [Configure withOnValueChanged](#configure-withonvaluechanged) - [Configure isCompleteHandler](#configure-iscompletehandler) - [Configure column layouts](#configure-column-layouts) + - [Configuration input context](#configuration-input-context) - [StepConfigurationBuilder sample code](#stepconfigurationbuilder-sample-code) - [Processing your step](#processing-your-step) - [Execute step](#execute-step) - [StepProcessorBuilder sample code](#stepprocessorbuilder-sample-code) - [Cell value style](#cell-value-style) - [isInteractive flag](#isinteractive-flag) - - [Progress bar handling](#progress-bar-handling) + - [Progress bar handling](#progress-bar-handling) + - [Processor input context](#processor-input-context) - [The Cache configuration](#the-cache-configuration) - [Cache scope](#cache-scope) - [Workflow](#workflow) @@ -78,7 +80,8 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl | SDK version | Compatible Data Studio version | New features released | |--------------------------------------------------------------------------------------|--------------------------------|-----------------------| -| 2.2.0 | 2.0.11 (or newer) | | +| 2.3.0 | 2.1.0 (or newer) | +| [2.2.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.2.0 | 2.0.11 (or newer) | | | [2.1.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.1) | 2.0.9 (or newer) | New custom icons added: | | [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.0) | 2.0.6 (or newer) || | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.0.0) | 2.0.0 (or newer) || @@ -267,6 +270,7 @@ Please take note that PROCESS output node cannot connect to DATA input node. .withNodes(stepNodeBuilder -> stepNodeBuilder .addInputNode(inputNodeBuilder -> inputNodeBuilder .withId(INPUT_ID) + .withLabel("Name (required)") .withType(NodeType.PROCESS) .build()) .addOutputNode(outputNodeBuilder -> outputNodeBuilder @@ -339,15 +343,16 @@ For example, to add a column chooser to the step: ##### asCustomChooser -| Method | Description | -|-------------------------|-----------------------------------------------------| -| asCustomChooser | Set an input column from a custom drop-down list | -| withAllowValuesProvider | Set the custom list for selection | -| withAllowSearch | Set whether there's a field search | -| withAllowSelectAll() | Set whether you can select all fields | -| withIsRequired() | Set whether the field is mandatory | -| withMultipleSelect() | Set whether multiple fields can be selected | -| build | Build the step property | +| Method | Description | +|-------------------------------|---------------------------------------------------------------| +| asCustomChooser | Set an input column from a custom drop-down list | +| withAllowValuesProvider | Set the custom list for selection | +| withAllowChooserItemsProvider | Set the custom list with display name and value for selection | +| withAllowSearch | Set whether there's a field search | +| withAllowSelectAll() | Set whether you can select all fields | +| withIsRequired() | Set whether the field is mandatory | +| withMultipleSelect() | Set whether multiple fields can be selected | +| build | Build the step property | #### Configure withOnValueChanged Since version 2.2.0, on-value-changed handler is added to all the step property types. The on-value-changed handler allows a step property to update another step property's value, when its own value is updated. @@ -468,7 +473,15 @@ Column layouts represent column(s) that will be displayed in the step. For examp .build()) ``` - +#### Configuration input context +ConfigurationInputContext is an instance that used to return metadata input columns. + +| Method | Description | +|-----------------|-------------------------------| +| getColumns | Get all input node columns | +| getColumnById | Get input node column by id | +| getColumnsByTag | Get input node columns by tag | + #### StepConfigurationBuilder sample code ``` java @@ -633,6 +646,16 @@ public StepProcessor createProcessor(final StepProcessorBuilder processorBuilder ``` Please take note that `progressChanged()` must not be called inside `outputColumnManager.onValue()`. +#### Processor input context +ProcessorInputContext is an instance that used to return metadata input columns. + +| Method | Description | +|-----------------|-------------------------------| +| getColumns | Get all input node columns | +| getColumnById | Get input node column by id | +| getColumnsByTag | Get input node columns by tag | +| getRowCount | Get row count | + ### The Cache configuration The cache object allows a custom step to cache its results, for later reuse. Each cache object is created and referenced by a particular name. It is useful for storing responses from slow services between instances of custom steps. From 46bfc237007d3effe14049082fe86fd343d18188 Mon Sep 17 00:00:00 2001 From: chungkhenhah <53897209+chungkhenhah@users.noreply.github.com> Date: Mon, 20 Jul 2020 16:49:59 +0800 Subject: [PATCH 2/6] add fix TFW for fail to retrieve value from getStepCell --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2a4c5d..e004b10 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl | SDK version | Compatible Data Studio version | New features released | |--------------------------------------------------------------------------------------|--------------------------------|-----------------------| -| 2.3.0 | 2.1.0 (or newer) | +| 2.3.0 | 2.1.0 (or newer) | | [2.2.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.2.0 | 2.0.11 (or newer) | | | [2.1.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.1) | 2.0.9 (or newer) | New custom icons added: | | [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.0) | 2.0.6 (or newer) || From a115c60c8810222e0b0a94346d4dfcfa9dc20402 Mon Sep 17 00:00:00 2001 From: chungkhenhah <53897209+chungkhenhah@users.noreply.github.com> Date: Tue, 21 Jul 2020 22:45:24 +0800 Subject: [PATCH 3/6] Fix missing 2.2.0 link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e004b10..1252219 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl | SDK version | Compatible Data Studio version | New features released | |--------------------------------------------------------------------------------------|--------------------------------|-----------------------| | 2.3.0 | 2.1.0 (or newer) | -| [2.2.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.2.0 | 2.0.11 (or newer) | | +| [2.2.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.2.0) | 2.0.11 (or newer) | | | [2.1.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.1) | 2.0.9 (or newer) | New custom icons added: | | [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.0) | 2.0.6 (or newer) || | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.0.0) | 2.0.0 (or newer) || From 192b2549d5079ff4276c1982b43be7bec7541c84 Mon Sep 17 00:00:00 2001 From: chungkhenhah <53897209+chungkhenhah@users.noreply.github.com> Date: Tue, 21 Jul 2020 23:12:53 +0800 Subject: [PATCH 4/6] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1252219..89babef 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl | SDK version | Compatible Data Studio version | New features released | |--------------------------------------------------------------------------------------|--------------------------------|-----------------------| -| 2.3.0 | 2.1.0 (or newer) | +| 2.3.0 | 2.1.0 (or newer) | | [2.2.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.2.0) | 2.0.11 (or newer) | | | [2.1.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.1) | 2.0.9 (or newer) | New custom icons added: | | [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.0) | 2.0.6 (or newer) || From abe5b5ca1d0c0f7c69bc15e3c0437a15720511e7 Mon Sep 17 00:00:00 2001 From: chungkhenhah <53897209+chungkhenhah@users.noreply.github.com> Date: Wed, 29 Jul 2020 10:00:42 +0800 Subject: [PATCH 5/6] Changing 2.2.0 to 2.3.0 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 89babef..f61803f 100644 --- a/README.md +++ b/README.md @@ -120,14 +120,14 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl } dependencies { - compileOnly("com.experian.datastudio:sdkapi:2.2.0") - compileOnly("com.experian.datastudio:sdklib:2.2.0") + compileOnly("com.experian.datastudio:sdkapi:2.3.0") + compileOnly("com.experian.datastudio:sdklib:2.3.0") } ``` If you don't want to use Gradle, you'll have to configure your own Java project to generate a compatible JAR artifact: - Create a new Java project or open an existing one. - - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.2.0/sdkapi-2.2.0.jar) file. + - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.3.0/sdkapi-2.3.0.jar) file. If using Maven, modify `pom.xml` to add the SDK GitHub repository: @@ -162,13 +162,13 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl com.experian.datastudio sdkapi - 2.2.0 + 2.3.0 provided com.experian.datastudio sdklib - 2.2.0 + 2.3.0 From 8b1e07b71ac7866b4f8eca87cf0b6f1fbc832fd7 Mon Sep 17 00:00:00 2001 From: chungkhenhah <53897209+chungkhenhah@users.noreply.github.com> Date: Wed, 29 Jul 2020 10:22:32 +0800 Subject: [PATCH 6/6] edit the release notes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f61803f..e24dff0 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl | SDK version | Compatible Data Studio version | New features released | |--------------------------------------------------------------------------------------|--------------------------------|-----------------------| -| 2.3.0 | 2.1.0 (or newer) | +| 2.3.0 | 2.1.0 (or newer) | | [2.2.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.2.0) | 2.0.11 (or newer) | | | [2.1.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.1) | 2.0.9 (or newer) | New custom icons added: | | [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.1.0) | 2.0.6 (or newer) ||