Skip to content

CONFIG VIEW UI

The Config View is a screen used for creating, modifying, and deleting Batch. It allows you to check Batch information that has not yet been applied to actual Batch operation.
During Batch of Config View, Batch with changes must go through the Check-In and Deploy stages to be reflected in actual Batch operation.

1. Batch List

Alt text

No.NameExplanation
1NameThe user-defined identifier for the Batch
2CRONThe CRON expression applied to Batch scheduling
3CRON DescriptionAn explanation of the CRON expression entered by the user.
4DescriptionA description of the Batch entered by the user.
5Scheduling Active StatusA column indicating whether scheduling is active or not
6Allow Overlap ExecuteA column indicating whether overlapping executions are allowed.
7Last ModifierThe last user who modified the selected Batch
8Activate ViewSwitches the view mode to Activate view
9Deploy HistoryOpens the Batch Service Deploy history popup
10Manual ExecuteA feature that is not available in the Config View.
11NewOpens a popup for creating a new Batch.
12DeleteDeletes the selected Batch

1.1 Batch Popup

Popup window for creating a Batch.

Alt text

No.NameExplanation
1NameA field where the name of the batch to be created is entered.
2DescriptionA field where the explanation of the batch to be created is entered.
3Scheduling Active StatusA field indicating whether scheduling for the new batch is active. This can be modified after creation.
4CRONA field to input a CRON expression to define the time and schedule for executing a batch.
After selecting "Yes" for the scheduling active status (No. 3), this field becomes required.
The Batch Service of Cals uses AWS CRON expressions. Refer to the AWS CRON documentation for guidance.
※ CRON expressions must be based on the UTC time system.
5CRON DescriptionA field to input an explanation for the created CRON expression.
6Allow Overlap ExecuteA field specifying whether overlapping executions are permitted. If set to “No”, new executions will be rejected if one is already running.
7SaveSaves the entered content.
8CancelCancels the entered content and closes the popup window.

2. Step list

This is a list that displays the steps under the selected specific Batch.
You can add, modify and delete the steps under the Batch.

Alt text

No.NameExplanation
1NameDisplays the user-defined identifier for the Step.
2DescriptionDisplays the user-defined description for the Step.
3TypeDisplays the major category of the Step.
- Task: Performs a specific task in the selected Step.
- Flow: Controls the execution flow in the Step.
4Sub TypeDisplays the detailed type based on item 3 of the Step.
Task
- Long-Term Service: Calls a Long-Term Service created in Cals-extension.
- Lambda: Calls an Application Lambda created in Cals-extension.
- Procedure: Calls and execute a Stored Procedure saved in the DB.
Flow
- Choice: Provides branching for the next Step Execution based on the output value of the current Step.
- Parallel: Executes multiple Steps simultaneously.
- Wait: Waits for a specified time (in seconds).
5Parent StepDisplays the parent Step name if the Step has a parent.
6Target TaskDisplays the target task to be executed when the Step is of type Task.
7Next StepDisplays the next Step to be executed after the current one.
8Template ImportImports from a Step Template into the current Batch as a sub-Step.
Imports either a single Step Template or all Templates under a Template Group.
9Copy to TemplateCopies the selected Step as a Step Template.
10Copy all to TemplateClones the selected Step into a Step Template.
11NewOpens a popup for creating a new Step.
12DeleteDeletes the selected Step.
2.1 Batch Step Popup (default)

This the initial screen of the popup window for creating a new Step.

Alt text

No.NameExplanation
1NameEnter the user-defined identifier for the Step.
2DescriptionEnter the user-defined description for the Step.
3TypeSelect the major category type of the Step.
- Task: Perform a specific task in the selected Step.
- Flow: Control the execution flow.
4Sub TypeSelect the detailed type of the Step based on the Type field.
Task
- Long-Term Service: Call a Long-Term Service created in Cals-extension.
- Lambda: Call an Application Lambda created in Cals-extension.
- Procedure: Call and execute a Stored Procedure saved in the DB.
Flow
- Choice: Provide branching for the next Step execution based on the output value of the current Step.
- Parallel: Execute multiple Steps simultaneously.
- Wait: Wait for a specified time (in seconds).
5Start Position FlagIndicate whether the target Step is the starting point in the Batch or under a specific Step (Parallel) type.
6Parent StepSpecify the parent Step if the selected Step is used as a child Step, selected through a popup.
7Next StepSpecify the next Step to execute after the current Step, selected through a popup.
8SaveSave the entered content.
9CancelDiscard the entered content and close the popup window.
2.1.1 Parent Step Lookup

This the popup window displayed by the Parent Step Lookup field in the Step popup. It displays a list of Steps (Parallel) that can be designated as the parent Step within the same Batch. You can double-click the desired Step row to select it. Alt text

No.NameExplanation
1NameDisplays the user-defined identifier for the Step.
2DescriptionDisplays the user-defined explanation for the Step.
3TypeDisplays the major classification type of the Step.
4SelectAssigns the selected Step as the parent Step. Double-click on the target row to execute the same function.
5ClearResets the Parent Step field value in the current popup.
6CancelCancels the selection and close the popup while keeping the existing value.
2.1.2 Next Step Lookup

This the popup windows displays according to NextStep Lookup in Step popup. Only Steps that are the same as the Parent Step under the same Batch will be displayed.

Alt text

No.NameExplanation
1NameDisplays the user-defined identifier for the Step.
2DescriptionDisplays the user-defined description for the Step.
3TypeDisplays the major classification type of the Step.
4SelectDesignates the selected Step as the Next Step. Double-click the target row to perform the same function.
5ClearResets the Next Step field value in the current popup.
6CancelCancels the selection and close the popup while keeping the existing value.
2.2 Batch Step Popup (LTS)

When the Type is set to Task and the Sub Type is set to Long-Term Service in the Step popup. In the popup window, a Lookup field labeled Target Long-Term Service is displayed, similar to item 1. This lookup allows you to select Long-Term Service to be executed in the selected Step through the Long-Term Service lookup.

Alt text

2.2.1 Long-Term Service Lookup

This is the popup screen for selecting the Long-Term Service to be executed in a Step of the Long-Term Service type.

Alt text

No.NameExplanation
1DomainDisplays the domain where the Long-Term Service will be executed.
2CategoryDisplays the code value of the account that created and deployed the Long-Term Service.
3Sub CategoryDisplays the name of the Long-Term Service.
4SelectSpecifies the selected Long-Term Service as a target to execute. Double-click the target row to perform the same function.
5ClearResets the Target Long-Term Service in the current popup.
6CancelCancels the selection and close the popup while keeping the existing value.

2.3 Batch Step Popup (Lambda)

When the Type is set to Task and the Sub Type is set to Lambda in the Step popup, a Lookup field with the label Target Lambda Service will be displayed as item 1. This Lookup allows you to select the Application Lambda Service to be executed in the Step through the Lambda Service List popup.

Alt text

2.3.1 Lambda Service List

The popup screen to Lambda to select lambda to be executed in type of type of step.

Alt text

No.NameExplanation
1DomainDisplays the domain where the Lambda will be executed.
2CategoryDisplays the code value of the account that created and deployed the Lambda.
3Sub CategoryDisplays the name of the Lambda.
4SelectSpecifys the selected Lambda as the target to execute. Double-click the target row to perform the same function.
5ClearResets the Target Lambda Service field value in the current popup.
6CancelCancels the selection and close the popup while keeping the existing value.

2.4 Batch Step Popup (Procedure)

When the Type is set to Task and the Sub Type is set to Procedure in the Step popup, additional fields will be displayed to specify the target `Procedure and the database to be executed.

Alt text

No.NameExplanation
1Procedure NameInput the name of the Procedure to be executed.
2Data SourceSpecify the Data Source existing in the Procedure to be executed.

2.5 Batch Step Popup (Wait)

When the Type is set to Flow and the Sub Type is set to Wait in the Step popup, a field called Wait Second will be displayed, where the wait time (in seconds) for the Step can be specified.

Alt text

3. Parameter list

The list displays Parameter list under the selected specific Step. You can add, modify, or delete parameters under the relevant Step. The Parameter of Step can be used when creating JSON structure parameters with low-code.

Alt text

No.NameExplanation
1NameRepresents the user-defined name of the parameter.
2DescriptionRepresents the user-defined explanation of the parameter.
3TypeRepresents the major category of the parameter.
- Input: Type for cases where the selected parameter is an input parameter.
- Output: Type for cases where the selected parameter is an output parameter.
4Source TypeIndicates how the parameter value is obtained.
- Static: Value is fixed based on what the user entered.
- Refer: For "Input", value is obtained by referencing a path in the incoming parameter object.
- Return: For "Output", value is obtained by referencing a path in the returned parameter object.
5Data TypeIndicates the data type of the Parameter value. Refer to section 3.3.2 for a detailed explanation.
6KeyIdentifier used to obtain the parameter value during batch execution.
7ValueValue the parameter will have during batch execution, which varies based on the source type.
8SequenceDisplays the order of the parameter when used in specific cases.
9ParentDisplays the name of the parent parameter if there is one.
10Require FlagIndicates if the parameter is required when not a fixed parameter.
11Length LimitDisplays the maximum length of the parameter value if it is not fixed.
12Default ValueDisplays the default value to be applied to the parameter if it is not fixed.
13NewOpens a popup to create a new parameter.
14DeleteDeletes the selected parameter.

3.1 Parameter Popup (default)

This is the initial screen popup for creating a New Parameter popup.

Alt text

NumberNameExplanation
1NameInput the user name of the Parameter.
2DescriptionInput the user explanation of the Parameter.
3TypeInput the major category of the Parameter.
- Input: For cases where the selected parameter is an input parameter.
- Output: For cases where the selected parameter is an output parameter.
4Source TypeInput the type used to obtain the Parameter.
- Static: Value is fixed based on what the user input.
- Refer: Used for input parameters to reference a specific path in the passed parameter.
- Return: Used for output parameters to reference a specific path in the received parameter.
5Data TypeInput the data type of the Parameter value. Refer to Parameter Data Type for more details.
6KeyInput the identifier used to obtain the parameter value during the batch.
7Value AreaDisplay the field to input the path to obtain the Parameter value or the value itself. Adjusts based on Source Type.
8Require FlagSpecify whether the parameter is required when it is not a fixed parameter.
9Data Length LimitSpecify the maximum length of the transferred, passed, or received parameter if it is not fixed.
10Parent ParameterSearch and specify the Parent Parameter of the selected parameter in the Step Param List Popup.
11Default ValueInput the default value to be applied when the parameter is not fixed. It will be converted to match the Data Type during batch.
12SequenceInput the order value of the parameter used in a specific situation.
- When Parent Parameter is of Static, Array type, specify the index position.
- For Procedure Step input parameters, specify the order to call the Procedure.
13SaveSave the created content.
14CancelDiscard the created content and close the popup.
3.1.1 Step Param List (Parent)

It is a popup to search and select the parent parameter for a specific parameter. In this popup, only Static Object or Array parameters under the same step are displayed for selection

Alt text

No.NameExplanation
1NameIndicates the user-defined name of the parameter.
2KeyRepresents the identifier used to retrieve the parameter's value during batch execution.
3Refer KeyShows the path from which the parameter obtains its value.
4Data TypeDisplays the data type of the parameter.
5SelectAssigns the selected parameter as the parent parameter.
6ClearResets the Parent Parameter field that opened the popup.
7CancelCancels the selection and close the popup while retaining the existing value.

3.2 Parameter Popup ( Static )

It displays Static Value in Value field area when specifying Data Type of Parameter as Static. During Batch, the value inputted in the field is converted to match with Data Type and transferred.

Alt text

3.3 Parameter Popup (Input - Refer)

If the Type is set to Input and the Source Type is set to Refer, the Value field area displays a Refer Key field. This field allows users to input the path to a specific parameter from the Input Parameter object by using the Step's Output Parameter Lookup Popup to explore and select the desired parameter.

Alt text

3.3.1 Pre Step Param List

This popup screen allows you to browse the Output Parameters of the Steps under the same Batch. You can select a desired parameter to generate a Refer Key, which is the reference path used to retrieve the chosen parameter during the Batch execution.

Alt text

No.NameExplanation
1Step NameDisplays the name of the Step to which the parameter belongs.
2NameShows the user-defined name of the parameter.
3KeyRepresents the identifier used to retrieve the parameter value.
4Refer KeyIndicates the reference path to fetch the parameter's value.
5Data TypeDisplays the Data Type of the Parameter.
6SelectAssigns the chosen parameter as the parent parameter and generate the respective Refer Key. Double-clicking the desired row also performs this action.
7ClearResets the Parent Parameter field in the popup, removing the current selection.
8CancelCancels the selection process and close the popup, retaining the previously set value.

3.4 Parameter Popup (Output - Return)

When the Parameter has a Type of Output and a Source Type of Return, the Value field area displays the Return Key Path field. In this field, you should manually input the path to retrieve a specific value from the Parameter object returned by the Task.

Alt text

4. Parameter Data Type

  1. Data type of Parameter can be classified into 2 sets of data type. Common Data Type: These are data type categories that are generally applicable.
    a. String
    b. Number
    c. Boolean
    d. Date
    e. Object
    f. Array

  2. Procedure Input Data Type : These are data type of parameter that is applied to Input Parameter in the Step of Procedure type.
    a. String
    b. Integer
    c. Decimal
    d. UTCDateTime
    e. Date
    f. DateTime
    g. Binary

StringNumberBooleanNullDateObjectArray
StringOOOOOXX
NumberOOOXXXX
BooleanOOOXXXX
NullOXXOXXX
DateOXXXOXX
ObjectXXXXXOX
ArrayXXXXXXO
  • Common Data Type X Procedure Input Data Type
StringIntegerDecimalUTCDateTimeDateDateTimeBinary
StringOOOOOOO
NumberOOOOOOX
BooleanOOOXXXX
DateOOOOOOX
ObjectXXXXXXX
ArrayXXXXXXX