Service2CM Installation Guide
DISCLAIMER
Any advice FYB provides in relation to setting up any FYB App, FYB Add-in, FYB Connector and or advice in relation to opening access to your on-premises or in the cloud systems will be general advice only. This means that the advice is of a general nature and will not consider your network setup, network infrastructure or any security requirements that you may have or in fact need. It is highly advised that you seek advice from internal or external providers to ensure that they are comfortable with what is required prior to going ahead with any deployment, setup, or configuration for external access.
LICENSE DETAILS
Please contact FYB for a valid license if you are yet to obtain one for your Add-In.
INSTALLATION COMPONENTS
The following installation components are required to ensure the full functionality of the FYB Service2CM:
- FYB Service2CM connector - this is a server-side installation
INSTALLING FYB SERVICE2CM
LICENSE
-
Create a folder to house the license file (.lic) on the IIS Server
-
Place the license file in this folder
NotePlease be aware you will be asked to enter this location during the installation
TRUSTED USER ACCOUNT
Add the account that will run the application pool as a Trusted User in Enterprise Studio. Please refer to your Enterprise Studio help file on adding trusted accounts. If using a system account (application pool identity, network service etc) you will be required to enter the details as DOMAIN\ServerName$. If using a dedicated windows service account, you will be required to enter the details as DOMAIN\username.
INSTALLATION
Note that this version of Service2CM (v2) is a major update and is not backwards compatible with previous versions.
To preserve existing connections a backup of your current version must be taken and existing connections will need to be re-imported via the admin console after installation is complete.
You should complete a full uninstall of the previous version before installing this version. The uninstall steps can be found in the relevant versions installation guide.
You will also need to obtain a new license type from FYB if upgrading to this version. Previous license files will not work even if they have not expired.
Before running the MSI ensure that all prerequisites are complete. Including deploying the .NET 8 SDK and Hosting Bundle.
To deploy the Net Core SDK and Hosting Bundle to the server, follow these steps:
-
Install the latest .NET 8 SDK (x64) found here

-
Install the latest ASP.NET Core 8 Runtime Hosting Bundle found here

-
Once both executables have been installed, complete a full server restart to allow for .NET 8 to bind to IIS. If a server restart is not possible an IIS reset can be completed with the following CMDs from an elevated command prompt.
- net stop was /y
- net start w3svc
- iisreset
NoteTo check that the SDK has been attached to the hosting bundle, open Command Prompt and type dotnet --info

The Service2CM MSI will:
- Deploy the installation files
- Setup the application pool and application in IIS
- Setup the temp folder
- Configure the Service2CM as specified by the user
To install the Service2CM Application, follow these steps:
-
Run command prompt as an administrator and launch the service2cm.msi
-
Click on the Next button

-
On the Web Application Settings screen select the HTTPS protected site (recommended) to host the applicationand click on the Next button
NoteThe virtual directory name must remain as Service2CM and it cannot be renamed.
IIS DirectoryThe application must be installed under the dedicated site as an application. It cannot be installed at the site level

-
On the Application Pool Settings screen (below), enter the domain, username, and password for the Application Pool identity. Click the Next button
-
On the Configuration Settings screen enter the required information. Further details are in the table below.
-
Click on the Next button

FIELD DESCRIPTION Dataset ID Content Manager two-character dataset identifier Workgroup Server Name Content Manager workgroup server name. The workgroup server name or workgroup URL can be utilised to establish a dataset connection. Workgroup Server URL Content Manager workgroup server URL. The workgroup server name or workgroup URL can be utilised to establish a dataset connection. License Path Local path to Service2CM license file Temp Path Local temporary directory used by the application to cache content manager documents. Please include the trailing slash, for example: C:\FYB Add-Ins\Service2CM\ -
If your environment is configured to only allow OpenId authentication (e.g. Azure AD or ADFS) for your Content Manager, you'll receive the following message:
-
Click OK to navigate to the Open Id settings screen and enter the required values.
NoteNAME DESCRIPTION Client Id The Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the username of the Confidential Client app. Client Secret The Client/App Secret of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the password of the Confidential Client app. Trusted User The Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app. NoteA designated CM Location is required to be nominated as the Trusted User. The CM Location will require the following permissions:
- Record Update Permissions
- Create Records
- Modify Records
- Extract Document
- Append To Existing Notes
- Update Document
- Modify Record Additional Field Values
- Record Update Permissions
-
On the ServiceNow Settings screen, enter the following fields: Ensuring the Connected App Set up guide has been completed prior to completing these settings.

| FIELD | DESCRIPTION |
|---|---|
| ServiceNow Instance | The ServiceNow instance that Service2CM will utilise for data retrieval. The instance URL must contain the trailing backslash / |
| Client ID | The Client Id of the OAuth Credential Connected App created in ServiceNow |
| Client Secret | The Client Secret value of the OAuth Credential Connected app created in ServiceNow |
| Username | The username of the administration account within Service Now that will be used to authenticate all data retrieval |
| Password | The password of the administration account within Service Now that will be used to authenticate all data retrieval |
-
On the Email Settings screen, enter the following fields

FIELD DESCRIPTION License Contacts Contacts that will receive a notification when the 3652CM license is about to expire. Multiple email addresses can be added if separated with a ; From Address The email address that all email notifications are sent from Mail Host The mail host that is used to send all email notifications from Mail Port The mail port -
On the Custom Setup screen select the install location and click on the Next button

-
From the Confirm Installation window click on the Install button
-
The installation will commence

-
Once the installation is complete click on the Finish button

CONFIGURATION
IIS CONFIGURATION
-
After the installation process is complete, you will be able to locate the application installed within the site selected during installation
-
From the Features View double click on Authentication button and ensure that only Windows Authentication is enabled


-
Right click the application in IIS and select theexplore option

-
Right click the app data folder and select properties

-
Navigate to the security tab and ensure users have read, write and modify permissions

-
Click on Application Pools
-
Within the application pool listing screen, right click on Service2CM application pool and select the Advanced Settings option from the drop-down menu

-
Within the Advanced Settings window, set Start Mode to Always Running, Idle Time-out Action to Suspend and Idle Time-out Action (minutes) to 0

-
Click on the OK button
-
Select the Service2CM application in IIS and navigate to its Advanced Settings

-
Set Preload Enabled to True and click on the OK button

COMMAND LINE ARGUMENTS
| Functionality Name | Command Name |
|---|---|
| Domain for Application Pool | WEB_APP_POOL_IDENTITY_DOMAIN |
| Username for Application Pool | WEB_APP_POOL_IDENTITY_NAME |
| Password for Application Pool: | WEB_APP_POOL_IDENTITY_PWD |
| Dataset ID | DBID |
| Workgroup Server | WORKGROUP_SERVER |
| License Path | LICENSE_PATH |
| Temp Path | TEMP_PATH |
| ServiceNow Instance | INSTANCE |
| Client ID | CLIENTID |
| Client Secret | CLIENTSECRET |
| Username | LOGINUSERNAME |
| Password | LOGINPASSWORD |
| License Contacts | LIC_CONTACTS |
| From Address | FROM_ADDRESS |
| Mail Host | MAIL_HOST |
| Mail Port | MAIL_PORT |
CONTENT MANAGER CONFIGURATION
The following additional fields are mandatory and need to be on the Service2CM Document Record Type that you will be using.
All names of fields below are examples and can be set to your organisations desired terminology.
CONTENT MANAGER CONFIGURATION
RECORD TYPE CONTAINMENT (OPTIONAL)
If you wish to use Requests (REQ's) as the parent container for Request Items (RITM's) then the containment rules of your document record type will need to be adjusted.
These changes only need to be made for the record type you are using for the connector.
-
Right click your document record type and select Properties
-
Click on the Containment Tab. In the dropdowns select Container must have a record type in the specific list for both sections

-
Add your document record type to both lists
-
Click on the OK button

SERVICENOW REQUEST NUMBER ADDITIONAL FIELD
To search for a Content Manager record based on the ServiceNow request number, an additional filed must be created to store the numeric identifier.
-
Navigate to Content Manager Context, Search for ‘Additional Fields’ > All
-
Right click in the view pane and click New Additional Field

-
Select String as Data Format
-
Name the Additional Field ServiceNow Request Number
NoteThis must match the image below exactly

-
Click on the Next button
-
The maximum length should be 255
-
Click on the Next button and click on the Finish button


-
Add the additional field to the document record type that will be used by the connector
CONTAINER ADDITIONAL FIELD
To search for a unique container within Content Manager that stores Service Now requests, an additional field must be made to map between the two systems. This allows for a unique value from the request to be used to map to the correct container in Content Manager (Example: An employee number).
-
Search for ‘Additional Fields’ > All
-
Right click in the view pane and click New Additional Field

-
Select String as Data Format
-
Name the Additional Field ServiceNow Field

-
Click on the Next button
-
Set the Format as specified below. The maximum length should be 255.

-
Click on theNext button and click on the Finish button
Add the additional field to any container record types that are to be used with the connector.
SERVICE NOW CONFIGURATION
TRANSFER STATE
If Cases (CS) are intended for transferring from Service Now to Content Manager, a custom variable choice is required to indicate the success of the transfer into Content Manager. This will also assist with indicating when a case should be transferred within the workflow.
This process must be completed by an Administrator within Service Now.
-
The Transfer State is a choice list custom variable that must be active and on the form.

-
The Transfer State must be in the following properties.

-
This property can be created using the Form Designer.
-
Ensure that the Name is u_transfer_state, as Service2CM will look specifically for this name.
-
Save this variable within the form.
UNINSTALLING FYB SERVICE2CM
MANUAL UNINSTALL
To uninstall the Service2CM manually please follow the steps below:
-
Navigate to control panel
-
Click on the Uninstall a program option
-
Locate FYB Service2CM in the list of Programs and feature

-
Right click on FYB Service2CM and click on the Uninstall button
-
If a warning Prompt appears, click on the Continue button

-
Click the Yes button

-
The uninstallation process will commence

-
Open IIS once the uninstallation process is completed
-
Locate Service2CM in IIS and right click > Remove

-
When the prompt appears click on the Yes button

