XurrentHelpers - A PowerShell module to automate your Xurrent environment

Xurrent (formerly 4me) is an enterprise IT Service Management platform designed for high-velocity service delivery across organizations and their service providers.

This PowerShell module provides cmdlets to automate Xurrent administration tasks, built and maintained by techwork data GmbH.

For detailed API reference, see the Xurrent API documentation.

Functions

Knowledge Articles
ConvertTo-XurrentKnowledgeArticle
ConvertFrom-XurrentKnowledgeArticle
Export-XurrentKnowledgeArticle
Import-XurrentKnowledgeArticle
New-XurrentKnowledgeArticleCsvExample
New-XurrentKnowledgeArticleTemplate

Getting Started

# PowerShellGet 2.x
Install-Module -Name XurrentHelpers -Repository PSGallery

# PowerShellGet 3.x
Install-PSResource -Name XurrentHelpers

Import-Module XurrentHelpers

# List all available cmdlets provided by the module
Get-Command -Module XurrentHelpers

Knowledge Articles

The knowledge article cmdlets work in both directions: author articles in Markdown and bulk-import them into Xurrent, or export from Xurrent and convert back to Markdown files.

Create a new article template

New-XurrentKnowledgeArticleTemplate -Name 'HowToResetPassword'
# Creates HowToResetPasswordKnowledgeArticle.md in the current directory

Convert a single Markdown file to an import object

Get-Item .\HowToResetPasswordKnowledgeArticle.md |
    ConvertTo-XurrentKnowledgeArticle -Service 'My Service' -ServiceInstances 'My Service Instance'

Export a folder of articles to a Xurrent import CSV

Export-XurrentKnowledgeArticle -Folder .\Articles -Service 'My Service' -ServiceInstances 'My Service Instance'
# Writes import-knowledge_articles.csv in the current directory

You can also store SERVICE and SERVICE_INSTANCES in a .env file in the working directory so you don't have to pass them each time:

SERVICE=techwork automator
SERVICE_INSTANCES=techwork automator for ACS

Export-XurrentKnowledgeArticle -Folder .\Articles
# Reads SERVICE / SERVICE_INSTANCES from .env automatically

Import a Xurrent CSV export back to Markdown files

Import-XurrentKnowledgeArticle -CsvPath .\export-knowledge_articles.csv -OutputFolder .\Articles
# Writes one *KnowledgeArticle.md file per row into .\Articles

Convert a single CSV row to a Markdown file

Import-Csv .\export-knowledge_articles.csv |
    ConvertFrom-XurrentKnowledgeArticle -Path .\Articles

Generate an example CSV

New-XurrentKnowledgeArticleCsvExample
# Creates example-knowledge_articles.csv in the current directory

New-XurrentKnowledgeArticleCsvExample -OutputPath C:\Temp\example.csv