1. User login

Requires the user to enter the account name and password of the system.

User Manual - 图1

2. Data access

The data access module displays a list of all tasks connected to the system within the current user authority, and can view, edit, update and delete the details of these tasks.

Click [Data Access], there are two steps to fill in data access information: business information, data stream.

User Manual - 图2

2.1 Business Information

2.1.1 Business Information

You are required to fill in basic business information for access tasks.

User Manual - 图3

  • Business English ID: Unified lowercase English name, please try to include the product name and concise specifications, such as pay_base
  • Business Chinese name: Chinese description of the business, easy to use and retrieve, up to 128 characters
  • Business responsible person: at least 2 people, the business responsible person can view and modify business information, add and modify all access configuration items
  • Business introduction: Cut SMS to introduce the business background and application of this access task:

2.1.2 Access requirements

Access requirements require users to choose message middleware: high throughput (TUBE):

User Manual - 图4

High-throughput-Tube: high-throughput message transmission component, suitable for log message transmission.

2.1.3 Access scale

The scale of access requires users to judge the scale of access data in advance, to allocate computing and storage resources later.

User Manual - 图5

2.2 Data stream

Click [Next] to enter the data flow information filling step. There are four modules for data flow information filling: basic information, data source, data information, and data stream.

In the data flow process, you can click [New Data Stream] to create a new data stream page:

User Manual - 图6

2.2.1 Basic information

You are required to fill in the basic information of the data stream in the access task:

User Manual - 图7

  • InLong stream id: The prefix is automatically generated according to the product/project, which is unique in a specific business group and is consistent with the stream id in the data source and the storage table
  • Data stream name: interface information description, the length is limited to 64 characters (32 Chinese characters)
  • Data stream owner: The data stream owner can view and modify data stream information, add and modify all access configuration items
  • Introduction to data flow: simple text introduction to data flow

2.2.2 Data source

You are required to select the source of the data stream.

Currently, three methods of file and independent push are supported, and the detailed information of the data source can be supplemented in the advanced options.

  • File: The business data is in the file, and the business machine deploys InLong Agent, which is read according to customized policy rules
  • Autonomous push: Push data to the messaging middleware through the SDK

User Manual - 图8

2.2.3 Data Information

You are required to fill in the data-related information in the data stream.

User Manual - 图9

  • Data Format
  • Data encoding: If the data source contains Chinese, you need choose UTF-8 or GBK, otherwise the encoding format is incorrect and garbled characters after storage
  • Source field separator: the format of data sent to MQ
  • Source data field: attributes with different meanings divided by a certain format in MQ

2.2.4 Data storage

You are required to select the final flow direction of this task, this part is not currently supports both hive storage and autonomous push.

User Manual - 图10

Add HIVE storage:

User Manual - 图11

  • Target database: hive database name (prepared to create in advance)
  • Target table: hive table name
  • First-level partition: the field name of the first-level subdirectory of hdfs data divided by hive data
  • Secondary partition: the field name of the first-level subdirectory of hdfs data divided by hive data
  • Username: hive server connection account name
  • User password: hive server connection account password
  • HDFS url: Hive bottom HDFS connection
  • JDBC url: jdbc url of hive server
  • Field related information: source field name, source field type, HIVE field name, HIVE field type, field description, and support deletion and addition-

3. Access details

3.1 Execution log

When the status of the data access task is “approved successfully” or “configuration failed”, the “execution log” function can be used to allow users to view the progress and details of the task.

User Manual - 图12

Click [Execution Log] to display the details of the task execution log in a pop-up window.

User Manual - 图13

The execution log will display the task type, execution result, execution log content, end time, and the end time of the execution of the access process. If the execution fails, you can “restart” the task and execute it again.

3.2 Task details

The business person in charge/following person can view the access details of the task, and can modify and update part of the information under the status of [Waiting Applying], [Configuration Successful], and [Configuration Failed].

There are three modules in the access task details: business information, data stream and data storage.

3.2.1 Business Information

Display the basic business information in the access task, click [Edit] to modify part of the content

User Manual - 图14

3.2.2 Data stream

Display the basic information of the data flow under the access task, click [New Data Flow] to create a new data flow information

User Manual - 图15

3.2.3 Data Storage

Display the basic information of the data flow in the access task, select different flow types through the drop-down box, and click [New Flow Configuration] to create a new data storage.

User Manual - 图16

4. Data consumption

Data consumption currently does not support direct consumption access to data, and data can be consumed normally after the approval process.

Click [New Consumption] to enter the data consumption process, and you need to fill in information related to consumption.

User Manual - 图17

4.1 Consumer Information

Applicants need to gradually fill in the basic consumer business information related to data consumption applications in the information filling module

User Manual - 图18

  • Consumer group name: The prefix is automatically generated according to the product/project. The brief name of the consumer must be composed of lowercase letters, numbers, and underscores. The final approval will assign the consumer name based on the abbreviation splicing
  • Consumer Responsible Person: At least 2 persons are required to choose the responsible person; the responsible person can view and modify the consumption information
  • Consumer target business group id: you need to select the business group id of the consumer data, you can click [Query] and select the appropriate business group id in the pop-up window User Manual - 图19
  • Data usage: select data usage usage
  • Data usage description: The applicant needs to briefly explain the items used and the purpose of the data according to their own consumption scenarios After completing the information, click [Submit], and the data consumption process will be formally submitted to the approver before it will take effect.

5. Approval management

The approval management function module currently includes my application and my approval, and all tasks of data access and consumption application approval in the management system.

5.1 My application

Display the current task list submitted by the applicant for data access and consumption in the system, click [Details] to view the current basic information and approval process of the task.

User Manual - 图20

5.1.1 Data access details

Data access task detailed display The current basic information of the application task includes: applicant-related information, basic information about application access, and current approval process nodes.

User Manual - 图21

5.1.2 Data consumption details

Data consumption task details display basic information of current application tasks including: applicant information, basic consumption information, and current approval process nodes.

User Manual - 图22

5.2 My approval

As a data access officer and system member with approval authority, have the responsibility for data access or consumption approval.

User Manual - 图23

5.2.1 Data Access Approval

New data access approval: currently it is a first-level approval, which is approved by the system administrator.

The system administrator will review whether the access process meets the access requirements based on the data access business information.

User Manual - 图24

5.2.2 New data consumption approval

New data consume approval: currently it is a first-level approval, which is approved by the person in charge of the business.

Business approval: The person in charge of the data access business judges whether the consumption meets the business requirements according to the access information:

User Manual - 图25

6. System Management

Only users with the role of system administrator can use this function. They can create, modify, and delete users:

User Manual - 图26

6.1 New user

Users with system administrator rights can create new user accounts

User Manual - 图27

  • Account types: Ordinary users (with data access and data consumption permissions, but without data access approval and account management permissions); system administrators (with data access and data consumption permissions, data access approval and account management permissions)
  • username: username for login
  • user password: -Effective duration: the account can be used in the system User Manual - 图28

6.2 Delete user

The system administrator can delete the account of the created user. After the deletion, the account will stop using:

User Manual - 图29

6.3 User Edit

The system administrator can modify the created account:

User Manual - 图30

The system administrator can modify the account type and effective duration to proceed:

User Manual - 图31

6.4 Change password

The user can modify the account password, click [Modify Password], enter the old password and the new password, after confirmation, the new password of this account will take effect:

User Manual - 图32