Describing changes in a workflow based on changes in structured documents containing workflow metadata
A method performed by an electronic device includes retrieving, from a first computing environment, a first set of structured documents that contains metadata for a first version of a workflow to be performed by a workflow engine, the first version of the workflow including a first set of workflow elements. The method further including retrieving, from a second computing environment, a second set of structured documents. The method determines whether a rule is to be applied, based on one but not both of the first and second sets of structured documents including at least one section for a workflow element having a type to which the rule applies, and generating a description of a change in the second version of the workflow relative to the first version of the workflow.
1. A method performed by an electronic device, the method comprising:
receiving, from an external device, a request for a description of changes between a first workflow and a second workflow;
retrieving a first set of structured documents that contains metadata for the first workflow, the first workflow including a first set of workflow elements that each represent a respective operation to be performed by a workflow engine;
retrieving a second set of structured documents that contains metadata for the second workflow, the second workflow including a second set of workflow elements that each represent a respective operation to be performed by the workflow engine, the second set different from the first set;
applying, based on only one of the first set and the second set including at least one section for a workflow element having a first type to which a first rule applies, the first rule to the first set and the second set to generate a description of a change in the second workflow relative to the first workflow, wherein the first rule indicates a query to be performed on a structured document and a description template that references a result of the query, the description of the change in the second workflow relative to the first workflow being generated based on performing the query on at least one structured document of the first set to determine a first result and applying the description template to the first result; and
generating, based on the description of the change in the second workflow, the description of changes to cause one or more user interface elements to be displayed on a graphical user interface (GUI) of the external device.
2. The method of claim 1 , further comprising:
performing a query on at least one structured document of the first set to determine a second result;
performing a query on at least one structured document of the second set to determine a third result; and
comparing the second result and the third result.
3. The method of claim 2 , further comprising:
applying a description template to a result of the comparing to generate a further description of the change in the second workflow, wherein the description of changes is further generated based on the further description of the change in the second workflow.
4. The method of claim 1 , wherein the second workflow is a modified version of the first workflow.
5. The method of claim 1 , wherein the one or more user interface elements are a textual description.
6. The method of claim 1 , wherein the one or more user interface elements are a graphical description.
7. The method of claim 1 , wherein the first set of structured documents includes a different number of documents than the second set of structured documents.
8. The method of claim 1 , wherein determining whether the rule is to be applied is further based on whether one or more filenames of the structured documents of the first and second sets of structured documents satisfy a regular expression.
9. A non-transitory machine-readable storage medium that provides instructions that, when executed by a processor, are capable of causing the processor to perform operations comprising:
receiving, from an external device, a request for a description of changes between a first workflow and a second workflow;
retrieving a first set of structured documents that contains metadata for the first workflow, the first workflow including a first set of workflow elements that each represent a respective operation to be performed by a workflow engine;
retrieving a second set of structured documents that contains metadata for the second workflow, the second workflow including a second set of workflow elements that each represent a respective operation to be performed by the workflow engine, the second set different from the first set;
applying, based on only one of the first set and the second set including at least one section for a workflow element having a first type to which a first rule applies, the first rule to the first set and the second set to generate a description of a change in the second workflow relative to the first workflow, wherein the first rule indicates a query to be performed on a structured document and a description template that references a result of the query, the description of the change in the second workflow relative to the first workflow being generated based on performing the query on at least one structured document of the first set to determine a first result and applying the description template to the first result; and
generating, based on the description of the change in the second workflow, the description of changes to cause one or more user interface elements to be displayed on a graphical user interface (GUI) of the external device.
10. The non-transitory machine-readable storage medium of claim 9 , wherein the operations further comprise:
performing a query on at least one structured document of the first set to determine a second result;
performing a query on at least one structured document of the second set to determine a third result; and
comparing the second result and the third result.
11. The non-transitory machine-readable storage medium of claim 10 , wherein the operations further comprise:
applying a description template to a result of the comparing to generate a further description of the change in the second workflow, wherein the description of changes is further generated based on the further description of the change in the second workflow.
12. The non-transitory machine-readable storage medium of claim 9 , wherein the second workflow is a modified version of the first workflow.
13. The non-transitory machine-readable storage medium of claim 9 , wherein the one or more user interface elements are a textual description.
14. The non-transitory machine-readable storage medium of claim 9 , wherein the one or more user interface elements are a graphical description.
15. The non-transitory machine-readable storage medium of claim 9 , wherein the first set of structured documents includes a different number of documents than the second set of structured documents.
16. The non-transitory machine-readable storage medium of claim 9 , wherein determining whether the rule is to be applied is further based on whether one or more filenames of the structured documents of the first and second sets of structured documents satisfy a regular expression.
17. A system comprising:
a non-transitory machine-readable storage medium that stores a change management service; and
a processor coupled to the non-transitory machine-readable storage medium, the processor to execute the change management service, the change management service to:
receive, from an external device, a request for a description of changes between a first workflow and a second workflow;
retrieve a first set of structured documents that contains metadata for the first workflow, the first workflow including a first set of workflow elements that each represent a respective operation to be performed by a workflow engine;
retrieve a second set of structured documents that contains metadata for the second workflow, the second workflow including a second set of workflow elements that each represent a respective operation to be performed by the workflow engine, the second set different from the first set;
apply, based on only one of the first set and the second set including at least one section for a workflow element having a first type to which a first rule applies, the first rule to the first set and the second set to generate a description of a change in the second workflow relative to the first workflow, wherein the first rule indicates a query to be performed on a structured document and a description template that references a result of the query, the description of the change in the second workflow relative to the first workflow being generated based on performing the query on at least one structured document of the first set to determine a first result and applying the description template to the first result; and
generate, based on the description of the change in the second workflow, the description of changes to cause one or more user interface elements to be displayed on a graphical user interface (GUI) of the external device.
18. The system of claim 17 , wherein the change management service is to:
perform a query on at least one structured document of the first set to determine a second result;
perform a query on at least one structured document of the second set to determine a third result; and
compare the second result and the third result.
19. The system of claim 18 , wherein the change management service is to:
apply a description template to a result of the comparison to generate a further description of the change in the second workflow, wherein the description of changes is further generated based on the further description of the change in the second workflow.
20. The system of claim 17 , wherein the second workflow is a modified version of the first workflow.