FileSurveys:survey-csv-file

Resource Use:

Survey Resource

Resource Use Description:

Connector supports the schema extraction and profiling of data in a CSV file.

Unique Name:

FileSurveys:survey-csv-file

GUID:

fcd7ddce-b61e-49eb-b993-293907dadf72

Resource Type:

GovernanceActionType

Resource Source:

CoreContentPack

Supported Request Parameters:

Name	Type	Required	Example	Description
ignoreAnalysisSteps	array<string>	false	step3,step4	Provide a list of analysis steps to ignore. This has to be used with care because some analysis steps build on the work of earlier analysis steps, and so ignoring one of these earlier steps will prevent later steps from running.

Produced Annotations:

Derive Schema From Data

summary: Extract schema from column names and values.
analysisStep: Profiling Associated Resources
typeName: SchemaAnalysisAnnotation
producedAnnotationTypeName: Derive Schema From Data
explanation: The schema is built using the values in the first line of the CSV file. The survey action service will attempt to derive the type of data in each column based on the values stored. If this is not possible the type of the column is assumed to be string.

Extract File Properties

summary: Extract properties from the file.
Executable file?: Can this file be executed as a program?
Deployed Implementation Type: Name of a particular type of technology. It is more specific than the open metadata types and increases the precision in which technology is catalogued. This helps human understanding and enables connectors and other actions to be targeted to the right technology.
analysisStep: Profiling Associated Resources
Open metadata type name for asset: The open metadata type used to catalog this type of file.
File encoding: Type of encoding scheme used on the data.
Record Count: How many record does this data file contain?
typeName: ResourceMeasureAnnotation
Last modified time: The time that the file was last modified.
Writeable file?: Can this file be updated?
explanation: Extract the properties that visible through the standard File interface and classify the file using reference data.
File name: The name of the file with extension.
Hidden file?: Is this file hidden from standard users?
Path name: The fully qualified physical location of the data store.
Last accessed time: The time that the file was last accessed.
File Size: How many bytes are in the file.
Readable file?: Can this file be read?
File Extension: The file extension used at the end of the file's name. This identifies the format of the file.
producedAnnotationTypeName: Extract File Properties
Creation time: The time that the file was created.
File type: File type descriptor (or logical file type) typically extracted from the file name.
Linked file?: Is this file a symbolic link to a file in another location?

Produced Guards:

Name	Completion Status	Completion Status Description	Description
survey-invalid	Invalid	The governance action service has not performed the requested action because it is not appropriate (for example, a false positive).	The survey did not run because the supplied information (such as the asset) is invalid for this type of survey.
survey-failed	Failed	The governance action service failed to execute the requested action.	An unexpected error occurred during the survey process. The survey report is incomplete.
survey-completed	Actioned	The governance action service for the governance action has successfully completed processing.	The survey completed successfully. The survey report is attached to the asset.

Supported Analysis Step:

Step Name	Description
Measure Resource	The survey action service is taking measurements from the resource.
Profile Data	The survey action service is profiling the data associated with the resource.
Check Asset	The survey action service is checking that the asset is of the correct type and the connection defines the correct type of connector.
Schema Extraction	The survey action service is extracting the schema from the resource.

Supported Targets:

Name	Type	Required	Implementation Type	Description
fileToSurvey	CSVFile	false	CSV Data File	The CSVFile asset that describes the physical file to survey

Produced Targets:

Name	Type	Required	Description
surveyReport	SurveyReport	false	The survey report created by a survey action service.
steward	Actor	false	The person, or team who is responsible for setting up the governance metadata associated with .
stewardAction	ToDo	false	To Do element created for the steward.