Add-on Auto-Steps

 

A collection of implementation samples of the Service Task Definition file (Add-on XML) for adding Add-on automatic step icons.
In addition to the built-in modeling elements in the workflow platform, original modeling elements (add-on automatic steps) can be added.

The implementation samples are classified into the following two.

• API Access Automation (Data Processing Involving Communication with the Outside of Workflow Platform)
• Data Editing Automation (Data Processing Closed within Workflow Platform)

On the implementation sample individual page, you can also download the Service Task Definition file and import it into your workflow platform. However, there is no guarantee of operation, so please use it at your own risk. Also, if there will be changes in the specifications of Questetra or linked services in the future, you need to modify the code yourself.
If you need to guarantee the operation or cannot maintain the script (code) by yourself, please use only the built-in modeling elements to create the Workflow Apps.

Related Manual

• M415: Adding an Auto-Step to be Used for Business Process Definition
• M416: Create your own Auto-Step for Business Process Definitions

Addons except for "Service Task Definition"

• Options Definition is here
• Base PDF is here

Access to the APIs of various cloud services, and data processing that involves communication outside the workflow platform is automated on the server side.

Before using Add-on Automations, please consider using [Built-in Automations].

• Built-in Automations

If you want to link to a service or your own system for which a built-in automated process is not provided, or if you want to perform processing that cannot be achieved with the built-in automated process specifications, please consider developing and using an add-on automated process that suits your purpose. Please refer to the sample implementation of [Add-on Automation] processes that are linked to external services.

• Implementation samples of Add-on Automations

Data processing that is closed within the workflow infrastructure, such as generating random numbers, counting characters, converting TSV data to Excel files, etc., is automated on the server side.

Depending on the data processing, the following sample implementations of [Add-on Automations] are available.

	Generator *You can see the relevant auto-processing Tasks here Number, Generate Random Generates a random number. When a token reaches this automated step, a numerical value within the specified range is generated each time. The decimal part is rounded down toward 0 according to the workflow data definition String, Generate Password Generates a random string. When a token reaches this automated step, a string of the specified length is generated each time. Complex rules such as mixed symbols or non-use of specific characters (I and l) are also supported. “Add New User” etc Email-HTML String, Create SimpleNotice Assembles HTML text for email from workflow data. The html text will consist of blocks of abstract, image, main sentence, link button, and sub-sentence. If the setting is blank, the block will not be displayed Email-HTML String, Create ImageList Assembles HTML text for email that can list multiple images. Sets image URLs in the img tag and arranges them. It is used in cases where you want to share images published on a web server or when you want to strengthen the check system Email-HTML String, Create TsvTable Assembles HTML code for HTML-email that can confirm TSV string. Inserts TableRow (TR) and TableData (TD) depending on the number of items in the TSV string. It is used when you want to automatically notify the TSV data stored in the workflow by mail Email-HTML String, Create DataitemList Generates HTML code (for HTML mail) that lists stored data. Assembles the specified Data Items in the workflow in the specified order. You can share your data with any party by using the [Throwing Message Intermediate Event]
	Duplicate Files, Duplicate Duplicates File-type data. All files stored in Data Item A1 (Original Files) will be copied over to Data Item B1 (Clone Files). Also possible to change the file name or Content-Type. If the same Data Item is specified as A1 and B1, overwritten Files Duplicate From Multi Items Duplicates Files-type datas to Other Files-type data. All files stored in Files-type datas A is copied over Files-type data B Table, Duplicate Duplicates Table-type data. All cell value stored in Table-type data A is copied over Table-type data B. If the table column definitions are different, an error may occur
	Converter *You can see the relevant auto-processing Tasks here Converter: Datetimes in different time zones Converts the datetime in time zone A to the datetime in time zone B. Any time zone can be set for either datetimes. If nothing is set the Workflow Platform time zone will be applied. Converter: Timestamp-Number to Datetime Converts a timestamp number (UNIX time) to datetime data. That is, the number of seconds elapsed since UTC 1970-01-01 00:00:00 is assigned to the datetime type data according to the workflow platform time zone. (10-digit integer after 2002) Converter: Table to TSV-String Converts Table-type data to a TSV String. The string value of all cells in the Table-type Data Item is copied over TSV string B. Cells with no input are regarded as empty strings Converter: TSV-String to Table Converts a TSV String to Table-type data. The string values of all cells in the TSV string are copied over to Table-type data B. If there is an inconsistency in the Table column design, an error may occur Converter: CSV-String to TSV-String Converts a CSV string to a TSV string. The TSV is output as the simplest tab-delimited string. If the field contains line breaks or tabs, they will be replaced with spaces. If the double-quotes in the input CSV are not escaped there may be unintended consequences. Converter: Multiline-String to Singleline-CSV-String Converts a multiline string to a CSV string. Converts each row of a multiline string as the value of each cell in the CSV. If commas are included they will be deleted in advance. Lines with only line feed code are recognized as empty data Converter (File to Base64 String) Converts file type data to Base 64 encoded string type data. If there are multiple files in File-type data, or if the file size exceeds 10 MB the data will not be converted Converter: Email-String to Quser Converts an Email string to USER data. If the address is not registered as a user address, an error will occur (USER not updated). If multiple addresses are enumerated in a multiline or comma-delimited string, determined sequentially from the top Converter: JapanZipCsv to JapanZipXml Generates a postal code master. The zip data “KEN_ALL.CSV” (120k lines) of Japan Post is converted to “Japan-Zip.xml”. You can refer to postal code master in input form settings such as “Select (Search Select box)” Converter: ZENGIN to MizuhoCSV Generates a general transfer file for Mizuho Bank. The file of “ZENGIN format” defined by the Japanese Bankers Association is converted to the file for “Mizuho Business Web” service. Each line consists of “Customer Code 1” and “payment amount” Converter: JigyosyoZipCsv to JigyosyoZipXml Generates a postal code master. The business zip “JIGYOSYO.CSV” (20k lines) by Japan Post Co., Ltd. is converted to “Jigyosyo-Zip.xml”. If “Japan-Zip.xml” (120k lines) is specified, “Jigyosyo-Zip.xml” (140k lines) will be created TSV String, Switch Rows and Columns Switches the row and column indices of the rectangle TSV. The output matrix (Transposed Matrix) is obtained by changing cell(x,y) to (y,x). Used for data arrangement for frequency distribution tables and histograms TSV String, Convert date data to yyyy-MM format Converts the date data in the specified column to yyyy-MM or yyyy format and appends the value to the end of all lines String, Decode using Master Table Converts ID string to Label string with referring “Choice Master” shared within the workflow platform. If there is no matching ID, it is converted to an empty string UrlEncoded String, Decode UriComponent Decodes URL-encoded string that is an encoded component of a Uniform Resource Identifier. “5%25off%3F” will be decoded to “5%off?” and “%E3%81%82%20%E3%81%84” will be decoded to “あ い” Text Files, Convert Character Encoding Converts text files charset (Coded Character Set). For example, converts UTF-8 encoding to Shift_JIS or UTF-16. If multiple files are attached, all will be converted according to the same rules
	Filter TSV String, Convert Changes column order of TSV text. The new order is specified by enumerating the column IDs of the original TSV, like “0,1,3,0”. The new TSV text can also be stored in formats such as TSV file format and CSV file format TSV String, Sort by Numeric Sorts TSV text in the numerical order of the specified column. If each column values are “123 jpy”, “1,234 jpy”, and “12 jpy”, they are sorted in the order of “line including 12 jpy”, “line including 123 jpy”, “line including 1,234 jpy” TSV String, Sort by Text Sorts TSV lines in the order of the character code of the specified column. If the column value for each line is Jan Feb March, the text is sorted in the order of “line that contains Feb”, “line that contains Jan” and “line that contains March” TSV String, Filter by Text Filters TSV string with any search text. Only lines that contain the search text in the specified column are output. If you want an OR search with multiple texts, specify them as a comma-separated list such as “USA,U.S.,United States” TSV String, Filter Out by Text Filters out TSV lines by any search text (Exclude Filter). Only lines that DO NOT contain the search text in the specified column are output. If OR search with multiple texts, specify them as a comma-separated list such as “USA,U.S.,United States” TSV String, Filter by Numeric Filters TSV strings using a numeric range. Only the rows where the specified numeric column is included in the numeric range are output. If you want to OR multiple ranges, specify them in comma separated form like “-100<36.4,37.5<100” TSV String, Filter by Date Filters TSV strings using a date range. Only the rows where the specified date column is included in the date range are output. To OR multiple ranges, use a comma separated format like "2021-01-01&lt;2021-01-07,2021-01-21&lt;2021-01-27" TSV String, Filter by Datetime Filters TSV strings using a Datetime range. Only the rows where the specified Datetime column is included in the Datetime range are output. If you want to OR multiple ranges, use comma-separated values like "2021-01-01 00:00&lt;2021-01-07 23:59,2021-01-21 00:00&lt;2021-01-27 23:59" TSV String, Filter by Keywords Filters TSV text to column-matched lines only. The match condition can be either “equals”, “contains”, “begins with”, or “ends with”. A case-insensitive filter can also be specified. It is also possible to separately store the excluded rows (filtered rows) TSV String, Filter by RegExp Narrows down to just the column-matched lines from the TSV text. A regular expression (RegExp) can be specified as the match condition. Evaluates whether the column matches the regular expression. Also stores the filtered-out lines (removed lines) Multiline String, Filter by RegExp Narrows down to just the matched lines from the multiline text. A regular expression (RegExp) can be specified as the match condition. Each line is determined to match a regular expression. Also stores the filtered-out lines (removed lines)
	Add/Remove String, Batch Replace Fullwidth Numbers with Halfwidth Numbers Replaces all full-width numbers with half-width numbers. Numbers from “０” to “９” are to be replaced. Symbols and letters are NOT replaced. The replacement count is output to the log String, Batch Replace Halfwidth Numbers with Fullwidth Numbers Replaces all half-width numbers with full-width numbers. Numbers from “0” to “9” are to be replaced. Symbols and letters are NOT replaced. The replacement count is output to the log String, Batch Add Thousands Separators Detects numbers with more than three digits in the text and adds thousand separators to each number. A comma, dot, or space can be specified as the digit separator. Note that this replacement will also be applied to decimals, postal codes and years String: Replace All Replaces all the search strings by the replacement string. All matches are case sensitive. For example, it is possible to completely replace the string “XXXX-XX-XX” in the template text with “2020-05-11” Multiline String, Remove Duplicate Lines Extracts and deletes all duplicate rows. In forward order mode, the first row is retained; in reverse order mode, the last row is retained. Note that “ABC” and “Abc” are recognized as different columns. (case sensitive) TSV String; Add Static Value to All Lines Adds the new string cell to the end of all rows. If there are space characters or line feed characters at the beginning and end of the TSV, they will be deleted beforehand. If the number of tab separators does not match, an error will occur TSV String; Add Prefix to Column Concatenates all data in the specified column with the prefix string to generate a new TSV string. The concatenated strings are added at the end of the line. Removes whitespace from both ends of a string TSV String; Add Suffix to Column Concatenates all data in the specified column with the suffix string to generate a new TSV string. The concatenated strings are added at the end of the line. Available for name honorifics or currency units, etc. Removes whitespace from both ends of a string TSV String; Add N to Number Column Generates a new TSV string by adding N to each number in the number column. Calculation results are added at the end of the line. This can be used for creating discounted price lists, etc. Removes whitespace from both ends of a string TSV String; Multiply N by Number Column Generates a new TSV string by multiplying N by each number in the number column. Calculation results are rounded off and added at the end of the line. This can be used for tax calculations, etc. Removes whitespace from both ends of a TSV string TSV String, Calc Changes in Two Numeric Columns Calculates the difference and rate of change for two numeric columns in a TSV. Adds the calculated value to the rightmost column. It realizes month-on-month and year-on-year automation TSV String, Verify Rectangle Verifies that the cells are in a matrix format. If the number of cell values are different for each row, tabs will be added. It is also possible to get the number of rows and columns after formatting. No trailing newline will be added to the verified TSV TSV String, Remove Column-Duplicate Lines Extracts and deletes rows with duplicate column elements. In forward mode it keeps the first row, in reverse mode it keeps the last row. Note that “ABC” and “Abc” are recognized as different columns. (case sensitive)
	Extract String, Get Number of Words Gets the number of words in the text. Words separated by spaces (including tabs, double-byte spaces, and line breaks) are counted. The number of words counted, including commas and periods as delimiters, can also be obtained String, Get Number of Characters Gets the number of characters in the text. Consecutive blanks (including tabs and double-byte spaces) are counted as one character. The number of characters that do not count linefeed codes and blanks can also be obtained Multiline String: Get Number of Lines Gets the number of lines of text. The number of lines that do not count the trailing newline codes can also be stored String, Extract Values using Line-Begin Matching Matches the string at the beginning of the line and extracts the following string String, Get MD5-Hash Calculates the MD5 digest. The MD5 hash algorithm is applied against the source data to generate a unique 128-bit hash value (x32 characters in hexadecimal notation). This checksum algorithm is a commonly used function for validating data integrity String List, Check for Existence of Search String Checks for the existence of string elements in the list that match the search string TSV String, Create Cross Table for Numeric Column Aggregates the values in a numeric column with 2 aggregation-key columns (pivot table). Sum, Percentage, Count and Average are tabulated as a cross table TSV. E.g. “Sales for each combination of Client-Y and Store-X” is aggregated from “Sales log TSV” TSV String, Create Summary Table for Numeric Column Aggregates the values in a numeric column by aggregation-keys. Sum, Percentage, Count and Average are tabulated as a summary table TSV. For example, “Sales for each client” is aggregated from “Sales log TSV”. Grand Total Tabulation TSV String, Create Summary Table of Count Aggregates the count of data by aggregation-keys. Count and Percentage are tabulated as a summary table TSV. Eg, Survey Results TSV is automatically generated from Survey Records TSV. Frequency distribution TSV String, Create Cross Table of Count Aggregates the count of data by 2 aggregation-key columns: Pivot table. Count and Percentage are tabulated as a cross table TSV. Eg, Survey Results TSV is automatically generated from Survey Records TSV. 2D frequency distribution TSV String, Sum Numeric Column Sums the values in the numeric column of a TSV. If the numeric field contains commas, they will be removed and then parsed. If you need to add up the values for each key, use Summary tabulation or Cross tabulation TSV String: Extract Cells Extracts the values of specified cells in A1 notation. The extracted string can be stored not only in the STRING type data but also in the NUMERIC type, DATE type, DATETIME type, SELECT type, USER type, and ORG type data if the format allows JSON String, Extract Value using JSON-Path Extracts value from JSON using JSON Path. It is used when extracting necessary data from JSON received by the Incoming Webhook function. It is also possible to set the path to get multiple values Extract Value from Query String Extracts the value of the specified parameter from the serialized query-string (e.g. “a=123&b=456”) and stores it as workflow data URL String, Extract Parts Parses the URL/URI string to extract each components such as Protocol (Scheme), Host, Hostname, Path, Query, Fragment, etc. For components that require URL decoding, decodeURIComponent processing is required separately in the downstream process MoneyForward Journal, Create Creates the Journal-Slips (TSV or Excel) for MoneyForward Cloud Accounting. It supports not only batch sales invoices but also invoices that are prorated for each month Fiscal Month-Day String, Create Creates a date ID for sorting within a fiscal year. The first day of the first month of the fiscal year will be "101". The 25th day of the last month is "1225". If the fiscal year starts in Jan, the string will be the same as the calendar format "Mdd" Singleline TSV String, Extract Cell Extracts the cell value of the specified ID. The ID starts from zero. The extracted cell string can be stored not only in the STRING type data but also in the NUMERIC type, DATE type, DATETIME type, SELECT type, USER type, and ORG type data Singleline String, Set One Line from Multiline using Round-Robin Extracts one line from the multi-line string in order using a round robin method and sets that line in single-line string data. For example, it can be used to test sales copy or to set the response text for lottery results. It is also possible to exclude specific rows from the selection candidates Singleline String, Set One Line from Multiline Randomly Extracts one line randomly from the multi-line string and sets that line in singleline string data. For example, it can be used to test sales copy or to set the response text for lottery results. It is also possible to exclude specific rows from the selection candidates Singleline String, Set Nth Line of Multiline Extracts one line of a multi-line string and sets that line in single-line String-type Data Item. The Line ID mut be an integer starting with zero. If the Line ID is not specified, or if a number outside the range is specified, the last line will be extracted Multiline String, Dequeue First Removes the first line from the multiline string. One line less than the original string. By placing in a loop flow or in a recursive workflow, data list can be processed sequentially Date, Get Weekend Sunday Gets weekend Sundays of any date. If Sunday is specified, that day itself will be returned. If you want to get “Monday of the next week” or “Tuesday of the current week”, you need to convert like #q_date.addDays(1) or #q_date.addDays(-5) Date, Determine Whether Business Day Determines whether the date value is Business Day or not. If a holiday, returns the name of the holiday. If Sat or Sun, returns the day name. Otherwise, returns an empty string. You can also set special holidays set by your company Date, Calc after N Business Days Calculates N business days after the specified date. If N is negative, returns N business days ago. It is necessary to set a holiday in advance. It is also possible to add company-original holidays Quser, Set One User of Qorg using Round-Robin Extracts one user from the members of Qorg in order using a round robin method and sets that user in the Quser data. It is also possible to exclude specific users from the extraction target. If there are no candidates in the population, an error will occur Quser, Set One User of Qorg Randomly Extracts one user from the members of Qorg randomly and sets that user in Quser data. It is also possible to exclude specific users from the extraction target. If no candidates in the population, an error will occur Questetra-Addon-XML file, Extract Configs Extracts the configs of the Auto Step (automated task). The Addon-XML file (for Questetra BPMS automatic task) is parsed and information such as summary, last-modified, config etc. are extracted Questetra-Model-XML file, Extract Definitions Extracts the step names and the data item names (variable names) of the Workflow App. The Model-XML file is parsed to extract information such as whether it is a human task or an automated task, what the type of data item is, and so on Multiline String, Get Range Lines Extracts the specified range of rows. The range is specified by Begin Index and End Index. The index is zero-based and the index on the first row is zero. Note that the row specified by the End Index is not included in the range
	Compare Two Datetimes, Calculate Duration Calculates the duration between Datetime-A and Datetime-B; like elapsed days (e.g. “1.38 d”), hours (e.g. “33.33 h”), minutes (e.g. “2000.00 min”) and/or time (e.g. “33:20”). A minus sign is given if Datetime-B is earlier than Datetime-A Two Dates, Calculate Business Days Calculates the number of business days between date A and date B. Holidays must be set in advance. Company’s original holidays can be added. For example, this function can be used for calculating the number of business days for the month in advance and planning the work. Diff (Table and Table) Checks the difference between information in two Table-type Data Items line by line Two Tsv Strings, Compare Numeric Cells Compares numeric column strings in TSV-A and TSV-B, and lists the amount of change from A to B. If there is no string that matches the key column of A, it will not be listed. If there are multiple matches, it will be compared with the key above Two Tsv Strings, Extract Cell-Matched Lines Compares a specific column of TSV string A with a specific column of B and extracts the rows of B that have a matching cell in A. If A and B match exactly, all lines in B are returned. If they are completely different, an empty string is returned Two Tsv Strings, Extract Cell-Mismatched Lines Compares a specific column of TSV string A with a specific column of B and extracts the rows of B that do not have a cell match for A. If A and B match exactly, an empty string is returned. If they are completely different, all lines in B are returned Two TSV Strings, Join on Common Column Merges two TSVs based on a common key-field. Keeps all the rows from TsvA (left table) and brings in any matching rows from TsvB (right table); Left Outer Join. Neither TSV needs to be sorted. Only the upper row in TsvB will be matched
	Act+Misc any data-type, Output to Log Outputs business data to “Auto-Processing Log”. Administrators of the Workflow Application can verify the data that was stored when the process reached this step Open Chat, Post Posts the text to OpenChat in the Workflow Platform. Since the ProcessID hashtag (topic) like “#p123” is automatically added, it will be displayed on the timeline of the process participants. Note that all users can browse with searching. Master Table: Update Creates a new master file (OptionsXML) by referring to the master table on Workflow Platform. A new ID-Label will be added to the first line. Rows with the same ID are deleted. For automation, place [Service Task (Choices Update)] downstream Master Table, Backup Backs up the master information shared in the Workflow Platform by saving as it an Options-XML file. If the specified master name does not exist, an error will occur. To save as a different name, specify the backup file name Master Table, Get Options Data Gets master data by referring to the master table on Workflow Platform Master Table: List All Options as TSV String Includes the master table on Workflow Platform as a string property of the process. The IDs and Labels are concatenated into TSV (Tab-Separated Values) and stored into Multiline-String type Master Table, Create by TSV String Creates a new master file (OptionsXML) by referring to the TSV String. The specified column data are set as Master IDs, and the other data is set as Master Labels. By placing a [Service Task (Choices Update)] in the downstream process, the update task can be automated. Master Table: Update to Delete Options Deletes unnecessary Options and Creates a new master file (OptionsXML) by referring to the master table on Workflow Platform. No error occurs even if the deletion ID does not exist. For automation, place [Service Task (Choices Update)] downstream My-Number String, Test Check Digit Determines whether a My-Number string is valid. If valid, "OK" is recorded in the log. If invalid, the processing is terminated. It is possible to control the flow with an Error Boundary Event. My-Number is a 12-digit ID issued to all citizens and residents of Japan, including foreigners Corporate-Number String, Test Check Digit Determines whether a Corporate-Number string is valid. If valid, OK is logged. If invalid, processing is terminated which can be controlled with an Error Boundary Event. The numbers are 13-digit IDs assigned to companies and other organizations registered in Japan