Table of Contents

Search

  1. Preface
  2. Product Overview
  3. Security
  4. Applications
  5. Partner and Account Information
  6. Events
  7. Event Archiving
  8. User Policies
  9. Schedules
  10. B2B Data Exchange Administrative Tasks
  11. On-boarding Checklist Template
  12. System Properties
  13. Repository Management
  14. Document Management
  15. B2B Data Exchange Utilities
  16. DX Toggle Server REST API
  17. Dashboard and Reports Management

Administrator Guide

Administrator Guide

Enable and Disable Utility Command Syntax

Enable and Disable Utility Command Syntax

Use the enable and disable objects utility command syntax to enable or disable endpoints, profiles, and schedules, in the
B2B Data Exchange
repository. You do not need a specification file to enable or disable all objects.
You can find the batch scripts in the following directory:
<
DX
InstallationDir>\dx-tools\
The enable and disable utility uses the following syntax:
enabledisableobjects <-c, --command <command> <-t, --type <type> <-f, --file <ListObjectFile> <-u, --user <userID> <-U, <Environment variable> <-p, --password <user password> <-P, <Environment variable> <--server, --server <"hostname:port">
The following is an example of a sample batch script to enable the endpoints:
enabledisableobjects.bat -u <username> -p <password> -c enable -t endpoints -f /data/endpoints.xml
The following list describes parameters and arguments for the enable and disable utility commands.
-c or --command
Argument: command
Required. The command to run. Specify one of the following commands:
  • enable. Enables the specified object from the object list file in the
    B2B Data Exchange
    repository.
  • disable. Disables the specified objects from the object list file in the
    B2B Data Exchange
    repository.
-t or --type
Argument: type
Required. The object type to enable or disable. Specify one of the following commands:
  • endpoints. Enables or disables the endpoint list..
  • profiles. Enables or disables the profile list.
  • schedules. Enables or disables the schedule list.
-f or --file
Argument: ListObjectFile
Required. The file path where the list of objects are saved.
-u or --user
Argument: UserID
Optional. User ID of an Operation Console user account with the Manage Data privileges to perform the enable or disable command. The user account must have the Edit Data privilege to run this command. If you use Informatica platform authentication, the user ID must specify the Informatica security domain, separated by the @ symbol.
For example:
Administrator@SecurityDomain
You must specify at least one of the user name options, -u or -U, to determine the UserID required to execute this command.
-U
Argument: Environment variable
Optional. Environment variable that contains the UserID value.
UserID of an Operation Console user account with Manage Data privileges to perform the enable or disable command. The user account must have the Edit Data privilege to run this command. If you use Informatica platform authentication, the user ID must specify the Informatica security domain, separated by the @ symbol.
For example:
Administrator@SecurityDomain
You must specify at least one of the user name options, -u or -U to determine the UserID required to execute this command.
-p or --password
Argument: password
Optional. Password of the Operation Console user that executes the enable or disable command. This option contains the clear text password.
You must specify at least one of the password options, -p or -P to determine the UserID required to execute this command.
-P
Argument: Environment variable
Optional. Environment variable that contains the password value.
Password for the Operation Console user that executes the listObjects command. The password must be encrypted.
You must specify at least one of the password options, -p or -P to determine the user's password required to execute this command.
--server
Argument: "hostname:port"
Optional. Environment variable that contains the password value.
Optional. Host name and port number of the B2B Data Exchange server. If you do not enter an argument, the utility connects to the localhost server with the default port 18095. The argument must be enclosed in quotation marks.
For example:
enabledisableobjects.bat --server “localhost:18095”
Similarly, the following is an example of a sample batch script to enable profiles and schedules:
enabledisableobjects.bat -u <username> -p <password> -c enable -t profiles -f /data/profiles.xml
enabledisableobjects.bat -u <username> -p <password> -c enable -t schedules -f /data/schedules.xml
You can use the following XML sample files to enable profiles, schedules, and endpoints:
profiles.xml
You can use the following XML sample file to enable profiles:
<profiles> <profile> <name>Profile1</name> <status>disabled</status> <account>Account1</account> <partner>DefaultPartner</partner> </profile> <profile> <name>Profile2</name> <status>disabled</status> <account>Account1</account> <partner>DefaultPartner</partner> </profile> </profiles>
schedules.xml
You can use the following XML sample file to enable schedules:
<schedules> <schedule> <name>RunEveryOneMin</name> <cronExpression>0 0/1 * * * ?</cronExpression> <status>enabled</status> </schedule> <schedule> <name>scheduleForTesting2</name> <cronExpression>0 0/5 * * * ?</cronExpression> <status>enabled</status> </schedule> <schedule> <name>scheduleForTesting3</name> <cronExpression>0 0/10 * * * ?</cronExpression> <status>enabled</status> </schedule> </schedules>
Where 0 0/1 * * * ?, 0 0/5 * * * ?, and 0 0/10 * * * ? refers to the schedule running every minute, every 5 minutes, and every 10 minutes respectively.
endpoints.xml
You can use the following XML sample file to enable endpoints:
<endpoints> <endpoint> <name>TestHostedReceiveEP</name> <status>enabled</status> <account>Account_HostedEP</account> <partner>DefaultPartner</partner> <type>InfaMftEndpoint</type> <direction>Receive</direction> </endpoint> <endpoint> <name>TestHostedSendEP</name> <status>enabled</status> <account>Account_HostedEP</account> <partner>DefaultPartner</partner> <type>InfaMftEndpoint</type> <direction>Send</direction> </endpoint> <endpoint> <name>TestRemoteReceiveEP</name> <status>enabled</status> <account>AccountWithDefaultEP</account> <partner>DefaultPartner</partner> <type>InfaMftEndpoint</type> <direction>Receive</direction> </endpoint> <endpoint> <name>TestRemoteSendEP</name> <status>enabled</status> <account>AccountWithDefaultEP</account> <partner>DefaultPartner</partner> <type>InfaMftEndpoint</type> <direction>Send</direction> </endpoint> </endpoints>
For more information about listObjects batch script, see List Objects Batch Script.

0 COMMENTS

We’d like to hear from you!