bizc v2.0.1

Bizagi Connector Utility (bizc)

This tool makes it easier and faster to create/modify/delete your Bizagi connector action's inputs and outputs. Simply specify your action's inputs and outputs from a YAML file. You can generate documentation for your connector as well!

Installation

npm i -g bizc

Usage

bizc ConnectorToModify.bizc -d -b UpdatedConnector.bizc -y ConnectorInputsOutputs.yaml

Options

• -y or --yaml=PATH: This option is used to specify the path where the YAML file will be loaded from. If this option is not specified, the tool will look for a file called doc.yml in the working directory.

  Take a look at a sample YAML file.

• -b or --bizc=PATH: This option is used to specify the path where the updated connector file will be stored. If this option is not specified, the connector specified as input will be overwritten.

• -d: This option is used to generate documentation from the description attribute of each input/output in the YAML file. This documentation will be generated in a README.md file.

YAML file structure

# ConnectorInputsOutputs.yaml
name: my-connector    # name of connector. This value is only for documentation
version: 1.0.0    # current version of the connector. This value is only for documentation
description: my first connector    # describes the purpose of the connector. This value is only for documentation
actions:
  my-action:    # Action name
    description: my first action    # describes the purpose of this action
    input:    # Inputs of this action (input is a single object). For an array of objects, use "inputs" instead of "input".
      - name: first_name    # name of the input
        description: This is the first name of a person    # Description of the first_name input. Used for documentation purposes when the -d option is specified.
        type: string    # type of first_name
      - name: last_name    # another input named "last_name"
        description: This is the last name of a person
        type: string    # type of last_name
        required: true   # This input is required. Currently used for documentation purposes.
    outputs:    # Outputs of this action (outputs is an array of objects). For a single object, use "output" instead of "outputs".
      - name: id
        description: ID of the person
        type: string
      - name: person_info
        description: Information about a person
        type: object
        props:    # If type=object, then use props to specify the object's properties
          - name: first_name
            description: First name of a person    # Used for documentation when the -d option is specified.
            type: string
          - name: last_name
            description: Last name of a person
            type: string
          - name: age
            description: Age of a person
            type: integer
      - name: children
        description: Name and age of this person's children
        arrayOf: object    # If you want to specify an array, do not use 'type'. Instead use arrayOf. You can also specify arrays of basic types. For example, arrayOf: string.
        props:    # Since this is an array of objects, you specify the properties for each element of the array using props. Arrays of basic types (like strings, doubles, etc.) don't require the use of props.
          - name: name
            description: Name of this child
            type: string
          - name: age
            description: Age of this child
            type: integer

  other-action:
  # ....

• The YAML file must have a root actions object.

• Nested arrays and objects are supported.

• Supported types: boolean, byte, date, decimal, double, integer, object, string.

• If your action returns an array of Objects (ie. the outputs.output object of the connector should be an array), then specify the necessary properties under the outputs object in the YAML file. If your output is a single object, use the output object instead.

• Likewise, if your action takes an array of Objects as input (ie. the inputs.input object of the connector should be an array), then specify the necessary properties under the inputs object in the YAML file. If your input is a single object, use the input object instead.

Considerations

• You must first create your actions in the Bizagi Connector Editor. They should be named appropriately, but it is not necessary for them to be implemented.
• This tool will not erase any code that your actions do.

Notice

This package is not maintained or endorsed by Bizagi.