Classifier Administration
PowerShell
3.10.0
Getting Started Guide
Copyright Terms and Conditions
Copyright © Fortra, LLC and its group of companies. All trademarks and registered trademarks are the property of their respective
owners.
The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The
unauthorized use and/or duplication of this material without express and written permission from Fortra is strictly prohibited. Excerpts
and links may be used, provided that full and clear credit is given to Fortra with appropriate and specific direction to the original
content.
202310200958
Table of Contents
About Fortra's Classifier Administration PowerShell 4
About this guide 4
Licensing 4
Prerequisites 5
Creating a Configuration 6
Testing your Configuration 7
Naming Conventions 8
Verbs 8
Parameters 9
Tab Completion, Parameter Completion, and IntelliSense 10
Pipelining 11
Selectors, Markings, Policies, and Help Cmdlets 12
Selectors 12
Marking Formats 12
Policies 12
Help 13
Contacting Fortra 14
Getting Started Guide [Link] page: 3
About Fortra's Classifier Administration PowerShell / About this guide
About Fortra's Classifier
Administration PowerShell
Fortra's Boldon James Classifier Administration PowerShell module allows you to run
Fortra's Boldon James Classifier Administration Server using PowerShell commands. The
module provides over two hundred cmdlets to fetch, create, modify or remove any aspect of
the Classifier configuration.
Fortra recommends the use of Microsoft Visual Studio Code (VSC), including the PowerShell
plug-in when getting started with the Classifier Administration cmdlets. The VSC adds syntax
colouring, tab completion, IntelliSense, visual debugging, and context-sensitive Help.
PowerShell scripts are installed when you install the Administration Server. See the
Classifier Administration Server Getting Started Guide for more information.
About this guide
This document assumes:
l a single system hosts all three environments. In a live system, Boldon James
recommends hosting the Classifier Administration Service on a separate system.
l authorised administrators use the PowerShell interface to connect to this service.
l a network location (or Active Directory) holds the published Configuration and
installed Classifier Applications reference that location.
Classifier PowerShell supports a ‘Publish Test Configuration’ facility whereby the
Administrator can publish a ‘Test Configuration.’ This document makes use of this
‘Publish Test Configuration’ mechanism to explore the effects of the Configuration on
various Classifier-enabled applications (for example, Microsoft Word).
For information on installing the Classifier Administration Server, see the Classifier
Administration Server Getting Started Guide.
Licensing
A PowerShell license can be applied either on a per session basis or to Classifier
configuration in the same way as other application licenses. Alternatively, the license can be
used in session variables so that the resulting Classifier configuration cannot use the
PowerShell cmdlets.
Getting Started Guide [Link] page: 4
About Fortra's Classifier Administration PowerShell / Prerequisites
In contrast, cmdlets that are used only for interrogation of the configuration do not require a
licence. This means that any cmdlets that use the verb Get- do not require a licence.
At the start of each session, set a session variable as follows: Set-SessionLicence –
LicenceFile ‘C:\LicenceFiles\[Link]’.
Prerequisites
For a list of system requirements to run the Classifier Administration Server, see the
Classifier Administration Server Getting Started Guide.
To enable all IIS prerequisites for your operating system, run one of the following PowerShell
commands in an elevated command prompt session:
Operating PowerShell command
System
Windows 10 [Link] /online /enable-feature /all /featurename:IIS-
ManagementConsole
Windows 11
/featurename:IIS-ASPNET45 /featurename:IIS-DefaultDocument
/featurename:IIS- ISAPIExtensions /featurename:IIS-ISAPIFilter
/featurename:IIS-HttpErrors /featurename:IIS- NetFxExtensibility45
/featurename:IIS-RequestFiltering /featurename:NetFx4Extended-
ASPNET45 /featurename:IIS-StaticContent /featurename:IIS-
HttpCompressionDynamic
/featurename:IIS-HttpCompressionStatic /featurename:IIS-
WindowsAuthentication
/featurename:IIS-LoggingLibraries
Windows [Link] /online /enable-feature /all /featurename:NetFx4Extended-
Server 2016 ASPNET45
Windows /featurename:NetFx4 /featurename:IIS-NetFxExtensibility45
Server 2019 /featurename:IIS- WebServerManagementTools /featurename:IIS-
DefaultDocument /featurename:IIS- ASPNET45 /featurename:IIS-
ISAPIExtensions /featurename:IIS-ISAPIFilter /featurename:IIS-
RequestFiltering /featurename:IIS-StaticContent /featurename:IIS-
HttpCompressionDynamic
/featurename:IIS-HttpCompressionStatic /featurename:IIS-HttpErrors
/featurename:IIS- LoggingLibraries /featurename:IIS-
WindowsAuthentication
Getting Started Guide [Link] page: 5
Creating a Configuration /
Creating a Configuration
This section describes how to create a configuration using PowerShell cmdlets.
NOTE: Ifyou are using an existing configuration, use Get-ServerConfiguration –Location
FileSystem to copy it into the Configuration Import Folder, then go to Use test mode.
1. Use Set-ServerConfiguration - Location FileSystem to set the Configuration Import
Folder if the Folder is other than the default %programdata%\Boldon James\Config
Import Folder.
2. Use Get-Module -ListAvailable -Refresh to ensure all cmdlets are available.
3. Use net start [Link] to ensure the
service is running.
4. Use Add-Licence -FileName Location to l License your new label configuration as in
the following example:
5. Use New-LabelConfiguration -Name 'new name' -TemplateName 'template name'
to create a new Label Configuration as in the following example:
Getting Started Guide [Link] page: 6
Testing your Configuration /
Testing your Configuration
Classifier Administration provides a Test Mode Administration feature so you can
preview the effects of the configuration on the end-user experience prior to
publication of the configuration to a user community. For more information on the Test
Mode Administration feature, see the Classifier Administration Server Getting Started
Guide.
1. Enter Set-ConfigurationTestFolder -Path, where path is the location of your
test configuration. By default, this location is %programdata%\Boldon
James\TestMode Folder.
2. Enter Publish-TestConfiguration -TestName 'name of test configuration'.
3. When you have finished your testing, enter -RemoveLabelConfiguration -
Name 'name of test configuration -DeleteLicenses:$true to remove your test
configurations and any licenses in use.
Getting Started Guide [Link] page: 7
Naming Conventions / Verbs
Naming Conventions
Verbs
The Classifier Administration PowerShell Module follows Microsoft’s guidelines for the verbs
of cmdlet names. The following verbs appear in cmdlet names:
Common verbs
Verb Action
Add Adds a resource to a container, or attaches an item to another item
Copy Copies a resource to another name or to another container
Get Specifies an action that retrieves a resource. See Selectors, Markings,
Policies, and Help Cmdlets on page 12 for examples of Get.
Join Combines resources into one resource.
Lock Secures a resource. This verb is paired with Unlock.
New Creates a resource.
Remove Deletes a resource from a container.
Rename Changes the name of a resource.
Set Replaces data on an existing resource or creates a resource that contains
some data
Unlock Releases a locked resource. This verb is paired with Lock.
Data Verbs
Verb Action
ConvertFrom Converts one primary type of input (the cmdlet noun indicates the input)
to one or more supported output types.
ConvertTo Converts from one or more types of input to a primary output type (the
cmdlet noun indicates the output type).
Publish Makes a resource available to others.
Restore Sets a resource to a predefined state
Getting Started Guide [Link] page: 8
Naming Conventions / Parameters
Security Verbs
Verb Action
Block Restricts access to a resource.
Grant Allows access to a resource. This verb is paired with Revoke
Revoke Specifies an action that does not allow access to a resource. This verb is
paired with Grant.
Unprotect Removes safeguards from a resource. This verb is paired with Unlock.
The nouns of cmdlet names refer to the entity that the action affects.
NOTE: When the entity is part of a Classifier policy, the noun will have a prefix of Policy.
For example, the cmdlet Get-SelectorValue obtains a Classifier selector value from the
Selector Library whereas Get-PolicySelectorValue obtains the Classifier selector value
associated with a specific Classifier policy.
Parameters
Use either a friendly name or a unique identifier (a GUID) parameter to describe the entity on
which the action affects.
When the cmdlet requires the identification of multiple entities, then the entity type is used as
a prefix to the parameters. For example, the cmdlet Get-PolicySelectorValue requires the
identification of a Classifier policy, selector, and value using parameters (in this instance, –
PolicyName, –SelectorName and –SelectorValue). Other parameters used can be –PolicyId, -
SelectorId and –ValueId. In this case, you cannot mix parameters. For example, you cannot
use -PolicyName with -SelectorId
In some cmdlets, dynamic parameters can be used and will require a specific set of
parameters depending on the value supplied.
All cmdlets support the following general common parameters and risk-mitigation parameters
Parameter Description
-Debug Specifies whether programmer-level debugging messages are
displayed
-ErrorAction Specifies what action should take place when an error occurs
-ErrorVariable Specifies the variable in which to place objects when an error occurs
Getting Started Guide [Link] page: 9
Naming Conventions / Tab Completion, Parameter Completion, and IntelliSense
Parameter Description
-OutVariable Specifies the variable in which to place all output objects generated
by the cmdlet.
-OutBuffer Defines the number of objects to store in the output buffer before any
objects are passed down the pipeline.
-Verbose Specifies whether the cmdlet writes explanatory messages that can
be displayed at the command line
-WarningAction Specifies what action should take place when the cmdlet writes a
warning message
-WarningVariable Save warning messages in the specified variable.
-Confirm Specifies whether the cmdlet displays a prompt that asks if the user is
sure that they want to continue.
-WhatIf Specifies whether the cmdlet writes a message that describes the
effects of running the cmdlet without actually performing any action.
Tab Completion, Parameter Completion, and
IntelliSense
Cmdlet name completion occurs as expected with PowerShell. For example, typing the
partial cmdlet get-ser and then pressing the Tab key will auto-complete the cmdlet name.
Pressing the Tab key subsequent times allows scrolling through every cmdlet that begins
get-ser.
IntelliSense presents available parameters when entering the hyphen character after a
cmdlet name. For example,
Parameter completion is available for most parameters. For example,
Getting Started Guide [Link] page: 10
Naming Conventions / Pipelining
When a unique identifier describes the entity that the action affects, the parameter
completion will show friendly names as a choice. When selecting a specific friendly name, the
cmdlet completes the parameter value with the unique identifier; for example:
Selecting the value All provides:
If a parameter requires an array or list of values, separate the values using a comma, then
tab completion can be used to view additional values.
Pipelining
All cmdlets accept parameters from the pipeline by name. Generally, cmdlets accept the
friendly name for the entity from the pipeline by value.
For example, the following cmdlets show bindings for the parameter -Name:
Getting Started Guide [Link] page: 11
Selectors, Markings, Policies, and Help Cmdlets / Selectors
Selectors, Markings, Policies,
and Help Cmdlets
You can use the following cmdlets to get selectors, markings, policies, and help.
Selectors
Cmdlet Description
Get-Selector to view all selectors in the selector library
Get-Selector -Name to view a specific selector; for example Get-Selector -
<name> SelectorName Classification to view the 'Classification' selector
Get-SelectorValue - to view all the values for a specific selector; for example Get-
SelectorName SelectorValue - SelectorName Classification to view all values for
<name> the 'Classification' selector
Get-SelectorValue - to view a specific value for a specific selector; for example Get-
SelectorName SelectorValue - SelectorName Classification -ValueName Non-
<name> - Business to view the ‘Non-Business’ value for the ‘Classification’
ValueName <value> selector
Get -Selector -Name pipe the cmdlet to view all properties on the specific selector; for
<name> | Format- example, Get -Selector -Name Classification | Format-List -
List -Property * Property * to view all the properties on the ‘Classification’ selector
Marking Formats
Cmdlet Description
Get- to view all marking formats in the marking format library
MarkingFormat
Get- to view a specific marking format; for example Get-MarkingFormat -
MarkingFormat - Name FLOT to view the first line of text marking format
Name <name>
Policies
Getting Started Guide [Link] page: 12
Selectors, Markings, Policies, and Help Cmdlets / Help
Cmdlet Description
Get-Policy to view all policies for the configuration
Get-Policy -Name to view all the properties on a specific policy; for example Get -
<name> | Format-List Policy -Name MyCompanyClassification | Format-List
Property * Property *
Get-PolicySelector - to view all selectors associated with a specific policy; for
PolicyName <name> example Get-PolicySelector -PolicyName
MyCompanyClassification
Get-PolicySelectorValue to view a specific selector associated with a specific policy; for
-PolicyName <name>- example Get-PolicySelectorValue -PolicyName
SelectorName <name> MyCompanyClassification -SelectorName Classification
Help
The Classifier Administration PowerShell Module and the associated cmdlets support the
Get-Help cmdlet.
Cmdlet Description
Get-Help to view help on a specific cmdlet; for example Get -Help Get -
<cmdlet> ServerConfiguration to view help on the Get -ServerConfiguration cmdlet
Get-Help to view examples on a specific cmdlet; for example Get -Help Get -
<cmdlet> - ServerConfiguration -examples to view examples on the Get -
examples ServerConfiguration cmdlet
Get-Help to view detailed information on a specific cmdlet; for example Get -Help Get
<cmdlet> - -ServerConfiguration -detailed to view detailed information on the Get -
detailed ServerConfiguration cmdlet
Get-Help to view technical information on a specific cmdlet; for example Get -Help Get
<cmdlet> - -ServerConfiguration -full to view technical information on the Get -
full ServerConfiguration cmdlet
Getting Started Guide [Link] page: 13
Contacting Fortra /
Contacting Fortra
Please contact Fortra for questions or to receive information about Classifier Administration
PowerShell. You can contact us to receive technical bulletins, updates, program fixes, and
other information via electronic mail, Internet, or fax.
For additional resources, or to contact Technical Support, visit [Link]/technical-
support, or contact Boldon James at [Link]@[Link].
For support issues, please provide the following:
l Check this guide's table of contents and index for information that addresses your
concern.
l Gather and organize as much information as possible about the problem including
job/error logs, screen shots or anything else to document the issue.
Getting Started Guide [Link] page: 14
