# Workflows

```{toctree}
:glob:
:hidden:

workflows/*
```

Workflows consist of two components: the Workflow Configuration within the [](/configuration_manager) and the according [powerJobs Processor job](powerjobs_processor:jobprocessor/jobs/creating_job_scripts).

## Configuration

Before setting up the Configuration Manager, the proper configuration of the {ref}`Fusion 360 Manage Tenant <getting_started:configuration in fusion 360 manage>` is required.\
Afterwards the {ref}`Tenant Settings <configuration_manager:tenant settings>` can be configured in the Vault Client to allow powerPLM (powerFLC) Workflows to establish a connection to Fusion 360 Manage.

In order to give workflows the possibility to perform their actions with the correct Fusion 360 Manage user, the e-mail address of the Vault user that submitted the according job must be configured in the [Vault User profile](https://knowledge.autodesk.com/support/vault-products/learn-explore/caas/CloudHelp/cloudhelp/2022/ENU/Vault-Admin/files/GUID-D92E6795-E146-41F6-9CC3-A1BD810C365C-htm.html):

```{image} img/vault_email_configuration.png
:width: 400px
```

This same email address must be present for the [Fusion 360 Manage User](http://help.autodesk.com/view/PLM/ENU/?guid=GUID-FE8C2A42-A349-4CB2-9541-67879E2E591E):

```{image} img/flc_user_email.png
:width: 800px
```

## Jobs

powerPLM (powerFLC) is delivered with two sample workflow jobs {doc}`/workflows/transfer_item_boms` and {doc}`/workflows/change_management`. Their purpose is help people getting started with creating their own workflows based on {doc}`powerJobs Processor <powerjobs_processor:index>`.\
The samples cover the most common scenarios for exchanging data between Vault and Fusion 360 Manage and is highly {ref}`customizable <workflows/transfer_item_boms:configuration>`.\
We recommend to copy the sample workflow script and create your own {doc}`Custom Workflow <powerjobs_processor:jobprocessor/jobs/creating_job_scripts>` job, when additional customizations are preferred.

Make sure to start the {ref}`powerJobs.exe <powerjobs_processor:jobprocessor:extended jobprocessor ui>` at least once to make sure the workflow {ref}`job types are synchronized <powerjobs_processor:jobprocessor:job synchronization>` and can be processed by powerJobs Processor.

```{image} img/powerjobsprocessor_executing_job.png
:width: 700px
```

### Modules

Following powerShell script modules are delivered with powerPLM (powerFLC) and
installed in the powerJobs Processor module directory:

- coolOrange.powerFLC.Workflows.MappingFunctions.psm1
- coolOrange.powerFLC.Workflows.Common.psm1
- coolOrange.powerFLC.Workflows.Extensions.psm1
- coolOrange.powerFLC.Workflows.Async.psm1

#### coolOrange.powerFLC.Workflows.Common.psm1

Contains functions to simplify the workflow jobs.\
Important functionalities:

- Provides the **\$workflow** variable which supplies the configuration

#### coolOrange.powerFLC.Workflows.MappingFunctions.psm1

Contains the functions that are used in the {ref}`Field Mappings <configuration_manager/workflow_settings:field mappings>` dialog.

## Workflow trigger

In order to execute a {doc}`Workflow Job <powerjobs_processor:jobprocessor/jobs>` on Vault **lifecycle changes**, the Vault lifecycle state transition must be extended with the Job Type matching the **“Workflow Name”**.\
See the delivered samples {ref}`Sample.TransferItemBOMs <workflows/transfer_item_boms:triggering the workflow>` and {ref}`Sample.SyncChangeOrders <workflows/change_management:triggering the workflow>` are enqueued after changing the state of Vault entities.

Alternatives for queueing jobs automatically are e.g. using a custom {doc}`powerEvents script <powerevents:event_scripts>` with the `Add-VaultJob` cmdlet or on specific {ref}`Intervals <powerjobs_processor:jobprocessor:time triggered jobs>`.