Tools. BCSCmd.EXE command line tool

---

Bopup Communication Server comes with BCSCmd.exe command line utility which allows to send News messages, deliver instant messages to users and messaging groups, create SQL database backups, and also import/update users within Active Directory from a command line interface. You can use this tool in external and third-party applications, scripts and batch files.

BCSCmd.exe file is installed within Bopup Communication Server and placed into it's program folder. In order to send messages you should specify command line parameters and arguments including name of user accounts, messaging groups or/and News messages and a text of message to send. To display supported command line arguments just launch the BCSCmd.exe file with /? or /h arguments or simply with no parameters.

Use the following switches to run the program from a command line interface: bcscmd.exe [OPTIONS] /N <news>         - Name of existing News message to send. /G <group>        - Name of existing user group to send message to. /U <user>         - Name of existing user account to send message to. /M <"message">    - Text of message to send (for /G, /U, /A switches). /A                - Send message to all user accounts on the server. /OFFLINE          - Save the message as offline for delayed delivery                     if some from recipients are not available (for /G, /U                     and /A switches). /URGENT           - Deliver message with urgent priority (for /G, /U and                     /A switches). /DB <"file_path"> - Create SQL database backup file in specified location. /PWD <password>   - Password to authenticate with remote IM server. Skip                     it when connect to a local IM server. /LDAP [update|sync|syncall] [bygroups] [createunits] [creategroups] <names>                   - Import/update user accounts within information from                     Active Directory catalog. Bopup Communication Server version x.x.xx.xxxx command line utility. (C) 2000– B Labs. All rights reserved.

Please remember the following rules on using the tool from a command line interface:

• If the name of News message or group name contains spaces then use quotation marks;
  
  
• /M, /URGENT and /OFFLINE switches are valid only if you send messages to users and groups. They have no effect when you send News messages or create database backups;
  
  
• A path specified on using /DB switch can be a full path to directory or file. In case if a directory is entered the utility creates backup with filename in the following format bcs-YYYYMMDD-TIME.backup that contains current year, month, day, hours and minutes. For example, bcs-20231105-1924.backup.
  
  
• /LDAP update switch updates only existing user accounts on the IM server, /LDAP sync only adds new accounts found in the Active Directory and /LDAP syncall adds new accounts and disables all existing users on the IM server that were not found in the catalog.
  
  
  • Use bygroups switch in order to search and import accounts using LDAP Groups criteria. If it is not set then default OU criteria is used to search for users.
  • createunits and creategroups switches allow to create Organizational Units tree and Messaging Groups similar to OUs and Groups in the catalog which imported user accounts are part of. These keys are optional.
  • names parameter is a list of OU/group names separated with commas to limit a search range. This parameter is optional, and if it is missing then the search occurs over whole domain objects.
  
  
• If connection to the Active Directory catalog must be established using non-current user account and/or using only particular OU then credentials entered in Active Directory (LDAP) integration dialog are used (even when that function is not used).

Examples:

This example shows sending News message with the "News1" name from the communication server:

bcscmd.exe /N News1

This example shows sending an instant message to multiple users with specifying text of the message, offline delivery and urgent options:

bcscmd.exe /U administrator /U guest /U billy /M "This instant message sent from a command line" /URGENT /OFFLINE

This example shows sending an instant message to a user, messaging group and initiating News message:

bcscmd.exe /U administrator /G Group1 /M "This is message for users and groups" /N News2

This example shows sending an instant message all users that are currently connected to the server:

bcscmd.exe /A /M "This is message to all online users"

Current example creates SQL database backup file in specified directory:

bcscmd.exe /DB "C:\Temp"

This switch updates existing accounts by Groups criteria and assigns/removes them from associated LDAP groups (if found) on the IM server:

bcscmd.exe /LDAP update bygroups

This switch updates existing accounts by Units criteria, moves them into a new associated OUs (if found) and assigns/removes them from associated LDAP groups (if found) on the IM server:

bcscmd.exe /LDAP update

This execution searches for users by Units criteria, adds new user accounts and disables existings on the IM server if they were not found in the LDAP by connecting and using specified password:

bcscmd.exe /LDAP syncall /PWD SoMEsTroNgPaSswoRD!

This execution searches for users by Group criteria, adds only new user accounts, creates new Organizational Units on the server similar to LDAP groups and limits the search only for few groups in the catalog:

bcscmd.exe /LDAP sync bygroups createunits group-first,admins,group-last

Backup functionality is supported only if Microsoft SQL Server family is used as a host database server.