# Sample Jobs

All jobs that come with the product are starting with the name '_Sample._'. <br>
Their purpose is mainly to help getting started with creating their custom jobs and to be useful and easy to configure for some common scenarios.<br>
It is recommended to copy these jobs and [create new ones](</jobprocessor/jobs/creating_job_scripts>) when they need to be customized.

All sample jobs contain a declaration of their [supported entity type](<jobprocessor/jobs:Job Entity Type>).

To queue sample jobs see [queueing custom jobs](<jobprocessor/jobs:queueing jobs>) section.<br>
When a sample job is queue for a not supported file it will write a message to the log but will not fail.<br>
All the sample jobs which support exports from Inventor Drawings can make use of the Inventor [FastOpen](<https://knowledge.autodesk.com/support/inventor/learn-explore/caas/CloudHelp/cloudhelp/2018/ENU/Inventor-WhatsNew/files/GUID-59AED296-334D-4A84-94EA-99196967D926-htm.html>) feature.<br>
This means only the drawing without dependencies gets downloaded and [opened](</jobprocessor/code_reference/cmdlets/open-document>).

**Default job settings**

Each sample job has [configurable settings](</job_configuration/job_settings_tab>) to control its behavior. <br>
The following settings are not included in the [settings region](<jobprocessor/jobs:Job Settings>) of the sample jobs and are therefore not configurable:

The variable `$[type]fileName` - where _[type]_ is the extension of your target file - holds the name of the file to export. It is set to the name of the Vault source file with an additional '._[type]_' suffix. <br>
For example, when queuing the [Sample.CreatePDF job](<jobprocessor/jobs/sample_jobs:sample.createpdf>) for the Inventor Drawing _Pad Lock.idw_, the value of the variable would be _Pad Lock.idw.**pdf**_.

The variable `$workingDirectory` holds the path to a temporary directory. In the sample jobs it is used as temporary direcotry where Vault files are downloaded or file exports are generated. At the end of each job it will be purged automatically.

**Default state change triggers**

The following sample jobs are delivered with default settings files for [Lifecycle State Change Triggers](<job_configuration/job_triggers_tab:Trigger job automatically on lifecycle state changes>) which can be configured in the [Settings Dialog](<job_configuration:powerJobs Settings Dialog>).
* [Sample.CreatePDF](<jobprocessor/jobs/sample_jobs:sample.createpdf>)
* [Sample.CreateDXF&STEPfromSheetmetal](<jobprocessor/jobs/sample_jobs:sample.createdxf&stepfromsheetmetal>)


## Sample.CreatePDF

**Supported entity type:** _FILE_<br>
**Supported files:** _idw, dwg (Inventor and AutoCAD)_<br>
**Configuration file:**

- Inventor drawings: [PDF_2D.ini](<jobprocessor/code_reference/cmdlets/export-document/pdf:Inventor and InventorServer>)
- AutoCAD Drawings: [PDF.dwg](<jobprocessor/code_reference/cmdlets/export-document/pdf:DWG TrueView>)

By default, the Job creates a [PDF](</jobprocessor/code_reference/cmdlets/export-document/pdf>) and adds it to the Vault as a _DesignVisualization_.<br>
The PDF file is stored in the same location and with the same file name as the drawing and attached to it.
<br>

**Settings**<br>
Important settings like the file name for the output format, if and where the file should be added to Vault, <br>
whether the file should be published to a network share, and other settings are specified in the first lines of the job so that they can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the PDF name set Yes, otherwise No
$pdfFileNameWithRevision = $false

# The character used to separate file name and Revision label in the PDF name such as hyphen (-) or underscore (_)
$pdfFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the PDF name set Yes, otherwise No
$pdfFileNameWithExtension = $true

# To add the PDF to Vault set Yes, to keep it out set No
$addPDFToVault = $true

# To attach the PDF to the main file set Yes, otherwise No
$attachPDFToVaultFile = $true

# Specify a Vault folder in which the PDF should be stored (e.g. $/Designs/PDF), or leave the setting empty to store the PDF next to the main file
$pdfVaultFolder = ""

# Specify a network share into which the PDF should be copied (e.g. \\SERVERNAME\Share\Public\PDFs\)
$pdfNetworkFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true
#endregion
```

**Default state change triggers**<br>
This job comes with a [default file](<job_configuration/job_triggers_tab:default values>) (_Sample.CreatePDF.defaults_) which defines the following settings:
- Filter to only trigger for drawings (files with extension `idw` or `dwg`)
- Queue the job with priority _101_

## Sample.CreateDXF&STEPfromSheetmetal

**Supported entity type:** _FILE_<br>
**Supported files:** _ipt (sheet metal)_<br>
**Configuration file:**

- For DXF: [DXF_SheetMetal.ini](<jobprocessor/code_reference/cmdlets/export-document/dxf:Sheet Metal Parts>)
- For STEP: [STEP.ini](<jobprocessor/code_reference/cmdlets/export-document/step:Inventor Models>)

By default, the Job creates a [DXF](</jobprocessor/code_reference/cmdlets/export-document/dxf>) file and a [STEP](</jobprocessor/code_reference/cmdlets/export-document/step>) file that are added to the Vault as _DesignVisualization_ files.<br>
The DXF and STEP files are stored in the same location and with the same file name as the sheet metal part and attached to it.<br>
Usually the DXF is used for manufacturing (laser cutter, bending machine, etc...),<br>
while the STEP is used as 3D model for suppliers as it can be better used with the K-Factor of the machines.

**Settings**<br>
Important settings like the file name for the output format, if and where the file should be added to Vault, if only the DXF or STEP should be created,<br>
whether the file should be published to a network share, and other settings are specified in the first lines of the job so that they can be easily changed:

```powershell
#region Settings
# To include the Revision of the sheet metal part in the DXF name set Yes, otherwise No
$dxfFileNameWithRevision = $false

# The character used to separate file name and Revision label in the DXF name such as hyphen (-) or underscore (_)
$dxfFileNameRevisionSeparator = "_"

# To include the file extension '.ipt' in the DXF name set Yes, otherwise No
$dxfFileNameWithExtension = $true

# To add the DXF to Vault set Yes, to keep it out set No
$addDXFToVault = $true

# To attach the DXF to the sheet metal part set Yes, otherwise No
$attachDXFToVaultFile = $true

# Specify a Vault folder in which the DXF should be stored (e.g. $/Designs/DXF), or leave the setting empty to store the DXF next to the sheet metal part
$dxfVaultFolder = ""

# Specify a network share into which the DXF should be copied (e.g. \\SERVERNAME\Share\Public\DXFs\)
$dxfNetworkFolder = ""

# To include the Revision of the sheet metal part in the STEP name set Yes, otherwise No
$stepFileNameWithRevision = $false

# The character used to separate file name and Revision label in the STEP name such as hyphen (-) or underscore (_)
$stepFileNameRevisionSeparator = "_"

# To include the file extension '.ipt' in the STEP name set Yes, otherwise No
$stepFileNameWithExtension = $true

# To add the STEP to Vault set Yes, to keep it out set No
$addSTEPToVault = $true

# To attach the STEP to the sheet metal part set Yes, otherwise No
$attachSTEPToVaultFile = $true

# Specify a Vault folder in which the STEP should be stored (e.g. $/Designs/STEP), or leave the setting empty to store the STEP next to the sheet metal part
$stepVaultFolder = ""

# Specify a network share into which the STEP should be copied (e.g. \\SERVERNAME\Share\Public\STEPs\)
$stepNetworkFolder = ""
#endregion
```

**Default state change triggers**<br>
This job comes with a [default file](<job_configuration/job_triggers_tab:default values>) (_Sample.CreateDXF&STEPfromSheetmetal.defaults_) which defines the following settings:
- Filter to only trigger for parts (files with extension `ipt`)
- Queue the job with priority _101_

The powerEvents scripts [SubmitJobsOnLifecycleTransition](<powerevents:event_scripts/SubmitJobsOnLifecycleTransition>) and [SubmitJobsOnVaultMenuItemClick](<powerevents:event_scripts/SubmitJobsOnVaultMenuItemClick>) also validate that this job is only queued for Sheetmetal parts.

## Sample.CreateDXFfromDrawing

**Supported entity type:** _FILE_<br>
**Supported files:** _idw, dwg (Inventor and AutoCAD)_<br>
**Configuration file:** [DXF_2D.ini](<jobprocessor/code_reference/cmdlets/export-document/dxf:Drawings>)

By default, the Job creates a [DXF](</jobprocessor/code_reference/cmdlets/export-document/dxf>) with <img src="/img/jobprocessor/inventorserver.png" width="15px"> InventorServer and adds it to the Vault as a _DesignVisualization_.<br>
For **multisheet idw or dwg** files depending on configuration either a .zip file is created or a .dxf file for each sheet.<br>
The file(s) are stored in the same location and with the same file name as the source file and are attached to it.

**Settings**<br>
Important settings like the file name for the output format, if- and where the file should be added to Vault, <br>
whether the file should be published to a network share, and settings for troubleshooting are specified in the first lines of the job so that they can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the DXF name set Yes, otherwise No
$dxfFileNameWithRevision = $false

# The character used to separate file name and Revision label in the DXF name such as hyphen (-) or underscore (_)
$dxfFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the DXF name set Yes, otherwise No
$dxfFileNameWithExtension = $true

# To add the DXF to Vault set Yes, to keep it out set No
$addDXFToVault = $true

# To attach the DXF to the main file set Yes, otherwise No
$attachDXFToVaultFile = $true

# Specify a Vault folder in which the DXF should be stored (e.g. $/Designs/DXF), or leave the setting empty to store the DXF next to the main file
$dxfVaultFolder = ""

# Specify a network share into which the DXF should be copied (e.g. \\SERVERNAME\Share\Public\DXFs\)
$dxfNetworkFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true

# To enable faster processing via InventorServer set Yes, otherwise set No if an Inventor installation and license are available
$useInventorServer = $true
#endregion
```

## Sample.CreateSTEPfromModel

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt_<br>
**Configuration file:** [STEP.ini](<jobprocessor/code_reference/cmdlets/export-document/step:Inventor Models>)

By default, the Job creates [STEP](</jobprocessor/code_reference/cmdlets/export-document/step>) files and adds them to Vault as a _DesignVisualization_.<br>
The STEP files are stored in the same location and with the same file name as the source file and are attached to it.

**Settings**<br>
Important settings like the file name for the output format, if and where the file should be added to Vault, <br>
whether the file should be published to a network share, and other settings are specified in the first lines of the job so that they can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the STEP name set Yes, otherwise No
$stepFileNameWithRevision = $false

# The character used to separate file name and Revision label in the STEP name such as hyphen (-) or underscore (_)
$stepFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the STEP name set Yes, otherwise No
$stepFileNameWithExtension = $true

# To add the STEP to Vault set Yes, to keep it out set No
$addSTEPToVault = $true

# To attach the STEP to the main file set Yes, otherwise No
$attachSTEPToVaultFile = $true

# Specify a Vault folder in which the STEP should be stored (e.g. $/Designs/STEP), or leave the setting empty to store the STEP next to the main file
$stepVaultFolder = ""

# Specify a network share into which the STEP should be copied (e.g. \\SERVERNAME\Share\Public\STEPs\)
$stepNetworkFolder = ""
#endregion
```

## Sample.CreateDWG

**Supported entity type:** _FILE_<br>
**Supported files:** _ipt (incl. sheet metal), iam , idw, dwg (Inventor and AutoCAD)_<br>
**Configuration file:**

- Sheet metal: [DWG_SheetMetal.ini](<jobprocessor/code_reference/cmdlets/export-document/dwg:Sheet Metal Parts>)
- Drawings: [DWG_2D.ini](<jobprocessor/code_reference/cmdlets/export-document/dwg:Drawings>)
- Models: [DWG_3D.ini](<jobprocessor/code_reference/cmdlets/export-document/dwg:Inventor Models>)

By default, the Job creates [AutoCAD 2000 DWG](</jobprocessor/code_reference/cmdlets/export-document/dwg>) with <img src="/img/jobprocessor/inventorserver.png" width="15px"> InventorServer and adds it to the Vault as a _DesignVisualization_.<br>
For **multisheet idw or dwg** depending on configuration either a .zip file is created or a .dwg file for each sheet.<br>
The Drawings files are stored in the same location and with the same file name as the source file and are attached to it.

**Settings**<br>
Important settings such as the file name for the output format, wether- and where to add the file to Vault <br />and settings for troubleshooting are specified in the first lines of the job so that they can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the DWG name set Yes, otherwise No
$dwgFileNameWithRevision = $false

# The character used to separate file name and Revision label in the DWG name such as hyphen (-) or underscore (_)
$dwgFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the DWG name set Yes, otherwise No
$dwgFileNameWithExtension = $true

# Specify a Vault folder in which the DWG should be stored (e.g. $/Designs/DWG), or leave the setting empty to store the DWG next to the main file
$dwgVaultFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true

# To enable faster processing via InventorServer set Yes, otherwise set No if an Inventor installation and license are available
$useInventorServer = $true
#endregion
```

## Sample.CreateIGES

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt_<br>
**Configuration file:** [IGES.ini](<jobprocessor/code_reference/cmdlets/export-document/iges:Inventor Models>)

By default, the Job creates [IGES](</jobprocessor/code_reference/cmdlets/export-document/iges>) files and adds them to Vault as a _DesignVisualization_.<br>
The IGES files are stored in the same location and with the same file name as the source file and are attached to it.
<br>
**Settings**<br>
Important settings such as the file name for the output format, whether and where to add the file to Vault, and other settings can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the IGES name set Yes, otherwise No
$igesFileNameWithRevision = $false

# The character used to separate file name and Revision label in the IGES name such as hyphen (-) or underscore (_)
$igesFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the IGES name set Yes, otherwise No
$igesFileNameWithExtension = $true

# Specify a Vault folder in which the IGES should be stored (e.g. $/Designs/IGES), or leave the setting empty to store the IGES next to the main file
$igesVaultFolder = ""
#endregion
```

## Sample.CreateJPEG

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt, ipn, idw, dwg (Inventor)_

By default, the Job creates [JPEG](</jobprocessor/code_reference/cmdlets/export-document/jpeg>) files and adds them to Vault as a _DesignVisualization_.<br>
The JPEG file is stored in the same location and with the same file name as the source file and is attached to it.

**Settings**<br>
Important settings such as the file name for the output format, whether and where to add the file to Vault, and other settings can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the JPG name set Yes, otherwise No
$jpgFileNameWithRevision = $false

# The character used to separate file name and Revision label in the JPG name such as hyphen (-) or underscore (_)
$jpgFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the JPG name set Yes, otherwise No
$jpgFileNameWithExtension = $true

# Specify a Vault folder in which the JPG should be stored (e.g. $/Designs/JPG), or leave the setting empty to store the JPG next to the main file
$jpgVaultFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true
#endregion
```

## Sample.CreateGIF

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt, ipn, idw, dwg (Inventor)_

By default, the Job creates [GIF](</jobprocessor/code_reference/cmdlets/export-document/gif>) files and adds them to Vault as a _DesignVisualization_.<br>
The GIF file is stored in the same location and with the same file name as the source file and is attached to it.

**Settings**<br>
Important settings such as the file name for the output format, whether and where to add the file to Vault, and other settings can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the GIF name set Yes, otherwise No
$gifFileNameWithRevision = $false

# The character used to separate file name and Revision label in the GIF name such as hyphen (-) or underscore (_)
$gifFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the GIF name set Yes, otherwise No
$gifFileNameWithExtension = $true

# Specify a Vault folder in which the GIF should be stored (e.g. $/Designs/GIF), or leave the setting empty to store the GIF next to the main file
$gifVaultFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true
#endregion
```

## Sample.CreatePNG

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt, ipn, idw, dwg (Inventor)_

By default, the Job creates [PNG](</jobprocessor/code_reference/cmdlets/export-document/png>) files and adds them to Vault as a _DesignVisualization_.<br>
The PNG file is stored in the same location and with the same file name as the source file and is attached to it.

**Settings**<br>
Important settings such as the file name for the output format, whether and where to add the file to Vault, and other settings can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the PNG name set Yes, otherwise No
$pngFileNameWithRevision = $false

# The character used to separate file name and Revision label in the PNG name such as hyphen (-) or underscore (_)
$pngFileNameRevisionSeparator = "_"

# To add the PNG to Vault set Yes, to keep it out set No
$pngFileNameWithExtension = $true

# Specify a Vault folder in which the PNG should be stored (e.g. $/Designs/PNG), or leave the setting empty to store the PNG next to the main file
$pngVaultFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true
#endregion
```

## Sample.CreateTIFF

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt, ipn, idw, dwg (Inventor)_

By default, the Job creates [TIFF](</jobprocessor/code_reference/cmdlets/export-document/tiff>) files and adds them to Vault as a _DesignVisualization_.<br>
The TIFF file is stored in the same location and with the same file name as the source file and is attached to it.

**Settings**<br>
Important settings such as the file name for the output format, whether and where to add the file to Vault, and other settings can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the TIFF name set Yes, otherwise No
$tiffFileNameWithRevision = $false

# The character used to separate file name and Revision label in the TIFF name such as hyphen (-) or underscore (_)
$tiffFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the TIFF name set Yes, otherwise No
$tiffFileNameWithExtension = $true

# Specify a Vault folder in which the TIFF should be stored (e.g. $/Designs/TIFF), or leave the setting empty to store the TIFF next to the main file
$tiffVaultFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true
#endregion
```

## Sample.CreateBMP

**Supported entity type:** _FILE_<br>
**Supported files:** _iam, ipt, idw, dwg (Inventor)_

By default, the Job creates [BMP](</jobprocessor/code_reference/cmdlets/export-document/bmp>) files and adds them to Vault as a _DesignVisualization_.<br>
The BMP file is stored in the same location and with the same file name as the source file and is attached to it.

**Settings**<br>
Important settings such as the file name for the output format, whether and where to add the file to Vault, and other settings can be easily changed:

```powershell
#region Settings
# To include the Revision of the main file in the BMP name set Yes, otherwise No
$bmpFileNameWithRevision = $false

# The character used to separate file name and Revision label in the BPM name such as hyphen (-) or underscore (_)
$bmpFileNameRevisionSeparator = "_"

# To include the file extension of the main file in the BMP name set Yes, otherwise No
$bmpFileNameWithExtension = $true

# Specify a Vault folder in which the BMP should be stored (e.g. $/Designs/BMP), or leave the setting empty to store the BMP next to the main file
$bmpVaultFolder = ""

# To enable faster opening of released Inventor drawings without downloading and opening their model files set Yes, otherwise No
$openReleasedDrawingsFast = $true
#endregion
```