Module Values.TransformerSummarySource

Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Sourcetype nonrec t = {
  1. transformerId : TransformerId.t option;
    (*

    Returns the system-assigned unique identifier for the transformer.

    *)
  2. name : TransformerName.t option;
    (*

    Returns the descriptive name for the transformer.

    *)
  3. status : TransformerStatus.t option;
    (*

    Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

    *)
  4. createdAt : CreatedDate.t option;
    (*

    Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.

    *)
  5. modifiedAt : ModifiedDate.t option;
    (*

    Returns a timestamp representing the date and time for the most recent change for the transformer object.

    *)
  6. fileFormat : FileFormat.t option;
    (*

    Returns that the currently supported file formats for EDI transformations are JSON and XML.

    *)
  7. mappingTemplate : MappingTemplate.t option;
    (*

    Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

    *)
  8. ediType : EdiType.t option;
    (*

    Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

    *)
  9. sampleDocument : FileLocation.t option;
    (*

    Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

    *)
  10. inputConversion : InputConversion.t option;
    (*

    Returns a structure that contains the format options for the transformation.

    *)
  11. mapping : Mapping.t option;
    (*

    Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

    *)
  12. outputConversion : OutputConversion.t option;
    (*

    Returns the OutputConversion object, which contains the format options for the outbound transformation.

    *)
  13. sampleDocuments : SampleDocuments.t option;
    (*

    Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

    *)
}
Sourceval make : ?transformerId:??? -> ?name:??? -> ?status:??? -> ?createdAt:??? -> ?modifiedAt:??? -> ?fileFormat:??? -> ?mappingTemplate:??? -> ?ediType:??? -> ?sampleDocument:??? -> ?inputConversion:??? -> ?mapping:??? -> ?outputConversion:??? -> ?sampleDocuments:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of TransformerId.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of S3Key.t ]) list ] list | `String of MappingTemplate.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `Integer of X12ElementLengthValidationRuleMaxLengthInteger.t | `List of [> `String of String_.t ] list | `String of ElementId.t ]) list ]) list ] list ]) list ]) list ]) list ]) list | `Timestamp of CreatedDate.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t