Documentacion: ManageEmail_TasksAndGoals

Descripcion: Complete description of the tasks, interactions, facts and events involved in the workflow ManageEmail. The workflow goal is to classify an e-mail and put it in a folder according its category.

The workflow begins with an EmailWrapper event about new e-mail represented by the NewMailArrived event. This event is consumed by OrganizeEmail which organizes the suitable request. The task tries to obtain the e-mail related with the event. If it is not possible, the task generates an EmailNotAvailable fact. If the task obtains the e-mail, it generates an EmailToClassify fact. ClassifyEmail workflow consumes EmailToClassify fact and performs the activities to obtain the e-mail category. As a result, it could generate one of two facts: EmailCategory or EmailNotClassifiable. MoveEmail workflow consumes EmailCategory fact and performs the activities to move the classified e-mail to its folder. This workflow could generate one of two facts: EmailClassified or EmailNotMoved. After the previous processes, the OrganizeEmailManager has a response to the e-mail process request. The e-mail classified and moved (EmailClassified fact) or the resulting error (EmailNotAvailable, EmailNotClassifiable or EmailNotMoved facts) are communicated to the user thanks to the ProcessNotification task.


Instancias de entidades de meta-modelo

EntidadEntidad del meta-modeloDocumentacion
Categorizer 
AplicacionInterna  It is a wrapper to a text mining tool. It manages a category taxonomy.
It provides operations to create new categories, add documents to these categories, obtain a category list and to get the category of a document. 
EmailWrapper 
AplicacionInterna  Wrapper for a mailing tool.
It has operations to get the mail folders and the mails in them and to move mails between folders. It also has an event which notifies there is new email. 
UserDevice 
AplicacionInterna  It represents every device used to communicate with users.
It provides operations to send and receive general notifications from or to the interface and to receive requests about adding or removing agents. 
NewMailArrived 
EventoAplicacionSlots  Event triggered by the EmailWrapper when there is new incoming email. 
ClassifyEmail 
FlujoDeTrabajo  Describes the workflow to classify an e-mail. 
MoveEmail 
FlujoDeTrabajo  Describes the workflow to move a classified e-mail to its corresponding folder. 
DocumentClassified 
Hecho  Document classified and its category. 
DocumentNotification 
Hecho  It is the superclass of the facts generating information that should be shown to the user about documents. 
DocumentToClassify 
Hecho  Document to be classified. 
EmailCategory 
Hecho  Email classified and its category. The category has information about the movement target folder. 
EmailClassified 
Hecho  Email moved. It has a default status OK. 
EmailNotAvailable 
Hecho  The EmailWrapper could not obtain the email indicated in the event. 
EmailNotClassifiable 
Hecho  Email that could not be classified and the reason of it. 
EmailNotMoved 
Hecho  Email that could not be moved to its corresponding folder and the reason of it. 
EmailToClassify 
Hecho  Email to be classified.
It has four attributes: the e-mail owner (user), the folder in which is the e-mail, the e-mail id in the system, and the e-mail document. 
ClassifyDocument 
Tarea  Organize the classification process. It classifies a given document in one category or asks the user to do it. 
ClassifyEmail 
Tarea  Classify a given e-mail in one category doing the necessary additional mail processing. 
MoveEmail 
Tarea  Move a given e-mail to the folder related to its category. 
OrganizeEmails 
Tarea  Perceives an event about new email and triggers the interactions needed to classify the email and move it to the adequate folder. 
ProcessEmail 
Tarea  Convert an e-mail to a document processable by the Categorizer. 
ProcessNotification 
Tarea  This task sends a notification to the UserDevice. 


Categorizer (AplicacionInterna)

Properties:
IDCategorizer 
DescripcionIt is a wrapper to a text mining tool. It manages a category taxonomy.
It provides operations to create new categories, add documents to these categories, obtain a category list and to get the category of a document. 
OperacionescreateCategory addDocumentsToCategory enableCategorizer disableCategorizer getDocumentCategory getCategoryList  

Relaciones:
En el rolEn la relacion Otros extremos
WFUsaDR WFUsa 
Con los objetosEn el rol
ClassifyDocument  WFUsaOR
 


EmailWrapper (AplicacionInterna)

Properties:
IDEmailWrapper 
DescripcionWrapper for a mailing tool.
It has operations to get the mail folders and the mails in them and to move mails between folders. It also has an event which notifies there is new email. 
OperacionesgetMailFolders getEmailsInFolder moveEmailToFolder newEmailReceived  

Relaciones:
En el rolEn la relacion Otros extremos
WFUsaDR WFUsa 
Con los objetosEn el rol
OrganizeEmails  WFUsaOR
WFUsaDR WFUsa 
Con los objetosEn el rol
MoveEmail  WFUsaOR
 


UserDevice (AplicacionInterna)

Properties:
IDUserDevice 
DescripcionIt represents every device used to communicate with users.
It provides operations to send and receive general notifications from or to the interface and to receive requests about adding or removing agents. 
OperacionessentMesage receiveMessage addNewAgent removeAgent  

Relaciones:
En el rolEn la relacion Otros extremos
WFUsaDR WFUsa 
Con los objetosEn el rol
ProcessNotification  WFUsaOR
 


NewMailArrived (EventoAplicacionSlots)

Properties:
IDNewMailArrived 
DescripcionEvent triggered by the EmailWrapper when there is new incoming email. 
aplicacion 
slotsuser folder mailID  

Relaciones:
En el rolEn la relacion Otros extremos
WFConsumeDR WFConsume 
Con los objetosEn el rol
OrganizeEmails  WFConsumeOR
 


ClassifyEmail (FlujoDeTrabajo)

Properties:
IDClassifyEmail 
DescripcionDescribes the workflow to classify an e-mail. 

Relaciones:
En el rolEn la relacion Otros extremos
WFConsumeOR WFConsume 
Con los objetosEn el rol
EmailToClassify  WFConsumeDR
WFProduceOR WFProduce 
Con los objetosEn el rol
EmailCategory  WFProduceDR
WFProduceOR WFProduce 
Con los objetosEn el rol
EmailNotClassifiable  WFProduceDR
 


MoveEmail (FlujoDeTrabajo)

Properties:
IDMoveEmail 
DescripcionDescribes the workflow to move a classified e-mail to its corresponding folder. 

Relaciones:
En el rolEn la relacion Otros extremos
WFConsumeOR WFConsume 
Con los objetosEn el rol
EmailCategory  WFConsumeDR
WFProduceOR WFProduce 
Con los objetosEn el rol
EmailClassified  WFProduceDR
WFProduceOR WFProduce 
Con los objetosEn el rol
EmailNotMoved  WFProduceDR
 


DocumentClassified (Hecho)

Properties:
NombreDocumentClassified 
DescripcionDocument classified and its category. 
SlotsNombre slot:documentID
Descripcion slot:Unique Document ID in the system.

Nombre slot:document
Descripcion slot:The whole document to be processed.

Nombre slot:category
Descripcion slot:Category assigned to the document.

 

Relaciones:
En el rolEn la relacion Otros extremos
WFConsumeDR WFConsume 
Con los objetosEn el rol
ClassifyEmail  WFConsumeOR
WFProduceDR WFProduce 
Con los objetosEn el rol
ClassifyDocument  WFProduceOR
 


DocumentNotification (Hecho)

Properties:
NombreDocumentNotification 
DescripcionIt is the superclass of the facts generating information that should be shown to the user about documents. 
SlotsNombre slot:user
Descripcion slot:Document owner.

Nombre slot:folder
Descripcion slot:Folder or address in which the document is.

Nombre slot:documentID
Descripcion slot:Unique Document ID in the system.

Nombre slot:category
Descripcion slot:Category assigned to the document.

Nombre slot:status
Descripcion slot:Action status. It can be a Classification status, an Agent Status or a Category Status. Classification Status shows the reason of the no document obtaining, classification or movement. Agent Status shows the reason of the no agent adding, removing or listing. Category Status shows the reason of the fail in an operation requested by the user over the categories or its documents.

 

Relaciones:
En el rolEn la relacion Otros extremos
GTHerenciaDR GTHerenciaHecho 
Con los objetosEn el rol
EmailClassified  GTHerenciaOR
GTHerenciaDR GTHerenciaHecho 
Con los objetosEn el rol
EmailNotAvailable  GTHerenciaOR
GTHerenciaDR GTHerenciaHecho 
Con los objetosEn el rol
EmailNotClassifiable  GTHerenciaOR
GTHerenciaDR GTHerenciaHecho 
Con los objetosEn el rol
EmailNotMoved  GTHerenciaOR
WFConsumeDR WFConsume 
Con los objetosEn el rol
ProcessNotification  WFConsumeOR
 


DocumentToClassify (Hecho)

Properties:
NombreDocumentToClassify 
DescripcionDocument to be classified. 
SlotsNombre slot:documentID
Descripcion slot:Unique Document ID in the system.

Nombre slot:document
Descripcion slot:The whole document to be processed.

Nombre slot:type
Descripcion slot:Document type. It would be: email, HD Document, paper... It could be necessary to use different categories depending of the document type.

 

Relaciones:
En el rolEn la relacion Otros extremos
WFConsumeDR WFConsume 
Con los objetosEn el rol
ClassifyDocument  WFConsumeOR
WFProduceDR WFProduce 
Con los objetosEn el rol
ProcessEmail  WFProduceOR
 


EmailCategory (Hecho)

Properties:
NombreEmailCategory 
DescripcionEmail classified and its category. The category has information about the movement target folder. 
SlotsNombre slot:user
Descripcion slot:Document owner.

Nombre slot:folder
Descripcion slot:Folder or address in which the document is.

Nombre slot:mailID
Descripcion slot:Unique Mail ID in the system. It is a Document ID.

Nombre slot:mail
Descripcion slot:The whole mail to be processed. It is a document.

Nombre slot:category
Descripcion slot:Category assigned to the document.

 

Relaciones:
En el rolEn la relacion Otros extremos
WFConsumeDR WFConsume 
Con los objetosEn el rol
MoveEmail  WFConsumeOR
WFConsumeDR WFConsume 
Con los objetosEn el rol
MoveEmail  WFConsumeOR
WFProduceDR WFProduce 
Con los objetosEn el rol
ClassifyEmail  WFProduceOR
WFProduceDR WFProduce 
Con los objetosEn el rol
ClassifyEmail  WFProduceOR
 


EmailClassified (Hecho)

Properties:
NombreEmailClassified 
DescripcionEmail moved. It has a default status OK. 
SlotsNombre slot:user
Descripcion slot:Document owner.

Nombre slot:folder
Descripcion slot:Folder or address in which the document is.

Nombre slot:mailID
Descripcion slot:Unique Mail ID in the system. It is a Document ID.

Nombre slot:category
Descripcion slot:Category assigned to the document.

 

Relaciones:
En el rolEn la relacion Otros extremos
GTHerenciaOR GTHerenciaHecho 
Con los objetosEn el rol
DocumentNotification  GTHerenciaDR
WFProduceDR WFProduce 
Con los objetosEn el rol
MoveEmail  WFProduceOR
WFProduceDR WFProduce 
Con los objetosEn el rol
MoveEmail  WFProduceOR
 


EmailNotAvailable (Hecho)

Properties:
NombreEmailNotAvailable 
DescripcionThe EmailWrapper could not obtain the email indicated in the event. 
SlotsNombre slot:user
Descripcion slot:Document owner.

Nombre slot:folder
Descripcion slot:Folder or address in which the document is.

Nombre slot:mailID
Descripcion slot:Unique Mail ID in the system. It is a Document ID.

Nombre slot:status
Descripcion slot:Action status. It can be a Classification status, an Agent Status or a Category Status. Classification Status shows the reason of the no document obtaining, classification or movement. Agent Status shows the reason of the no agent adding, removing or listing. Category Status shows the reason of the fail in an operation requested by the user over the categories or its documents.

 

Relaciones:
En el rolEn la relacion Otros extremos
GTHerenciaOR GTHerenciaHecho 
Con los objetosEn el rol
DocumentNotification  GTHerenciaDR
GTModificaDR GTFallaObjetivo
  • CondicionMental: 
  •  
    Con los objetosEn el rol
    OrganizeEmails  GTModificaOR
     


    EmailNotClassifiable (Hecho)

    Properties:
    NombreEmailNotClassifiable 
    DescripcionEmail that could not be classified and the reason of it. 
    SlotsNombre slot:user
    Descripcion slot:Document owner.

    Nombre slot:folder
    Descripcion slot:Folder or address in which the document is.

    Nombre slot:mailID
    Descripcion slot:Unique Mail ID in the system. It is a Document ID.

    Nombre slot:status
    Descripcion slot:Action status. It can be a Classification status, an Agent Status or a Category Status. Classification Status shows the reason of the no document obtaining, classification or movement. Agent Status shows the reason of the no agent adding, removing or listing. Category Status shows the reason of the fail in an operation requested by the user over the categories or its documents.

     

    Relaciones:
    En el rolEn la relacion Otros extremos
    GTHerenciaOR GTHerenciaHecho 
    Con los objetosEn el rol
    DocumentNotification  GTHerenciaDR
    GTModificaDR GTFallaObjetivo
  • CondicionMental: 
  •  
    Con los objetosEn el rol
    ClassifyEmail  GTModificaOR
    WFProduceDR WFProduce 
    Con los objetosEn el rol
    ClassifyEmail  WFProduceOR
     


    EmailNotMoved (Hecho)

    Properties:
    NombreEmailNotMoved 
    DescripcionEmail that could not be moved to its corresponding folder and the reason of it. 
    SlotsNombre slot:user
    Descripcion slot:Document owner.

    Nombre slot:folder
    Descripcion slot:Folder or address in which the document is.

    Nombre slot:mailID
    Descripcion slot:Unique Mail ID in the system. It is a Document ID.

    Nombre slot:category
    Descripcion slot:Category assigned to the document.

    Nombre slot:status
    Descripcion slot:Action status. It can be a Classification status, an Agent Status or a Category Status. Classification Status shows the reason of the no document obtaining, classification or movement. Agent Status shows the reason of the no agent adding, removing or listing. Category Status shows the reason of the fail in an operation requested by the user over the categories or its documents.

     

    Relaciones:
    En el rolEn la relacion Otros extremos
    GTHerenciaOR GTHerenciaHecho 
    Con los objetosEn el rol
    DocumentNotification  GTHerenciaDR
    WFProduceDR WFProduce 
    Con los objetosEn el rol
    MoveEmail  WFProduceOR
     


    EmailToClassify (Hecho)

    Properties:
    NombreEmailToClassify 
    DescripcionEmail to be classified.
    It has four attributes: the e-mail owner (user), the folder in which is the e-mail, the e-mail id in the system, and the e-mail document. 
    SlotsNombre slot:user
    Descripcion slot:Document owner.

    Nombre slot:folder
    Descripcion slot:Folder or address in which the document is.

    Nombre slot:mailID
    Descripcion slot:Unique Mail ID in the system. It is a Document ID.

    Nombre slot:mail
    Descripcion slot:The whole mail to be processed. It is a document.

     

    Relaciones:
    En el rolEn la relacion Otros extremos
    WFConsumeDR WFConsume 
    Con los objetosEn el rol
    ClassifyEmail  WFConsumeOR
    WFConsumeDR WFConsume 
    Con los objetosEn el rol
    ClassifyEmail  WFConsumeOR
    WFProduceDR WFProduce 
    Con los objetosEn el rol
    OrganizeEmails  WFProduceOR
    WFProduceDR WFProduce 
    Con los objetosEn el rol
    OrganizeEmails  WFProduceOR
     


    ClassifyDocument (Tarea)

    Properties:
    IDClassifyDocument 
    DescripcionOrganize the classification process. It classifies a given document in one category or asks the user to do it. 

    Relaciones:
    En el rolEn la relacion Otros extremos
    RTareaDestino WFConecta 
    Con los objetosEn el rol
    ClassifyEmail  RTarea
    WFConsumeOR WFConsume 
    Con los objetosEn el rol
    DocumentToClassify  WFConsumeDR
    WFProduceOR WFProduce 
    Con los objetosEn el rol
    DocumentClassified  WFProduceDR
    WFUsaOR WFUsa 
    Con los objetosEn el rol
    Categorizer  WFUsaDR
     


    ClassifyEmail (Tarea)

    Properties:
    IDClassifyEmail 
    DescripcionClassify a given e-mail in one category doing the necessary additional mail processing. 

    Relaciones:
    En el rolEn la relacion Otros extremos
    GTModificaOR GTFallaObjetivo
  • CondicionMental: 
  •  
    Con los objetosEn el rol
    EmailNotClassifiable  GTModificaDR
    RTarea WFConecta 
    Con los objetosEn el rol
    ProcessEmail  RTareaDestino
    RTarea WFConecta 
    Con los objetosEn el rol
    ClassifyDocument  RTareaDestino
    WFConsumeOR WFConsume 
    Con los objetosEn el rol
    EmailToClassify  WFConsumeDR
    WFConsumeOR WFConsume 
    Con los objetosEn el rol
    DocumentClassified  WFConsumeDR
    WFProduceOR WFProduce 
    Con los objetosEn el rol
    EmailCategory  WFProduceDR
     


    MoveEmail (Tarea)

    Properties:
    IDMoveEmail 
    DescripcionMove a given e-mail to the folder related to its category. 

    Relaciones:
    En el rolEn la relacion Otros extremos
    WFConsumeOR WFConsume 
    Con los objetosEn el rol
    EmailCategory  WFConsumeDR
    WFProduceOR WFProduce 
    Con los objetosEn el rol
    EmailClassified  WFProduceDR
    WFUsaOR WFUsa 
    Con los objetosEn el rol
    EmailWrapper  WFUsaDR
     


    OrganizeEmails (Tarea)

    Properties:
    IDOrganizeEmails 
    DescripcionPerceives an event about new email and triggers the interactions needed to classify the email and move it to the adequate folder. 

    Relaciones:
    En el rolEn la relacion Otros extremos
    GTModificaOR GTFallaObjetivo
  • CondicionMental: 
  •  
    Con los objetosEn el rol
    EmailNotAvailable  GTModificaDR
    WFConsumeOR WFConsume 
    Con los objetosEn el rol
    NewMailArrived  WFConsumeDR
    WFProduceOR WFProduce 
    Con los objetosEn el rol
    EmailToClassify  WFProduceDR
    WFProduceOR WFProduce 
    Con los objetosEn el rol
    EmailToClassify  WFProduceDR
    WFUsaOR WFUsa 
    Con los objetosEn el rol
    EmailWrapper  WFUsaDR
     


    ProcessEmail (Tarea)

    Properties:
    IDProcessEmail 
    DescripcionConvert an e-mail to a document processable by the Categorizer. 

    Relaciones:
    En el rolEn la relacion Otros extremos
    RTareaDestino WFConecta 
    Con los objetosEn el rol
    ClassifyEmail  RTarea
    WFProduceOR WFProduce 
    Con los objetosEn el rol
    DocumentToClassify  WFProduceDR
     


    ProcessNotification (Tarea)

    Properties:
    IDProcessNotification 
    DescripcionThis task sends a notification to the UserDevice. 

    Relaciones:
    En el rolEn la relacion Otros extremos
    WFConsumeOR WFConsume 
    Con los objetosEn el rol
    DocumentNotification  WFConsumeDR
    WFUsaOR WFUsa 
    Con los objetosEn el rol
    UserDevice  WFUsaDR