api

Documentation

Index

• type BusinessRuleTaskActivityRequest
• type Exporter
• type GetDecisionReqDefRequest
• type GetGroupIDResponse
• type GetGroupIDsRequest
• type GetGroupUserRequest
• type GetGroupUserResponse
• type GetProcDefRequest
• type GetUserIDResponse
• type GetUserIDsRequest
• type InstanceRequest
• type ServiceTaskActivityRequest
• type UserTaskActivityRequest

Types

type BusinessRuleTaskActivityRequest

type BusinessRuleTaskActivityRequest struct {
	InstanceRequest *InstanceRequest
	Element         *bpmn.BusinessRuleTask
}

type Exporter

type Exporter interface {
	// GetProcDef get process definition by key
	GetProcDef(context.Context, *GetProcDefRequest) (*ent.ProcDef, error)
	// GetDecisionReqDef get decision requirement definition by key
	GetDecisionReqDef(context.Context, *GetDecisionReqDefRequest) (*ent.DecisionReqDef, error)
	// CreateUserTask create user task
	CreateUserTask(context.Context, *InstanceRequest, *bpmn.UserTask) (*ent.Task, error)
	// ClaimUserTask claim user task, if user task is claimed or error, return false
	ClaimUserTask(context.Context, *ent.CreateIdentityLinkInput) (added bool, err error)
	// Review approve or reject user task
	Review(ctx context.Context, input *ent.UpdateIdentityLinkInput, lastUndone int) error
	// GetUserIDs get user id by name. BPMN designer usually use username to identify user. the function convert username to id
	// if user not exist return empty slice.
	GetUserIDs(context.Context, *GetUserIDsRequest) (*GetUserIDResponse, error)
	// GetGroupIDs the function convert group name to id
	// if group not exist return empty slice.
	GetGroupIDs(context.Context, *GetGroupIDsRequest) (*GetGroupIDResponse, error)
}

Exporter 定义了外部系统接入工作流所需要实现的操作.

type GetDecisionReqDefRequest

type GetDecisionReqDefRequest struct {
	OrgID          int
	DecisionDefKey string
}

GetDecisionReqDefRequest is for exporter GetDecisionReqDef

type GetGroupIDResponse

type GetGroupIDResponse struct {
	GroupIDs []int
}

GetGroupIDResponse is for exporter GetGroupIDs

type GetGroupIDsRequest

type GetGroupIDsRequest struct {
	OrgID int
	Names []string
}

GetGroupIDsRequest is for exporter GetGroupIDs

type GetGroupUserRequest

type GetGroupUserRequest struct {
	TenantID int
	Name     string
}

GetGroupUserRequest is for exporter GetGroupUser

type GetGroupUserResponse

type GetGroupUserResponse struct {
	UserIDs []int
}

GetGroupUserResponse is for exporter GetGroupUser

type GetProcDefRequest

type GetProcDefRequest struct {
	TenantID   int // tenant id plus
	ProcDefKey string
}

GetProcDefRequest is for exporter GetProcDef

type GetUserIDResponse

type GetUserIDResponse struct {
	UserIDs []int
}

GetUserIDResponse is for exporter GetUserIDs

type GetUserIDsRequest

type GetUserIDsRequest struct {
	OrgID int
	Names []string
}

GetUserIDsRequest is for exporter GetUserIDs

type InstanceRequest

type InstanceRequest struct {
	*ent.ProcInst
	ProcDefKey string `json:"proc_def_key"`
	// ResourceKey 流程图资源路径,相对于流程图资源根目录
	ResourceKey string `json:"resource_name"`
	// 参数,用于在流程中传递业务数据.业务需要转化为map形式.
	Variables vars.Mapping `json:"variables"`
	// ResourcePath 流程图资源路径.测试时使用该参数简化数据初始化
	ResourcePath string `json:"-"`
}

InstanceRequest 流程启动请求参数,流程请求序列化为json格式,传递给流程引擎.

嵌入了ent.ProcInst.

type ServiceTaskActivityRequest

type ServiceTaskActivityRequest struct {
	InstanceRequest *InstanceRequest
	Element         *bpmn.ServiceTask
}

type UserTaskActivityRequest

type UserTaskActivityRequest struct {
	InstanceRequest *InstanceRequest
	Element         *bpmn.UserTask
}