org.apache.nifinifi-box-nar2.3.0org.apache.nifinifi-box-services-api-nar2.3.02.0.0rel/nifi-2.3.0main1org.apache.nifi.processors.box.ConsumeBoxEnterpriseEventsPROCESSORConsumes Enterprise Events from Box admin_logs_streaming Stream Type. The content of the events is sent to the 'success' relationship as a JSON array. The last known position of the Box stream is stored in the processor state and is used to resume the stream from the last known position when the processor is restarted. boxstoragebox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalseEvent TypesEvent TypesA comma separated list of Enterprise Events to consume. If not set, all Events are consumed.See Additional Details for more information.falsefalsefalseNONEfalsefalseStart Event PositionStart Event PositionWhat position to consume the Events from.earliestearliestearliestStart consuming events from the earliest available Event.latestlatestStart consuming events from the latest Event.offsetoffsetStart consuming events from the specified offset.truefalsefalseNONEfalsefalseStart OffsetStart OffsetThe offset to start consuming the Events from.truefalsefalseNONEfalsefalseStart Event PositionStart Event PositionoffsetsuccessEvents received successfully will be sent out this relationship.falsetruetrueThe last known position of the Box Event stream is stored in the processor state and is used to resume the stream from the last known position when the processor is restarted. CLUSTERINPUT_FORBIDDENorg.apache.nifi.processors.box.ConsumeBoxEventsorg.apache.nifi.processors.box.FetchBoxFileorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.ConsumeBoxEventsPROCESSORConsumes all events from Box. This processor can be used to capture events such as uploads, modifications, deletions, etc. The content of the events is sent to the 'success' relationship as a JSON array. Events can be dropped in case of NiFi restart or if the queue capacity is exceeded. The last known position of the Box stream is stored in the processor state and is used to resume the stream from the last known position when the processor is restarted. boxstoragebox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalseQueue CapacityQueue CapacityThe maximum size of the internal queue used to buffer events being transferred from the underlying stream to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor during these surges. 10000truefalsefalseNONEfalsefalsesuccessEvents received successfully will be sent out this relationship.falsetruetrueThe last known position of the Box stream is stored in the processor state and is used to resume the stream from the last known position when the processor is restarted. CLUSTERINPUT_FORBIDDENorg.apache.nifi.processors.box.FetchBoxFileorg.apache.nifi.processors.box.PutBoxFileorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.FetchBoxFilePROCESSORFetches files from a Box Folder. Designed to be used in tandem with ListBoxFile.boxstoragefetchbox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalsebox-file-idFile IDThe ID of the File to fetch${box.id}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureA FlowFile will be routed here for each File for which fetch was attempted but failed.falsesuccessA FlowFile will be routed here for each successfully fetched File.falsebox.idThe id of the filebox.idThe id of the filefilenameThe name of the filepathThe folder path where the file is locatedbox.sizeThe size of the filebox.timestampThe last modified time of the fileerror.codeThe error code returned by Boxerror.messageThe error message returned by BoxINPUT_REQUIREDorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.PutBoxFileorg.apache.nifi.processors.box.FetchBoxFileInfoPROCESSORFetches metadata for files from Box and adds it to the FlowFile's attributes.boxstoragemetadatafetchbox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalseFile IDFile IDThe ID of the File to fetch metadata for${box.id}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureA FlowFile will be routed here if fetching the file metadata fails.falsenot.foundFlowFiles for which the specified Box file was not found.falsesuccessA FlowFile will be routed here after successfully fetching the file metadata.falsebox.idThe id of the filefilenameThe name of the filepathThe folder path where the file is locatedbox.sizeThe size of the filebox.timestampThe last modified time of the filebox.created.atThe creation date of the filebox.ownerThe owner of the filebox.descriptionThe description of the filebox.etagThe etag of the filebox.sha1The SHA-1 hash of the filebox.content.created.atThe date the content was createdbox.content.modified.atThe date the content was modifiedbox.item.statusThe status of the file (active, trashed, etc.)box.sequence_idThe sequence ID of the filebox.parent.folder.idThe ID of the parent folderbox.trashed.atThe date the file was trashed, if applicablebox.purged.atThe date the file was purged, if applicablebox.shared.linkThe shared link of the file, if anyerror.codeThe error code returned by Boxerror.messageThe error message returned by BoxINPUT_REQUIREDorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.FetchBoxFileorg.apache.nifi.processors.box.PutBoxFileorg.apache.nifi.processors.box.FetchBoxFileRepresentationPROCESSORFetches a Box file representation using a representation hint and writes it to the FlowFile content.boxcloudstoragefilerepresentationcontentdownloadbox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalseFile IDFile IDThe ID of the Box file to retrieve.${box.id}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseRepresentation TypeRepresentation TypeThe type of representation to fetch. Common values include 'pdf', 'text', 'jpg', 'png', etc.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalserepresentation.not.foundFlowFiles for which the specified Box file's requested representation was not found.falsefailureFlowFiles that encounter errors during processing will be routed to this relationship.falsesuccessFlowFiles that are successfully processed will be routed to this relationship.falsefile.not.foundFlowFiles for which the specified Box file was not found.falsebox.idThe ID of the Box file.box.file.nameThe name of the Box file.box.file.sizeThe size of the Box file in bytes.box.file.created.timeThe timestamp when the file was created.box.file.modified.timeThe timestamp when the file was last modified.box.file.mime.typeThe MIME type of the file.box.file.representation.typeThe representation type that was fetched.box.error.messageThe error message returned by Box if the operation fails.box.error.codeThe error code returned by Box if the operation fails.INPUT_REQUIREDorg.apache.nifi.processors.box.FetchBoxFileorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.GetBoxFileCollaboratorsPROCESSORRetrieves all collaborators on a Box file and adds the collaboration information to the FlowFile's attributes.boxstoragecollaborationpermissionssharingbox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalseFile IDFile IDThe ID of the Box file to retrieve collaborators for${box.id}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureFlowFiles that encounter errors during processing will be routed to this relationshipfalsenot.foundFlowFiles for which the specified Box file was not foundfalsesuccessFlowFiles that have been successfully processed will be routed to this relationshipfalsebox.idThe id of the filebox.collaborations.<status>.users.idsComma-separated list of user collaborator IDs by statusbox.collaborations.<status>.groups.idsComma-separated list of group collaborator IDs by statusbox.collaborations.<status>.users.emailsComma-separated list of user collaborator emails by statusbox.collaborations.<status>.groups.emailsComma-separated list of group collaborator emails by statusbox.collaborations.countTotal number of collaborations on the fileerror.codeThe error code returned by Boxerror.messageThe error message returned by BoxINPUT_REQUIREDorg.apache.nifi.processors.box.FetchBoxFileorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.GetBoxGroupMembersPROCESSORRetrieves members for a Box Group and writes their details in FlowFile attributes.boxstoragemetadatabox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalseGroup IDGroup IDThe ID of the Group to retrieve members for${box.group.id}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureThe FlowFile will be routed here when Group memberships retrieval was attempted but failed.falsenot.foundThe FlowFile will be routed here when the Group was not found.falsesuccessThe FlowFile will be routed here after successfully retrieving Group members.falsebox.group.idThe ID of the Group to retrieve members for.box.group.user.idsA comma-separated list of user IDs in the group.box.group.user.loginsA comma-separated list of user Logins (emails) in the group.error.codeAn http error code returned by Box.error.messageAn error message returned by Box.trueINPUT_REQUIREDorg.apache.nifi.processors.box.ListBoxFilePROCESSORLists files in a Box folder. Each listed file may result in one FlowFile, the metadata being written as FlowFile attributes. Or - in case the 'Record Writer' property is set - the entire result is written as records to a single FlowFile. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data.boxstoragebox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalsebox-folder-idFolder IDThe ID of the folder from which to pull list of files.truefalsetrueENVIRONMENTfalsefalserecursive-searchSearch RecursivelyWhen 'true', will include list of files from sub-folders. Otherwise, will return only files that are within the folder defined by the 'Folder ID' property.truetruetruefalsefalsetruefalsefalseNONEfalsefalsemin-ageMinimum File AgeThe minimum age a file must be in order to be considered; any files younger than this will be ignored.0 sectruefalsefalseNONEfalsefalselisting-strategyListing StrategySpecify how to determine new/updated entities. See each strategy descriptions for detail.timestampsTracking TimestampstimestampsThis strategy tracks the latest timestamp of listed entity to determine new/updated entities. Since it only tracks few timestamps, it can manage listing state efficiently. However, any newly added, or updated entity having timestamp older than the tracked latest timestamp can not be picked by this strategy. For example, such situation can happen in a file system if a file with old timestamp is copied or moved into the target directory without its last modified timestamp being updated. Also may miss files when multiple subdirectories are being written at the same time while listing is running.Tracking EntitiesentitiesThis strategy tracks information of all the listed entities within the latest 'Entity Tracking Time Window' to determine new/updated entities. This strategy can pick entities having old timestamp that can be missed with 'Tracking Timestamps'. Works even when multiple subdirectories are being written at the same time while listing is running. However additional DistributedMapCache controller service is required and more JVM heap memory is used. See the description of 'Entity Tracking Time Window' property for further details on how it works.Time Windowtime-windowThis strategy uses a sliding time window. The window starts where the previous window ended and ends with the 'current time'. One cycle will list files with modification time falling within the time window. Works even when multiple subdirectories are being written at the same time while listing is running. IMPORTANT: This strategy works properly only if the time on both the system hosting NiFi and the one hosting the files are accurate.No TrackingnoneThis strategy lists an entity without any tracking. The same entity will be listed each time on executing this processor. It is recommended to change the default run schedule value. Any property that related to the persisting state will be disregarded.truefalsefalseNONEfalsefalseet-state-cacheEntity Tracking State CacheListed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy.org.apache.nifi.distributed.cache.client.DistributedMapCacheClientorg.apache.nifinifi-standard-services-api-nar2.3.0falsefalsefalseNONEfalsefalselisting-strategyListing Strategyentitieset-time-windowEntity Tracking Time WindowSpecify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.3 hoursfalsefalsetrueENVIRONMENTfalsefalselisting-strategyListing Strategyentitieset-initial-listing-targetEntity Tracking Initial Listing TargetSpecify how initial listing should be handled. Used by 'Tracking Entities' strategy.allTracking Time WindowwindowIgnore entities having timestamp older than the specified 'Tracking Time Window' at the initial listing activity.All AvailableallRegardless of entities timestamp, all existing entities will be listed at the initial listing activity.falsefalsefalseNONEfalsefalselisting-strategyListing Strategyentitiesrecord-writerRecord WriterSpecifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles.org.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0falsefalsefalseNONEfalsefalsesuccessAll FlowFiles that are received are routed to successfalsebox.idThe id of the filefilenameThe name of the filepathThe folder path where the file is locatedbox.sizeThe size of the filebox.timestampThe last modified time of the filetruetrueThe processor stores necessary data to be able to keep track what files have been listed already. What exactly needs to be stored depends on the 'Listing Strategy'.CLUSTERINPUT_FORBIDDENorg.apache.nifi.processors.box.FetchBoxFileorg.apache.nifi.processors.box.PutBoxFileTIMER_DRIVEN1 min1org.apache.nifi.processors.box.PutBoxFilePROCESSORPuts content to a Box folder.boxstorageputbox-client-serviceBox Client ServiceController Service used to obtain a Box API connection.org.apache.nifi.box.controllerservices.BoxClientServiceorg.apache.nifinifi-box-services-api-nar2.3.0truefalsefalseNONEfalsefalsebox-folder-idFolder IDThe ID of the folder where the file is uploaded. Please see Additional Details to obtain Folder ID.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesubfolder-nameSubfolder NameThe name (path) of the subfolder where files are uploaded. The subfolder name is relative to the folder specified by 'Folder ID'. Example: subFolder, subFolder1/subfolder2falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsecreate-folderCreate SubfolderSpecifies whether to check if the subfolder exists and to automatically create it if it does not. Permission to list folders is required. falsetruetruefalsefalsetruefalsefalseNONEfalsefalsesubfolder-nameSubfolder Namefile-nameFilenameThe name of the file to upload to the specified Box folder.${filename}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseconflict-resolution-strategyConflict Resolution StrategyIndicates what should happen when a file with the same name already exists in the specified Box folder.failfailfailHandle file conflict as failure.ignoreignoreIgnore conflict, do not change the original file.replacereplaceReplace existing file in case of conflict.truefalsefalseNONEfalsefalsechunked-upload-thresholdChunked Upload ThresholdThe maximum size of the content which is uploaded at once. FlowFiles larger than this threshold are uploaded in chunks. Chunked upload is allowed for files larger than 20 MB. It is recommended to use chunked upload for files exceeding 50 MB.20 MBfalsefalsefalseNONEfalsefalsefailureFiles that could not be written to Box for some reason are transferred to this relationship.falsesuccessFiles that have been successfully written to Box are transferred to this relationship.falsefilenameUses the FlowFile's filename as the filename for the Box object.box.idThe id of the filefilenameThe name of the filepathThe folder path where the file is locatedbox.sizeThe size of the filebox.timestampThe last modified time of the fileerror.codeThe error code returned by Boxerror.messageThe error message returned by BoxINPUT_REQUIREDorg.apache.nifi.processors.box.ListBoxFileorg.apache.nifi.processors.box.FetchBoxFile