Page tree

MagicDraw 19.0 LTR SP3 Documentation


The available command arguments include:

  • -upload is the key argument to upload a generated report to a server.

The following code is the uploaded command syntax of the upload value.

-upload
"{scheme}://[{userInfo}@]{host}[:{port}][/{path}][?{query}][#{fragment}]"

where square brackets [...] are delineated as optional.

  • {scheme}
    The {scheme} defines the namespace, purpose, and the syntax of the remaining part of a URL. This field is mandatory. A scheme must be followed by “://”. The supported schemes are:
  • ftp
  • ftps
  • sftp
  • http
  • https


  • {userInfo}
    The {userInfo} defines the username and password for authentication. The syntax is displayed as follows.

    {username}[:{password}]

    This optional password must be predicated by “:”, and it can be an empty string. If the password is omitted, the command line will prompt for the password. 
    UserInfo must be followed by “@”, and this field is optional.

    Warning

    {username} and {password} should not contain special characters such as “:”, “/”, and “@” for they may cause an invalid result or error when the uploaded command is parsed.

  • {host}
    The {host} defines a host name or an IP address that gives the destination location of a URL. This field is mandatory.

  • {port}
    The {port} defines a port number where the server is listed. The port value has to be a value from 1 to 65535. It is necessary when the port number is different from the default port for well-known services. If the port is omitted, the default port will be used to connect to the server. The table below shows a port number for each scheme.

    The table below lists the Default Port Numbers for Schemes

Scheme Port Number 
ftp  21
ftps990 
sftp  22
http80
https443

 The port must be preceded by ":". This field is optional.

  • {path}
    The {path} defines a remote location where the report will be saved. Paths are Unix-style paths; therefore use “/” (forward-slash) as delimiters. This field is optional.

  • {query}
    The {query} defines a query string that contains data to be passed to software running on the server. It may contain name or value pairs separated by ampersands.

  • {fragment}
    The {fragment} defines a fragment identifier that, if present, specifies a part or a position within the overall resource or document.


Info

For this feature, the parser ignores query and fragment. Both fields are included in {path}.


The following are some examples of valid server addresses.

    • ftp://magicreport:1234@10.1.2.4:25/report

      Schemeftp
      User namemagicreport
      Password1234
      Host10.1.2.4
      Port25
      Pathreport
    • ftp://10.1.2.4:25/report

      Schemeftp
      Host10.1.2.4
      Port25
      Pathreport
    • ftp://10.1.2.4

      Schemeftp
      Host10.1.2.4
      Port21 (Default port for ftp)
    • ftp://magicreport@10.1.2.4:25/report

      Schemeftp
      User namemagicreport
      Host10.1.2.4
      Port25
      Pathreport

      Tip

      The command line prompts for password.

    • ftp://magicreport:@10.1.2.4:25/report

      Scheme ftp 
      User namemagicreport 
      Password 
      Host 10.1.2.4 
      Port 25 
      Path report 

      Tip

      The command line uses an empty password.

      The following are some examples of invalid server addresses.

      Invalid Server AddressCause
      10.1.2.4:25The scheme is required.
      Xx://10.1.2.4:25The scheme is invalid.
      ftp://magicreport@The host is required.
      ftp://@10.1.2.4:25The username is required.
  • No labels