Performing configuration tasks in a command line

Use the command line utilities to perform configuration tasks in Mongoose.

These utilities are available using a Command Line Interface (CLI):

Utility Description
InforDBCL.exe This utility contains the configuration tasks that involve databases. These are the available commands, with links to the appropriate sections for details:
InforWebCL.exe This utility contains all configuration tasks associated with IIS and clients. These are the available commands, with links to the appropriate sections for details:
InforServiceCL.exe This utility contains the configuration tasks dealing with Windows services and replication. These are the available commands, with links to the appropriate sections for details:
Note: The command must be the first argument. All command options in brackets are optional. Values that contain spaces must be in double quotes.

InforDbCL.exe CreateDb

Use this command to create a new database.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-databasename This option specifies the name of the SQL database.
-dbtype This option specifies what type of database it is. Types include these:
  • App
  • Objects
  • Forms
  • Templates

This command is required unless you are using the -allinonedb option.

[-allinonedb] This value is used to create an all-in-one database, where application, form, object, and template objects all reside in the same database.
[-collation] This option specifies the means of collation to be used in sorting the SQL data. Valid values are those supported by your version of SQL Server.
[-clouddb]:True/False When set to True, this option indicates that the database must be set up for use in the multi-tenant cloud. When this option is used, it also sets the [-populatedb] option to True.
[-dbspec] This option specifies the name of a specific database to be created; for example, ApplicationDbDemo or ApplicationDb.

This option is a technical designation of the database type, beyond the four normal types used for the -dbtype option. This option is rarely used: The only time you might want to use this option is when you have an application that is using its own unique database type.

[-dbsubtype]

This option specifies a subtype for the database. Alternatives include these:

  • Initialized: If this option is not specified, this is the default value. This value applies only to -dbtype:App databases.
  • Empty: This value is used for migrations from Progress to SQL, or for an application database schema with no data. This value is non-functional until key data is provided.
  • Demo: This value is for a database, where dummy demo data is provided.
[-log] Use this option to specify the complete path to the log file.
[-password] This value is not required for Windows authentication.
[-populatedb]:True/False When set to True, this option indicates that an empty database has been created already and needs just to be populated with the schema and the data.

Cloud installations always use this option, typically through use of the [-clouddb] option. On-premise installtions typically do not use this option, but they can if they have created the SQL database before installation.

[-product] This option specifies the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
[-scripteddb] Use this option to specify that the cloud database is a scripted one, and not restored from old image.
[-servername] Use this option to specify the name of the SQL server.
[-setonpremnocount]:True/False When set to True, this option sets NOCOUNT for each SQL instance.
[-siteid] Use this option to specify the site ID for an application database.
[-sitename] Use this option to set the name for a site's application database.
[-sitedesc] Use this option to specify a description for a site's application database.
[-sitegroup] Use this option to specify the name for a site group of application databases.
[-sitecurrency] Use this option to specify the currency to use for a site's application database or to specify the currency code for a SQL server.
[-sitetype] Use this option to specify what type of site the application database is in. Valid values are S (Site) and E (Entity).

If no value is provided, the default value is S.

[-sqlservertimezone] This option specifies the standard time zone to be used by the SQL server.
[-timezone] This option specifies the standard time zone to be used by the application database.
[-username] This option specifies the user ID (username) to be used when accessing the SQL server.
Examples:

infordbcl.exe createdb -databasename:CmdApp -username:sa -password:test123 -servername:win2012 -dbtype:App -product:SL

infordbcl.exe createdb -databasename:CloudApp -username:sa -password:test123 -servername:win2012 -dbtype:App -product:SL -clouddb

infordbcl.exe createdb -databasename:Mongoose_Forms -username:sa -password:test123 -servername:win2012 -dbtype:Forms -product:Mongoose

InfordDbCL.exe LinkMultiSite

Use this command to link multi-site databases.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-databasename Use this option to specify the name of the SQL database for Site A.
-siteid Use this option to specify the ID of the database for Site A.
[-sitename] Use this option to specify the name of the database for Site A that is read from the source database. This value is provided to overwrite the existing Site A name.
[-sitedesc] Use this option to specify the description of the database for Site A that is read from the source database. This value is provided to overwrite the existing Site A description.
[-sitetype] Use this option to specify the type of the database for Site A, such as S (Site) or E (Entity), that is read from the source database. This value can be used to overwrite the existing Site A type.
[-password] Use this option to specify the user password for the Site A SQL database.

This option is not required for Windows authentication.

[-servername] Use this option to specify the name of the SQL server for the Site A SQL database. Alternately, you can specify the local machine name for the database, if that is where the database resides.
[-username] Use this option to specify the user ID (username) to be used to access the Site A SQL database.

This option is not required for Windows authentication.

[-groupname] Use this option to specify the name of the multi-site group.
-databasename2 Use this option to specify the name of the SQL database for Site B.
-siteid2 Use this option to specify the ID of the database for Site B.
[-sitename2] Use this option to specify the name of the database for Site B that is read from the source database. This value is provided to overwrite the existing Site B name.
[-sitedesc2] Use this option to specify the description of the database for Site B that is read from the source database. This value is provided to overwrite the existing Site B description.
[-sitetype2] Use this option to specify the type of the database for Site B, such as S (Site) or E (Entity), that is read from the source database. This value is provided to overwrite the existing Site B type.
[-password2] Use this option to specify the user password for the Site B SQL database.

This option is not required for Windows authentication.

[-servername2] Use this option to specify the name of the SQL server for the Site B SQL database. Alternately, you can specify the local machine name for the database, if that is where the database resides.
[-username2] Use this option to specify the user ID (username) to be used to access the Site B SQL database.

This option is not required for Windows authentication.

[-log] Use this option to specify the complete path to the log file.
Example:

infordbcl.exe linkmultisite -databasename:"Mongoose1_App" -username:sa -password:test123 -servername:win2012 -siteid:1 -sitedesc:"This is site 1" -sitetype:S -sitename:"Alpha Site" -groupname:Test -databasename2:"Mongoose2_App" -username2:sa -password2:test123 -siteid2:2 -sitetype2:S -sitedesc2:"This is site 2" -servername2:"win2012" -sitename2:"Beta Site"

InforDBCL.exe LoadTrans

Use this command to load either SQL files or BCP files for the translated data.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-config Use this option to specify the configuration for your application that contains the application and forms database data.
-trans Use this option to specify the language to use for translation purposes.

This value corresponds to the locale subfolder; for example, zh-CN and es-MX.

-winstudiodir Use this option to specify the folder where your Mongoose-based application is installed and where the language packs exist.
Example:

infordbcl.exe loadtrans -config:MyConfig -trans:es-mx -winstudiodir:”C:\Program Files\Infor\Mongoose”

InforDBCL.exe RemoveTrans

Use this command to remove both application messages and vendor level translated strings for the language.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-config Use this option to specify the configuration for your application that contains the application and forms database data.
-trans Use this option to specify the language to use for translation purposes.

This value corresponds to the locale subfolder; for example, zh-CN and es-MX.

Example:

Infordbcl.exe removetrans -config:MyConfig -trans:es-mx

InforDbCL.exe ApplyPack

Use this command to apply either an Industry Pack or a Localization to a set of databases.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-pack Use this option to specify the industry or localization pack to apply to the set of databases.

The value corresponds to the local subfolder; for example, automotive or CN00.

-config Use this option to specify the configuration for your application that contains the application and forms database data.
[-reportserverurl] This option specifies the complete URL for the report server, to be used when empty reports are not to be loaded.
[-reportparentfolder] This option specifies the parent folder on the report server to be used when empty reports are not to be loaded.
[-reportdir] This option specifies the folder to which local reports are to upload.

If no folder is specified, this option defaults to this: [WinStudioDir]\Report\Reports

[-log] Use this option to specify the complete path to the log file.
[-alwayson] Use this option to to establish a SQL connection to an AlwaysOn Availability Group.
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
Example:

infordbcl.exe applypack -config:SL9 -pack:automotive -reportserverurl:http://win2012/reportserver -reportparentfolder:SyteLineReports

InforDbCL.exe AddSite

This command adds a site to a multi-site setup.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-databasename This option specifies the name of the SQL database.
[-alwayson] Use this option to to establish a SQL connection to an AlwaysOn Availability Group.
[-deletedata] Use this option to delete all data in an existing database.
Caution: 
This option cannot be undone!
[-log] Use this option to specify the complete path to the log file.
[-password] Use this option to specify the user password for the SQL server.

This option is not required for Windows authentication.

[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
[-siteid] Use this option to specify the site ID for an application database.
[-sitename] Use this option to specify the name for a site's application database.
[-sitedesc] Use this option to specify a description for a site's application database.
[-sitegroup] Use this option to specify the name for a site group of application databases.
[-sitecurrency] Use this option to specify the currency to use for a site's application database or to specify the currency code for a SQL server.
[-sitetype] Use this option to specify what type of site the application database is in. Valid values are S (Site) and E (Entity). If no value is provided, the default value is S.
[-servername] Use this option to specify the name of the SQL server.

Alternatively, you can specify the name of the local machine.

[-sqlservertimezone] Use this option to specify the standard time zone to be used by the SQL server.
[-timezone] Use this option to specify the standard time zone to be used by the application database.
[-username] Use this option to specify the user ID (username) to be used to access the Site A SQL database.

This option is not required for Windows authentication.

Example:

infordbcl.exe addsite -databasename:SyteLine_AppDemo -product:SL -siteid:Site9 -username:sa -password:test123

InforDbCL.exe CopySite

Use this command to copy site data to a new site.

Note: Data in tables that do not have a primary key or any unique key are not copied. These tables are skipped.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-sourcedatabasename This option specifies the name of the SQL database that contains the existing site data to be copied.
-sourcesiteid This option specifies the ID of the site to be copied.
-targetdatabasename This option specifies the name of the SQL database where the new site is to be created and to which the existing site data is to be copied.
[-alwayson] Use this option to to establish a SQL connection to an AlwaysOn Availability Group.
[-analyzeonly] Use this option to run through the site copy process to analyze for potential problems.

No copying actually takes place in this mode.

[-bcptimeout] This option specifies the amount of time, in milliseconds, to wait for a Bulk Copy Program (BCP) file loading action to complete before timing out.

The default value is 15000, but this is dynamically adjusted for large files.

[-bcpexporttimeout] This option specifies the amount of time, in milliseconds, to wait for a BCP export action to complete before timing out.

The default value is 15000, but this is dynamically adjusted for large tables.

[-deletedata] Use this option to delete all data in the target database.
Caution: 
This option cannot be undone!
[-end] This option specifies the stage in the process where the copying is to end; for example AES (Application Event System data).

These are the stages that can be designated:

  • Validation
  • Partition
  • UETs
  • NonSharedTables
  • SharedTables
  • Users
  • Notes
  • Documents
  • AES
  • Cleanup
[-log] Use this option to specify the complete path to the log file.
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
[-sourceusername] Use this option to specify the user ID (username) to be used to access the data on the source SQL Server.
[-sourcepassword] Use this option to specify the user password to be used to access the data on the source SQL Server.

This option is not required for Windows authentication.

[-sourceservername] Use this option to specify the name of the SQL Server where the source database resides.
[-sqlservertimezone] Use this option to specify the standard time zone to be used by the SQL server.
[-start] Use this option to specify the stage in the process where the copying is to begin; for example: Users

These are the stages that can be designated:

  • Validation
  • Partition
  • UETs
  • NonSharedTables
  • SharedTables
  • Users
  • Notes
  • Documents
  • AES
  • Cleanup
[-targetusername] Use this option to specify the user ID (username) to be used to access the data on the target SQL Server.
[-targetpassword] Use this option to specify the user password to be used to access the data on the target SQL Server.
[-targetservername] Use this option to specify the name of the SQL Server where the target database resides.
Examples:

infordbcl.exe copysite -sourcedatabasename:MongooseDev -product:Mongoose -sourcesiteid:Foo -targetdatabasename:MongooseProd -alwayson

infordbcl.exe copysite -sourcedatabasename:MongooseDev -product:Mongoose -sourcesiteid:Foo -targetdatabasename:MongooseProd -bcptimeout:40000 -bcpexporttimeout:100000

infordbcl.exe copysite -sourcedatabasename:MongooseDev -product:Mongoose -sourcesiteid:Foo -sourceusername:sa -sourcepassword:test123 -sourceservername:win2016\sql -targetdatabasename:MongooseProd

infordbcl.exe copysite –sourcedatabasename:SourceDB –product:Mongoose –sourcesiteid:DEFAULT –targetdatabasename:TargetDB –start:Users –end:AES

InforDbCL.exe CreateConfig

Use this command to create a configuration for your Mongoose-based application.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-name Use this option to specify the name of the new configuration.
-db If you are creating a conguration for an All-In-One database, use this option to name the (single) database.

If you are creating separate databases for the configuration, use the individual database options that follow.

[-host] Use this option to specify the name of the server that is to host the databases. This can be the name of a SQL instance.
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.

If no GlobalSettings.xml file is used, this option is required.

[-encryptionkey] Use this option to specify the encryption key to be used for encrypted data columns in the configuration.
Caution: 
Be careful to ensure that this key is backed up in a secure location.
[-user] Use this option to specify a user ID (username) to use for database access.

If this is not provided, a Windows user account is used. If set as an account with database permission. a running IDO Runtime Windows service is required for Windows users.

[-password] Use this option to specify the user password to use for database access.

If SQL authentication is used for the configuration, this option is required.

[-site] Use this option to specify the name of a site in the configuration.

If this option is not used, the default value is default.

[-taskman]:True/False When set to True, this option adds the newly created configuration to TaskMan service monitoring.

The default value is True.

[-miscinfo] Use this option to provide the text for any miscellaneous connection information needed to connect to the database.
[-idopartialtrust]:True/False When set to True, this option sets the IDO Extension Class to partial trust.

The default value is True.

[-webclientpartialtrust]:True/False When set to True, this option sets the web client to partial trust.

The default value is True.

[-appdb] If you are creating separate databases for your configuration, (rather than an All-In-One database), use this option to name the application database.
[-appuser] Use this option to specify the user ID (username) to use for the application database.
-[apppassword] Use this option to specify the user password to use for the application database.
[-apphost] Use this option to specify the name of the server that is to host the application database. This can be the name of a SQL instance.
[-application] Use this option to specify the name of an application for the new configuration.

If this option is not specified, the default value for the application name is <default>.

[-archivetemplatesdb] If you are creating separate databases for your configuration, (rather than an All-In-One database), use this option to name the archive database for forms templates.
[-archiveuser] Use this option to specify the user ID (username) to use for the forms archive database.
-[archivepassword] Use this option to specify the user password to use for the forms archive database.
[-archivehost] Use this option to specify the name of the server that is to host the forms archive database. This can be the name of a SQL instance.
[-archiveinstance] This is the same as the [-archivehost]: option.
[-archivemisc] Use this option to provide the text for any miscellaneous connection information needed to connect to the forms archive database.
[-eventservice]:True/False When set to True, this option adds the newly created configuration to the event service.

The default value is True.

[-formsdb] If you are creating separate databases for your configuration, (rather than an All-In-One database), use this option to name the forms database.
[-formsuser] Use this option to specify the user ID (username) to use for the forms database.
-[formspassword] Use this option to specify the user password to use for the forms database.
[-formshost] Use this option to specify the name of the server that is to host the forms database. This can be the name of a SQL instance.

If this is not specified, the default value is the machine name.

[-masterdb] If you are creating separate databases for your configuration, (rather than an All-In-One database), use this option to name the master forms database.
[-masteruser] Use this option to specify the user ID (username) to use for the master forms database.
-[masterpassword] Use this option to specify the user password to use for the master forms database.
[-masterhost] Use this option to specify the name of the server that is to host the master forms database. This can be the name of a SQL instance.
[-mastertemplatesdb] Use this option to specify the name of the database to use for templates of the master forms.
[-masterinstance] This is the same as the [-masterhost]: option.
[-mastermisc] Use this option to provide the text for any miscellaneous connection information needed to connect to the master forms database.
[-objectsdb] If you are creating separate databases for your configuration, (rather than an All-In-One database), use this option to name the objects database.
[-objectsuser] Use this option to specify the user ID (username) to use for the objects database.
-[objectspassword] Use this option to specify the user password to use for the objects database.
[-objectsshost] Use this option to specify the name of the server that is to host the objects database. This can be the name of a SQL instance.
[-templatesdb] If you are creating separate databases for your configuration, (rather than an All-In-One database), use this option to name the templates database.
[-templatesuser] Use this option to specify the user ID (username) to use for the templates database.
-[templatespassword] Use this option to specify the user password to use for the templates database.
[-templateshost] Use this option to specify the name of the server that is to host the templates database. This can be the name of a SQL instance.
Example:

infordbcl.exe createconfig -name:MongooseDev -product:Mongoose -db:Mongoose_All

infordbcl.exe createconfig -name:MongooseDev -product:Mongoose -db:MG_All -host:win2012r2\sql -user:sa -password:test123

infordbcl.exe createconfig -name:MongooseDev -product:Mongoose -db:Mongoose_All

infordbcl.exe createconfig -name:MongooseDev -product:Mongoose -appdb:MG_App -formsdb:MG_Forms -objectsdb:MG_Objects -templatesdb:MG_Templates -host:win2012r2 -user:sa -password:test123

infordbcl.exe createconfig -name:CSIConfig -db:CSI_AllinOne -host:win2016

infordbcl.exe createconfig -name:MongooseDev-product:Mongoose -db:Mongoose_All -encryptionkey:slj349suWO38wiz

InforDbCL.exe copyformsdata / InforDbCL.exe copyobjectsdata / InforDbCL.exe copytemplatesdata

Use these commands to copy data from a source configuration to a target configuration. You must specify either a configuration name or database information for both the source and the target. If a configuration name is given, all other parameters for that database are ignored.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
[-sourceconfig] Use this option to specify the name of the source configuration.
[-sourceinstance] Use this option to specify the SQL Server instance for the source.

If this option is not specified, the value defaults to the machine name of the source configuration.

[-sourcedb] If no configuration is specified, use this option to specify the name of the SQL database to use as the source.
[-sourceuser] Use this option to specify the user ID (username) to be used to access the source SQL database.

If no configuration has been specified, the value for this defaults to the current Windows user.

[-sourcepassword] Use this option to specify the user password to be used to access the source SQL database.

If no configuration has been specified, the value for this defaults to the current Windows user.

[-sourcealwayson]:True/False If SQL Server AlwaysOn availability groups are in use for the target and no configuration is specified, this option is set to True.
[-targetconfig] Use this option to specify the name of the target configuration.
[-targetinstance] Use this option to specify the SQL Server instance for the target.

If this option is not specified, the value defaults to the machine name of the target configuration.

[-targetdb] If no configuration is specified, use this option to specify the name of the SQL database to use as the target.
[-targetuser] Use this option to specify the user ID (username) to be used to access the target SQL database.

If no configuration has been specified, the value for this defaults to the current Windows user.

[-targetpassword] Use this option to specify the user password to be used to access the target SQL database.

If no configuration has been specified, the value for this defaults to the current Windows user.

[-targetalwayson]:True/False If SQL Server AlwaysOn availability groups are in use for the target and no configuration is specified, this option is set to True.
Examples:

infordbcl.exe copyformsdata -sourceconfig:ConfigA -targetconfig:ConfigB

infordbcl.exe copyformsdata -sourceinstance:myserver\sql1 -sourcedb:DatabaseA -sourceuser:sa -sourcepassword:test123 -sourcealwayson:false -targetinstance:myserver\sql2 -targetdb:DatabaseB -targetuser:user -targetpassword:testabcd -targetalwayson:true

InforWebCL.exe WebClient

Use this command to configure a web client for your Mongoose-based application.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
[-allowfrom] Use this option to specify the X-frame-options allow-from value as a full URL; for example, http://win2012r2/.

This option is necessary if you want to embed the web client in a frame, such as Infor OS Portal or Infor Ming.le, which SAMEORIGIN is by default.

This option uses the SAMEORIGIN on empty string and accepts the DENY string to deny all embedding.

[-apppool] Use this option to specify the application pool for the web client in IIS. By default, this is ASP.NET v4.0.
[-apppoolidle] Use this option to specify, in minutes, the idle time for an application pool.
[-appurl] Use this option to specify the URL to the application. This option is required with ADFS, PingFederate, and Infor STS Cloud.
[-auth] Use this option to specify the type of authorization being used. This value is an integer where these are the possible values:
  • 0 is the built-in authorization, and which is the default value.
  • 1 is for IIS.
  • 2 is for AD FS and Infor STS on-premise.
  • 3 is for IDP for PingFederate or Infor STS in the cloud.
[-csp] Use this option to specify the Content Security Policy value.
[-customlog] Use this option to specify the location of the directory to be used for custom IIS log files. You can also specify the site default log location.

This option is required if IIS logging is not used at the default location and if -restrictpermissions is used.

[-dir] Use this option to specify the name of the virtual directory to use for IIS.

By default, this value is WSWebClient.

[-enablecsrf]:True/False When set to True, this option sets the option to use Cross Site Request Forgery (CSRF) security.
[-executiontimeout] Use this option to specify the maximum number of seconds a request is allowed to execute before being automatically shut down by ASP.NET.
[-fedurl] Use this option to specify the URL to the Federation service; for example:

https://server/adfs/ls/

[-fedxml] Use this option to specify the URL to the Federation metadata XML file; for example:

https://server/FederationMetadata/2007-06/FederationMetadata.xml

This command is used only for ADFS authentication.

[-handshake] Use this option to specify a single GUID or a comma-delimited list of GUIDs to be used for the server "handshake".
[-idpfile] Use this option to specify the full path to the idp.properties file, which is used only for Federate and Infor STS IDP authentication.
[-log] Use this option to specify the complete path to the log file.
[-path] Use this option to specify the physical path to the virtual directory, which by default is: wwwroot\WSWebClient
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.

If no GlobalSettings.xml file is used, this option is required.

[-timeout] Use this option to set the amount of time, in minutes, that a session can be idle before it times out.

By default, this is set to 30.

[-remoteido]:True/False When set to True, this option specifies that the IDO is on a remote server, rather than in the local IDO web service.

By default this is set to False.

[-requestserverurl] When the [-remoteido] option is set to True, use this option to provide the URL for the IDORequest service on the remote IDO server; for example:

https://farmServer/IDORequestService/RequestServer.aspx
[-remoteidourl] Use this option to specify the URL to a remote configuration server; for example:

-remoteido:true -remoteidourl:https://serverName/idorequestservice/configserver.aspx
[-restrictfiles]:True/False When set to True, this option restricts the types of files that are allowed.

By default, this is False.

[-restrictfilelist] Use this option to specify a list file types, by extensions, that are to be permitted. These "white-listed" file types must be presented as a comma-delimited list of extensions including periods, with no spaces; for example:

.png,.js,.css,.jpg

[-restrictpermissions]:True/False When set to True, option uses least privilege permissions by setting the IIS ApplicationIdentity account to have access to needed folders, instead of using LocalSystem.
[-showname]:True/False When set to True, this option specifies that the mgShowName development testing value is to be used.

Omit this for empty strings or any of the following values: justOuter, andValue, andGridCell.

This option is useful mostly for debugging code.

[-site] Use this option to specify the name of an IIS site in the configuration.

If this option is not used, the default value is Default Web Site.

[-ssl]:True/False When set to True, this option specifies that Secure Sockets Layer (SSL) is required for cookie authentication.

By default, this is set to True.

[-stscert] Use this option to provide the certificate "thumb print" for federation certification.

This is used only for ADFS authentication or for on-premises Infor STS.

[-trustserver] Use this option to specify the URL for the ADFS trusted server.

This is used only for ADFS athentication.

Examples:

inforwebcl.exe webclient -product:SL

inforwebcl.exe webclient -timeout:20 -remoteido:true -remoteidourl:http://server2/idorequestservice/configserver.aspx

inforwebcl.exe webclient -product:Mongoose -auth:1

inforwebcl.exe webclient -product:Mongoose -auth:3 -idpfile:idp.properties -appurl:https://win2012/wswebclient

inforwebcl.exe webclient -product:Mongoose -auth:3 -idpfile:idp.properties -appurl:https://myserver/wswebclient -handshake:A35E058100EC45FCAF625EE93DC4665E

InforWebCL.exe SmartClient

Use this command to configure the Windows client (aka the "smart client") for your Mongoose-based application.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-appname Use this option to specify the name of the Windows client; for example: "Mongoose Smart Client"
-webserver Use this option to specify the name of the ClickOnce web server that hosts the application.
[-apppool] Use this option to specify the IIS application pool to be used.

By default, this is set to ASP.NET v4.0.

[-configserver] Use this option to specify the name of the server where the remote IDO resides.
[-configserverdoc] Use this option to specify the name of the XML configuration file from the configuration server to use.

By default, this is ConfigServerURLs.XML.

[-configserverurl] Use this option to specify the full URL, with the protocol, of the configuration server that overrides the -configserver value, if one has been provided. This option automatically sets the -remoteido to True.
[-configserverxml] Use this option to specify the file name of a custom XML file to insert into the ConfigServerDoc.XML file.

Standard .NET string replacements are done in this order: Protocol > Config Server Name > Remember Config Group value > PrefPathOverride value.

By default, this option uses the standard ClickOnce XML content.

[-customcertpassword] Use this option to specify the password to use with a custom authentication code certificate.
[-customcertpath] Use this option to specify the path to a custom authentication code certificate for the Windows client.
[-deploymanifest] Use this option to specify the name of the deployment manifest file for ClickOnce.

If this is not specified, the name of the Mongoose-based application is used.

[-dir] Use this option to specify the name of the directory for IIS.

By default, this is ClientDeploy.

[-icon] Use this option to specify the name of the icon file to be used.

By default, this is favicon.ico.

[-log] Use this option to specify the complete path to the log file.
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
[-protocol] Use this option to specify the communication protocol to use for the client.

By default, this is http.

[-remconfig] Use this option to cause the system to "remember" the value of the Configuration Group.

The value must be an integer.

[-remoteido]:True/False When set to True, this option signifies that the IDO is a remote IDO.

By default, this value is False.

[-root] Use this option to specify the physical root folder for ClickOnce, relative to the Mongoose-based application folder.

By default, this is ClientDeploy.

[-site] Use this option to specify the name of the IIS site to use for the Windows client.

By default, this is Default Web Site.

[-version] Use this option to specify the version number to use for the ClickOnce manifest, using the format x.x.x.x; for example: 9.2.0.1
Examples:

inforwebcl.exe smartclient -product:SL -appname:"CloudSuite Smart Client" -webserver:win2012 -root:SLClientDeploy -dir:SLClientDeploy

inforwebcl.exe smartclient -product:Mongoose -appname:"Sweet Mongoose App" -webserver:win2012

InforWebCL.exe WebApp

Use this command to configure a web application, such as IDORequestService or InboundQueue.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-dir Use this option to specify the name of the directory in which the IIS web app is to reside; for example: IDORequestService
-product Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
[-allowfrom] Use this option to specify the X-frame-options allow-from value as a full URL; for example, http://win2012r2/.

This option is necessary if you want to embed the web app in a frame, such as Infor OS Portal or Infor Ming.le, which SAMEORIGIN is by default.

This option uses the SAMEORIGIN on empty string and accepts the DENY string to deny all embedding.

[-apppool] Use this option to specify the IIS application pool to be used.

By default, this is set to ASP.NET v4.0.

[-csp] Use this option to specify the Content Security Policy value.

By default, this is "frame-ancestors 'self';".

[-customlog] Use this option to specify the location of the directory to be used for custom IIS log files. You can also specify the site default log location.

This option is required if IIS logging is not used at the default location and if -restrictpermissions is used.

[-enableoauth]:True/False When set to True, this option enables REST OAuth workstation logons.
[-handshake] Use this option to specify a single GUID or a comma-delimited list of GUIDs to be used for the server "handshake".
[-log] Use this option to specify the complete path to the log file.
[-oauthkey] Use this option to specify the OAuth Consumer Key or, alternately, the client ID value.
[-oauthsecret] Use this option to specify the OAuth Consumer Secret value.
[-ocikey] Use this option to specify the encryption key value for the OCI (Open Catalog Interface) web server.
[-path] Use this option to specify the physical path to the virtual directory, which by default is: wwwroot\DirectoryName
[-reportservermemcache] Use this option to specify the value of useReportServerMemoryCache in the web.config file.
[-resthttps]:True/False When set to True, this option specifies MG REST binding to https.

By default, this is set to True.

[-snapshotdelay] Use this option to set the value for the FormAsImage service snapshot delay, in seconds.

The typical value is 10.

[-site] Use this option to specify the name of the IIS site to use for the Windows client.

By default, this is Default Web Site.

[-timeout] Use this option to set the timeout, in seconds, for the FormAsImage service.

The typical value is 30.

[-webclienturl] Use this option to specify the URL for the FormAsImage service root web client; for example: https://win2012r2/wswebclient/
[-serviceconfigserverurl] Use this option to set HTTPS/HTTP binding for DataView reports and the Configuration Server URL in the Service Configuration Manager.

This must be a complete URL.

Examples:

inforwebcl.exe webapp -dir:IDORequestService

inforwebcl.exe webapp -dir:IDORequestService -apppool:DefaultAppPool

inforwebcl.exe webapp -dir:IDORequestService -product:Mongoose -handshake:A35E058100EC45FCAF625EE93DC4665E

InforWebCL.exe EndUser

Use this command to configure the end user client shortcut.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-configserver Use this option to specify the full URL to the configuration server.
-shortcutname Use this option to specify a name for the shortcut to the configuration server.
[-description] Use this option to specify the text to be used as the description for the shortcut.

This description text displays in the Comments field of the shortcut's Properties dialog box.

[-icon] Use this option to specify the name and location of the icon to use for the shortcut.

By default, this is Infor\productName\ERP.ico.

[-log] Use this option to specify the complete path to the log file.
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.
Example:

This example creates a desktop shortcut to Mongoose:

inforwebcl.exe enduser -configserver:http://win2012/idorequestservice/configserver.aspx -product:Mongoose -shortcutname:"Infor Mongoose"

InforWebCL.exe SPProperties (Service Provider properties)

Use this command to create a configuration file, called the sp.properties file, in a prescribed format. This file is provided to the Identity Provider (IDP) to create a trust connection. The service provider (SP) essentially configures your setup and the IDP controls the logins.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-appname Use this option to specify the name of your Mongoose-based application; for example: SyteLine
Note: If the name includes spaces (which we do NOT recommend), it must be enclosed in double quotation marks.
-appdesc Use this option to provide a short text description of your Mongoose-based application. This description is included as part of the IDP information.
Note: If the text includes spaces, it must be enclosed in double quotation marks.
-entityurl Use this option to provide the complete URL to the web client.

This requires the use of "https" and a port number; for example: https://myServer:44300/WSWebClient
-outputpath Use this option to specify the local directory where the sp.properties file is to be written.

If this option is not provided, the directory for your executable or your working directory is set by default.

[-log] Use this option to specify the complete path to the log file.
Example:

inforwebcl.exe spproperties -appname:MyApp -appdesc:"A great app" -entityurl:http://win2012/wswebclient -outputpath:c:\users\administrators\desktop

InforWebCL.exe servicePing

Use this command to perform health checks on the configured Infor Framework (Windows) services. This command makes use of ALB (Application Load Balancing) to monitor the health of the various services.

For these checks to be successful, IIS must be installed and running. Any attempt to execute a health check if the IIS is not running must be handled by the application that is attempting the check. The service ping is in the web service IDORequestService, which is also required to be installed on the application server.

Before attempting to use this command, the web.config file must be updated to include the configuration in the appSettings section of the code. Use this format: 

<appSettings> 
   <add key=”enablePingEvent” value=”true”> 
</appSettings>

For any service being checked, this command returns one of these messages:

  • 200 - The service is operating within normal parameters.
  • 503 - The service is unavailable.
  • 404 - The service file is not found.

These are the available command options, formatted (and some with examples):

Name of Infor Framework service: Notes/Web.config key:
IDORuntime Service Key: enablePingIDORuntime

Default value: true

If this key is used, you must also provide a [path] switch/option consisting of the full physical path to the IDORequestService directory. Otherwise, the system by default uses .../wwwroot/IDORequestService. If you are using a custom path for that service, provide the name of the IDORequestService's application folder.

Event Service Key: enablePingEvent

Default value: false

InboundBus Service Key: enablePingInboundBus

Default value: false

ReplQListener Key: enablePingReplQListener

Default value: false

Replicator Key: enablePingReplicator

Default value: false

TaskMan Key: enablePingTaskMan

Default value: false

Log Monitor Key: enableLogMonitor

Default value: false

Aws Interface Key: enableAwsInterface

Default value: false

Azure Interface Key: enableAzureInterface

Default value: false

Note: A value of "true" for any service enables health checks for that service. A value of "false" disables the health checks.
Examples:
  • This example configures a custom path for the IDORequestService and enables the Event Service ping: 
    inforwebcl.exe servicePing -path:C:\Infor\WebApps\IDORequestService -enablePingEvent:true
  • This example enables health checks for the Replicator Service: 
    inforwebcl.exe servicePing -enablePingReplication:true
  • This example disables health checks for the Log Monitor Service: 
    inforwebcl.exe servicePing -enablePingReplication:false
  • This example enables multiple health checks: 
    inforwebcl.exe servincePing -enablePingEvent:true -enablePingTaskMan:true

InforServiceCL.exe replication (and ReplQListener)

Use this command to configure the Infor Framework Replication and ReplQListener services. These services are used to replicate data between SQL Server databases.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-server Use this option to specify the name of the server to configure for use with replication monitoring and tasks.
-repuser Use this option to specify the user ID (username) that is to be used by the Replication service to log on to the configuration server to perform replication monitoring and tasks.

By default, this is LocalSystem.

-reppassword Use this option to specify the password that is to be used by the Replication service to log on to the configuration server to perform replication monitoring and tasks.
-listeneruser Use this option to specify the user ID (username) that is to be used by the ReplQListener service to log on to the configuration server to perform replication monitoring and tasks.

By default, this is LocalSystem.

-listenerpassword Use this option to specify the password that is to be used by the ReplQListener service to log on to the configuration server to perform replication monitoring and tasks.
[-log] Use this option to specify the complete path to the log file.
Example:

inforservicecl.exe replication -server:win2012 -repuser:win2012\administrator -reppassword:test123 -listeneruser:win2012\administrator -listenerpassword:test123

InforServiceCL.exe setserviceaccount (Set service account)

Use this command to configure the service account for an Infor Framework Windows service.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-service Use this option to specify the Infor Framework Windows service you are setting credentials for.

These are the Infor Framework services you can specify:

  • IDORuntimeService
  • EventService
  • InboundBus
  • LogMonitorService
  • Replicator
  • ReplQListener
  • TaskMan
Note: If the TaskMan command is to be used, this must be set to TaskMan.
-LogonAcct Use this option to specify the security account ID under which the service is to be run.

This can include things like Domain\User, LocalSystem, or NetworkService.

[-LogonPwd] Use this option to specify the password for the security account under which the service is to be run.
[-Server] Use this option to specify the name of the server on which the service is to be configured.
Note: If this is not specified, the system LocalSystem is used.
[-SkipValidation]:True/False When set to True, this option indicates that security account and password validation can be skipped.

By default, this is set to False.

[-taskman] Use this option to indicate that an extra TaskMan-specific share is to be made.
[-timeout] Use this option to specify the amount of time, in milliseconds, for the system to wait before setting new credentials to start or stop a service.

The current default value for this option is 180000 (3 minutes).

Example:

inforservicecl.exe setserviceaccount -service:TaskMan -logonacct:networkservice -taskman

inforservicecl.exe setserviceaccount -service:Replicator -logonacct:win2012\administrator -logonpwd:test123

inforservicecl.exe setserviceaccount -service:AWSInterfaceService -logonacct:.\administrator -logonpwd:test123

InforServiceCL.exe reportservices (Report services)

Use this command to configure report services and deploy reports to the report server.

Note: This command applies to and is used only for SSRS reports, which are now deprecated in Mongoose-based applications.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-URL Use this option to specify the complete URL to the SSRS report server; for example: https://win2019r2/reportServer
[-configurevs] Use this option to configure Visual Studio for SSRS reporting.
[-folder] Use this option to specify the name of the parent reports folder on the SSRS report server; for example: MongooseReports
Note: If no value is specified, a ProductNameReports string is generated.
[-dir] Use this option to specify the complete path to the SSRS reports directory.
Note: If no value is specified, the system uses the Report\Reports folder under the product installation directory.
[-reportsonly] Use this option to import SSRS reports or RDLs only. You cannot use this for a IDO-based reporting setup.
Examples:

inforservicecl.exe reportservices -url:http://report.server.com/ReportServer -folder:SyteLineReport -dir:"C:\Program Files (x86)\Infor\SyteLine\Reports\"

inforservicecl.exe reportservices -url:http://win2012r2/ReportServer -reportsonly

inforservicecl.exe reportservices -url:http://win2012r2/ReportServer -configurevs

InforServiceCL.exe setidoruntimesettings (Set IDO Runtime settings)

Use this command to configure IDO Runtime settings.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-retainsessionsonstop:True/False When set to True, this option activates the 'Cloud' setting in the IDO Runtime service to retain sessions on when the service is stopped.
-name Use this option to set or change name/value pairs of settings in the config file for the IDO Runtime service; for example: MaxPooledServiceSessions:20

These are the settings in the config file for the IDO Runtime service that can be changed using this option:

  • EnableHttp, HttpPort
  • HttpListenerThreads
  • SslPort
  • Cloud
  • CryptLogonKey
  • SafeEnvVars
  • DisableLicenseMonitor
  • MaxPooledServiceSessions
  • MaxPooledWebServiceSessions
  • PooledSessionTimeoutSeconds
  • DataCatalogOAuthConsumerKey
  • DataCatalogOAthConsumerSecret
  • FullTrustLibary
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.

This option can be used if no GlobalSettings.xml file is used.

Examples:

inforservicecl.exe setidoruntimesettings -retainsessionsonstop:true

inforservicecl.exe setidoruntimesettings -MaxPooledServiceSessions:20 -EnableHttp:True

InforServiceCL.exe settaskmansettings (Set TaskMan settings)

Use this command to configure TaskMan service settings.

These are the available command options, formatted (and some with examples):

Command option: Description/Examples:
-name Use this option to set or change name/value pairs of settings in the config file for the TaskMan service; for example: -HealthDeltaSeconds:300

These are the settings in the config file for the TaskMan service that can be changed using this option:

  • HealthDeltaSeconds
  • FailConfigRetryMinutes
  • PollSpecificConfigVersion
  • RemotingRetryLimit
  • TaskTypeCounterMax
  • NotificationEmailAddress
  • ReportExecutionAttempts
  • ServiceDependencyList
  • MaxCpuThreshold
  • MaxLocalTasks
  • RetryConfigMinInterval
  • PreloadMonotoredConfig
  • OrphanCheckerMinutes
[-product] Use this option to specify the name of the Mongoose-based application that corresponds to the registry key; for example, Mongoose or SL.

This option can be used if no GlobalSettings.xml file is used.

Example:

inforservicecl.exe settaskmansettings -HealthDeltaSeconds:400 -RemotingRetryLimit:5

InforServiceCL.exe taskman

This command runs the setserviceaccount command, but sets the name of the service automatically to TaskMan. For additional options of the setserviceaccount command, see InforServiceCL.exe setserviceaccount (Set service account).

Related topics