Manual Testing - experianplc/experian-data-studio-connector-mulesoft GitHub Wiki
Manual Testing of the Template
If for whatever reason you would like to test the Anypoint Template manually, without the usage of Pandora, either due to an inability to setup Pandora or to incorporate rules manually you may send a request to http://localhost:8083/collibra.connect.gateway
* manually.
* This is the default port and host. If you happen to change these settings in
Anypoint you will need to update this value accordingly.
In addition to the above host and port, you will need to set the following options:
- Authorization. By default your username is
connect_user
and password isconnect_password
. - Content-Type. A
Content-Type
header must be sent with the value ofapplication/x-www-form-urlencoded
.
Configuration Options
Property | Description | Required |
---|---|---|
externalSystemId | The name of the external system from which the results are retrieved. This property is used as External System Id for upserting the metrics. | Yes |
communityName | Based on this property, a Community named externalSystemId Community is created. The name of the community can be easily customized as described here. | Yes |
results | The list of data quality results. | Yes |
results.externalEntityId | External ID of the metric of a given result | Yes |
results.name | The name of the metric. Corresponds to the name of the created asset. | Yes |
results.description | The value of this attribute is set to the description attribute | No |
results.note | The value of this attribute is set to the note attribute | No |
results.dimension | The name of the dimension for a given metric. It has to be equal to one of the dimensions defined in DGC. If this property is defined, then the Classified by relation will be created from a given metric to the specified dimension. | No |
results.evaluatedColumns | A list of the database columns that have been used to calculate a particular result. If this property is specified, then relations from the result to evaluated columns are created. If the assets representing the evaluated columns do not exist, then they are created along with the context of the column (database, schema, table). | No |
results.evaluatedColumns.databaseName | The name of the database in which a given column exists. A domain representing a given database is created, or updated if it already exists. | Yes |
results.evaluatedColumns.schemaName | The name of the schema in which a given column exists. An asset representing a given schema is created, or updated if it already exists. By default, the name of the asset is generated by concatenating the databaseName and the schemaName, separated by the . character. | Yes |
results.evaluatedColumns.tableName | The name of the table in which a given column exists. An asset representing the given table is created, or updated if it already exists. By default, the name of the asset is generated by concatenating the databaseName, the schemaName and the tableName, separated by the . character. | Yes |
results.evaluatedColumns.name | The name of the column. An asset representing a given column is created, or updated if it already exists. By default, the name of the asset is generated by concatenating the databaseName, the schemaName, the tableName and the name, separated by the . charecter. | Yes |
results.rowsPassed | Corresponds to the Rows Passed attribute. | Yes |
results.rowsFailed | Corresponds to the Rows Failed attribute. | Yes |
results.qualityScore | Corresponds to the Passing fraction attribute. | Yes |
results.result | Corresponds to the Result attribute. | Yes, if threshold is undefined |
results.threshold | Is used to compute the result if result is undefined. The result is defined by following | |
expression: threshold < qualityScore | Yes, if result is undefined | |
results.customAttributes | A list of additional DGC attributes for a given metric. | No |
results.customAttributes.typeId | The ID of an attribute type in DGC. | Yes |
results.customAttributes.values | A list of values for an attribute defined by the results.customAttributes.typeId. | Yes |
The format of the request must be as shown below. The purpose of each option is specified above.
{
"externalSystemId":"Collibra External System ID",
"communityName":"Collibra Community Name",
"results":[
{
"externalEntityId":"External Entity ID",
"name":"Collibra Data Quality Metric Name",
"description":"Collibra Data Quality Rule Name.Collibra Dimension Name.Collibra Description",
"note":"Notes about metric",
"dimension":"Dimension Name",
"dataQualityRuleName":"Data Quality Rule Name",
"evaluatedColumns":[
{
"databaseName":"DATABASE_NAME",
"schemaName":"SCHEMA_NAME",
"tableName":"TABLE_NAME",
"name":"COLUMN_NAME"
}
],
"rowsPassed": 1,
"rowsFailed": 0,
"qualityScore": 1,
"result":true,
"threshold": 1,
"customAttributes":[
{
"typeId":"COLLIBRA_TYPE_ID",
"values":[
"COLLIBRA_VALUE"
]
}
]
}
]
}