Webservices (WSDL)

Command

ECMAttributionMecanismService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMAttributionMecanismService?wsdl

ECMBusinessPeriodService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMBusinessPeriodService?wsdl

ECMCardIndexService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardIndexService?wsdl

ECMCardService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardService?wsdl

ECMColleagueGroupService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueGroupService?wsdl

ECMColleagueReplacementService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueReplacementService?wsdl

ECMColleagueService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueService?wsdl

ECMCompanyService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCompanyService?wsdl

ECMCustomFieldsService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCustomFieldsService?wsdl

ECMDashBoardService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDashBoardService?wsdl

ECMDataServiceService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDataServiceService?wsdl

ECMDatasetService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDatasetService?wsdl

ECMDocumentService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDocumentService?wsdl

ECMFavoritesService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFavoritesService?wsdl

ECMFolderService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFolderService?wsdl

ECMGlobalParamService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGlobalParamService?wsdl

ECMGroupService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGroupService?wsdl

ECMOutstandingService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMOutstandingService?wsdl

ECMReportService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMReportService?wsdl

ECMSearchDocumentService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSearchDocumentService?wsdl

ECMSignalService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSignalService?wsdl

ECMTokenService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMTokenService?wsdl

ECMWorkflowEngineService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowEngineService?wsdl

ECMWorkflowRoleService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowRoleService?wsdl

getAttributionMecanism

Returns the company assignment mechanisms.

Method:

getAttributionMecanism(String user, String password, int companyId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.

Return: AttributionMecanismDto[].

Returns the working hours of the company.

Method:

getBusinessPeriods(String user, String password, int companyId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.

Return: BusinessPeriodDto[].

createSimpleCardIndex

Simple creation of a form.

Method:

createSimpleCardIndex (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, AttachmentArray attachments, CardEventDtoArray customEvents)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• parentDocumentId: form number.
• publisherId: author code.
• documentDescription: description.
• cardDescription: name.
• attachments: attached file.
• customEvents: events.

Return: WebServiceMessageArray [].

createSimpleCardIndexWithDataset

Simple creation of a form with datasets.

Method:

createSimpleCardIndexWithDataset (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• parentDocumentId: form number.
• publisherId: author code.
• documentDescription: description.
• cardDescription: name.
• datasetName: dataset name.
• attachments: attached file.
• customEvents: events.

Return: WebServiceMessageArray [].

createSimpleCardIndexWithDatasetPersisteType

Simple creation of a form with datasets, determining the persistence type (Form or List).

createSimpleCardIndexWithDatasetPersisteType (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents, Integer persistenceType)

Parameters:

• user: user login.
• password: user password.
• companyId: company code;
• parentDocumentId: form number.
• publisherId: author code.
• documentDescription: description.
• cardDescription: name.
• datasetName: dataset name.
• attachments: attached file.
• customEvents: events.
• persistenceType: persistence type that will be used.

Return: WebServiceMessageArray [].

getActiveCardIndex

Returns the active form.

Method:

getActiveCardIndex (String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.
• colleagueId: user number.

Return: DocumentDtoArray [].

getAttachmentsList

Returns the form attachment list.

Method:

getAttachmentsList (String user, String password, int companyId, int documentId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.

Return: StringArray [].

getCardIndexContent

Returns the content of a form.

Method:

getCardIndexContent (String user, String password, int companyId, int documentId, String colleagueId, int version, String nomeArquivo)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.
• colleagueId: user registration for checking form permission.
• version: form version number.
• nomeArquivo: attachment file name.

Return: byte[].

getCardIndexesWithoutApprover

Returns the forms without approvers to which the user has permission.

Method:

getCardIndexesWithoutApprover(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration for checking form permission.

Return: DocumentDto[].

getCustomizationEvents

Returns the form events.

Method:

getCustomizationEvents (String user, String password, int companyId, int documentId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.

Return: CardEventDtoArray [].

getFormFields

Returns the form fields.

Method:

getFormFields(String user, String password, int companyId, int documentId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.

Return: String[].

updateSimpleCardIndex

Form simple update.

Method:

updateSimpleCardIndex (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, AttachmentArray attachments, CardEventDtoArray customEvents)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.
• publisherId: author code.
• cardDescription: name.
• descriptionField: description.
• attachments: attached file.
• customEvents: events.

Return: WebServiceMessageArray [].

updateSimpleCardIndexWithDataset

Simple update of the form with datasets.

Method:

updateSimpleCardIndexWithDataset (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: form number.
• publisherId: author code.
• cardDescription: name.
• descriptionField: description.
• datasetName: dataset name.
• attachments: attached file.
• customEvents: events.

Return: WebServiceMessageArray [].

create

Creates a form.

Method:

create(int companyId, String user, String password, CardDto[] carddtos)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• carddtos: form that will be created.

Return: WebServiceMessage[].

deleteCard

Deletes a form and sends it to the bin.

Method:

deleteCard(int companyId, String user, String password, int cardId)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• cardId: form number.

Return: WebServiceMessage[].

getCardVersion

Returns the version of a form.

Method:

getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)

Method:

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• nrDocumentId: form number.
• version: form version.
• colleagueId: user registration.

Return: CardDto[].

updateCard

Changes the metadata of a form.

Method:

updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• cardDtos: form that will be changed.
• attachs: form attachment.
• docsecurity: form security.
• docapprovers: form approvers.
• reldocs: documents related to form.

Return: WebServiceMessage[].

updateCardData

Changes the fields of a form.

Method:

updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• cardId: form number.
• cardData: form fields that will be changed.

Return: WebServiceMessage[].

createColleagueGroup

Associates a user to a group.

Method:

createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

Parameters:

• username: user login.
• password: user password.
• companyId: company code;
• grupo_colaborador: group that will be associated with a user.

Return: String.

deleteColleagueGroup

Deletes a user from a group.

Method:

deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• groupId: group code.
• colleagueId: user registration.

Return: String.

getAllColleagueGroups

Returns all the groups that have related users.

Method:

getAllColleagueGroups(String username, String password, int companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: ColleagueGroupDto[].

getColleagueGroup

Returns only a group that a certain user participates in.

Method:

getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• groupId: group code.
• colleagueId: user registration.

Return: ColleagueGroupDto[].

Return Attributes:

• colleagueId

• companyId

• groupId

getColleagueGroupsByColleagueId

Returns the groups that a user participates in.

Method:

getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: ColleagueGroupDto[].

Return Attributes:

• colleagueId

• companyId

• groupId

 getColleagueGroupsByGroupId

Returns the users that participate from a group of users.

Method:

getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• groupId: group code.

Return: ColleagueGroupDto[].

Return Attributes:

• colleagueId

• companyId

• groupId

updateColleagueGroup

Changes the association of a user with a group.

Method:

updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• grupo_colaborador: user group that will be changed.

Return: String.

createColleagueReplacement

Creates a substitute.

Method:

createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• crDto: substitute registration.

Return: String.

deleteColleagueReplacement

Deletes a substitute registration.

Method:

deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: source user registration.
• replacementId: substitute user registration.

Return: String.

getColleagueReplacement

Returns a substitute of a user.

Method:

getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: source user registration.
• replacementId: substitute user registration.

Return: ColleagueReplacementDto.

 getReplacementsOfUser

Returns all the substitutes of a user.

Method:

getReplacementsOfUser(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: source user registration.

Return: ColleagueReplacementDto[].

getValidReplacedUsers

Returns all the substitute users by a valid substitute.

Method:

getValidReplacedUsers(String username, String password, int companyId, String replacementId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code;
• replacementId: substitute user registration.

Return: ColleagueReplacementDto[].

getValidReplacement

Returns a valid substitute of a user.

Method:

getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: source user registration.
• replacementId: substitute user registration.

Return: ColleagueReplacementDto.

getValidReplacementsOfUser

Returns all the valid substitutes of a user.

Method:

getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code;
• colleagueId: source user registration.

Return: ColleagueReplacementDto[].

updateColleagueReplacement

Changes a substitute registration.

Method:

updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• crDto: user registration.

Return: String.

createColleague

Creates a user.

Method:

createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagues: users.

Return: String.

createColleaguewithDependencies

Creates a user with groups and roles.

Method:

createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagues: users.
• grupos: groups.
• papeis: roles.

Return: String.

getColleague

Returns a user.

Method:

getColleague(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: ColleagueDto[].

Return Attributes:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getColleagueByLogin 

Returns the user from the login.

Method:

getColleagueByLogin(String username, String password)

Parameters:

• username: user login.
• password: user password.

Return: ColleagueDto.

Return Attributes:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getColleagues

Returns all active users.

Method:

getColleagues(String username, String password, int companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: ColleagueDto[].

Return Attributes:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getColleaguesMail

Returns a user using an email.

Method:

getColleaguesMail(String username, String password, int companyId, String mail)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• mail: user email.

Return: ColleagueDto[].

Return Attributes:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

• volumeId

getColleagueWithMap

Returns a message informing if the user was created correctly.

Method:

getColleagueWithMap(String colleagueXML, String username, String password)

Parameters:

• username: user login.
• password: user password.
• colleagueXML: document normalized list.

Return: String.

getGroups

Returns the groups that the user participates in.

Method:

getGroups(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: GroupDto[].

Return Attributes:

• companyId 

• groupDescription

• groupId

getSimpleColleague

Returns the user.

Method:

getSimpleColleague(String username, String password)

Parameters:

• username: user login.
• password: user password.

Return: ColleagueDto.

Return Attributes:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getSummaryColleagues

Returns all active users.

Method:

getSummaryColleagues(int companyId)

Parameters:

• companyId: company code.

Return: ColleagueDto[].

Return Attributes:

• active 

• colleagueId

• colleagueName

• companyId

• maxPrivateSize

• rowId

• usedSpace

removeColleague

Deactivates a user.

Method:

removeColleague(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: String.

Activates a user.

Method:

activateColleague(String username, String password, int companyId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: String.

updateColleague

Changes a user.

Method:

updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagues: users.

Return: String.

updateColleaguewithDependencies

Changes a user with groups and roles.

Method:

updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• colleagues: users.
• grupos: groups.
• papeis: roles.

Return: String.

validateColleagueLogin

Validates a user access in the product.

Method:

validateColleagueLogin(int companyId, String colleagueId, String password)

Parameters:

• companyId: company code.
• colleagueId: user registration.
• password: user password.

Return: String.

createCompany

Creates a company in Fluig.

Method:

createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• description: company description.
• urlAccessName: Access URL.
• phisicalPath: physical path.
• webdeskServer: server.
• webPort: port.

Return: String.

delete

Deletes a company in Fluig.

Method:

delete(String username, String password, String companyId, Boolean deleteFiles)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• deleteFiles: indicates if the physical path should be deleted.

Return: String.

getCompanies

Returns all the companies registered in Fluig.

Method:

getCompanies(String username, String password, String companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: CompanyDto[].

getCompany

Returns a company registered in Fluig.

Method:

getCompany(int companyId)

Parameters:

• companyId: company code.

Return: CompanyDto.

updateCompany

Changes a company in Fluig.

Method:

updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• description: company description.
• urlAccessName: Access URL.
• phisicalPath: physical path.
• webdeskServer: server.
• webPort: port.

Return: String.

createCustomFields

Creates a customized field.

Method:

createCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• customFieldsDto: customized field that will be created.

Return: String.

getAllCustomField

Returns all the customized fields.

Method:

getAllCustomField(String user, String password, int companyId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.

Return: CustomFieldsDto[].

getAllDocumentCustomField

Returns all the customized fields of a document.

Method:

getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: document number.
• version: document version.

Return: DocumentCustomFieldsDto[].

removeCustomField

Deletes a customized field.

Method:

removeCustomField(String user, String password, int companyId, String customFieldsId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• customFieldsId: customized field code.

Return: String.

removeDocumentCustomField

Deletes a document customized field.

Method:

removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• customFieldsId: customized field code.
• documentId: document number.
• version: document version.

Return: String.

setDocumentCustomFields

Creates or changes a document-customized field.

Method:

setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentCustomFieldsDto: document with customized field.

Return: String.

updateCustomFields

Changes a customized field.

Method:

updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• customFieldsDto: customized field that will be changed.

Return: String.

findMyDocuments

Returns the user documents that need to be approved.

Method:

findMyDocuments(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

findMyDocumentsOnDemand

Returns the user documents that need to be approved, paged.

Method:

findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: DocumentDto[].

findDocumentsToApprove

Returns the documents that the user needs to approve.

Method:

findDocumentsToApprove(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

findDocumentsToApproveOnDemand

Returns the documents that the user needs to approve, paged.

Method:

findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: DocumentDto[].

findAgreementDocuments

Returns the user documents that are in concensus.

Method:

findAgreementDocuments(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

findCheckoutDocuments

Returns the user documents that are in checkout.

Method:

findCheckoutDocuments(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

findCancelledTasks

Returns tasks assigned to the user that were canceled.

Method:

findCancelledTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findCompletedTasks

Returns tasks assigned to the user that were finished.

Method:

findCompletedTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findConsensusTasks

Returns tasks assigned to the user that are in consensus.

Method:

findConsensusTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findTransferredTasks

Returns tasks assigned to the user that were transfered.

Method:

findTransferredTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findWorkflowTasks

Returns the user tasks that are open.

Method:

findWorkflowTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findWorkflowTasksOnDemand

Returns the user tasks that are open, paged.

Method:

findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: WorkflowProcessDto[].

findMyRequests

Returns the open requests that were started by the user.

Method:

findMyRequests(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findMyRequestsOnDemand

Returns the open requests that were started by the user, paged.

Method:

findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: WorkflowProcessDto[].

findMyManagerTasks

Returns the tasks managed by the user.

Method:

findMyManagerTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

findExpiredWorkflowTasks

Returns the user tasks that are delayed.

Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowProcessDto[].

fillStatusTask

Returns the amount of a user delayed tasks, within the deadline and without deadline.

Method:

fillStatusTask(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: int[].

fillChronoTasks

Returns the amount of tasks with a deadline that were assigned to the user and were not finished.

Method:

fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• yearIni: initial year.
• yearFin: final year.
• mounthIni: initial month.
• mounthFin: final month.
• dayIni: initial day.
• dayFin: final day.
• kindTask: task type.

Return: int[].

fillTypeTasks

Returns the task types that the user has.

Method:

fillTypeTasks(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: TaskVODto[].

fillTypeTasksOfReplacement

Returns the task types that the substitute user has.

Method:

fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• replacementId: substitute user registration.

Return: TaskVODto[].

getOpenTasksByColleagueGroups

Returns the tasks assigned to a group that the user participates in.

Method:

getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowTaskDto[].

getOpenTasksByColleagueGroupsOnDemand

Returns the tasks assigned to a group that the user participates in, paged.

Method:

getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: WorkflowTaskDto[].

getOpenTasksByColleagueRoles

Returns the tasks assigned to a role that the user participates in.

Method:

getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: WorkflowTaskDto[].

getOpenTasksByColleagueRolesOnDemand

Returns the tasks assigned to a role workflow that the user participates in, paged.

Method:

getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: WorkflowTaskDto[].

getSummaryRequests

Returns the Home pending counters.

Method:

getSummaryRequests(int companyId, String user, String password, String colleagueId)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• colleagueId: user registration.

Return: HomeRequestSummaryDto[].

Returns the server url.

Method:

getUrlEcm(long companyId)

Parameters:

• companyId: company code.
  
  

createDataService

Creates an external service.

Method:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• dataServiceDto: external service that will be created.

Return: String.

Removes an external service.

Method:

deleteDataService(int companyId, String user, String password, String dataServiceName)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• dataServiceName: external service name that will be removed.
  
  

Return: void.

Returns all the registered external services.

Method:

getAllServices(int companyId, String user, String password)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.

Return: dataServiceDto[].

Returns an external service.

Method:

loadDataService(int companyId, String user, String password, String dataServiceName)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• dataServiceName: external service name.

Return: dataServiceDto.

Updates an external service.

Method:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• dataServiceDto: external service that will be updated.

Return: void.

createDataServiceAuthenticated

Creates an external authenticated service.

Method:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• dataServiceDto: external service that will be created.
• oauthDTO: Settings object to service authentication.

Return: String.

Updates an external authenticated service.

Method:

updateDataServiceAuthenticated(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• dataServiceDto: external service that will be updated.
• oauthDTO: Settings object to service authentication.

Return: void.

addDataset

Creates a dataset.

Method:

addDataset(int companyId, String user, String password, String datasetName, String description, String impl)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• datasetName: name of the dataset that will be created.
• description: dataset description.
• impl: implementation for creating the dataset.

Return: String.

deleteDataset

Removes a dataset.

Method:

deleteDataset(int companyId, String user, String password, String datasetName)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• datasetName: name of the dataset that will be removed.

Return: void.

getAvailableDatasets

Returns all the available datasets.

Method:

getAvailableDatasets(int companyId, String user, String password)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.

Return: Object[].

getDataset

Returns information from a dataset.

Method:

getDataset(int companyId, String user, String password, String name, String[] fields, SearchConstraintDto[] constraintsDto, String[] order)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• name: dataset name.
• fields: dataset fields that will be returned.
• constraintsDto: record filter that will compose the dataset.
• order: fields used to order the dataset.

Return: DatasetDto.

updateDataset

Updates a dataset.

Method:

updateDataset(int companyId, String user, String password, String datasetName, String description, String impl)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• datasetName: name of the dataset that will be updated.
• description: dataset description.
• impl: dataset implementation.

Return: void.

approveDocument

Approves or rejects document pending approval.

Method:

approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation)

Parameters:

• user: integration user code.
• password: integration user password.
• companyId: company code.
• documentId: code of the document to be approved.
• version: version of the document to be approved.
• approverId: approver code
• approved: true if the document is approved and false if the document will be rejected.
• observation: note of approval or rejection.

Return: WebServiceMessage[]

copyDocumentToUploadArea

Copies the files (main and attachments) of a document for the user upload area. This allows documents to be accessible through FTP.

Method:

copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: number of the document that will be copied.
• version: document version
• colleagueId: user registration whose upload area will be used

Return: String[] name of the files that were made available in the upload area

createDocument

Creates a document.

Method:

createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docDtos: document that will be posted.
• attachs: file attached to post.
• docSecurity: security of the document that will be posted.
• docApprovers: approvers of document that will be posted.
• relDocs: documents related to the document that will be posted.

Return: WebServiceMessage[].

createDocumentWithApprovementLevels

Creates a document with approval level.

Method:

createDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverWithLevelDto[] docApproversLevels, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docDtos: document that will be posted.
• attachs: file attached to post.
• docSecurity: security of the document that will be posted.
• docApproversLevel: approval level in which document approvers are inserted.
• levels: approval levels that the document will have.
• relDocs: documents related to the document that will be posted.

Return: WebServiceMessage[].

createSimpleDocument

Creates a simple document.

Method:

createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• parentDocumentId: parent folder number.
• publisherId: registration of the user that will post the document.
• documentDescription: document description.
• attachments: file attached to post.

Return: WebServiceMessage[].

createSimpleDocumentPrivate

Creates a simple document in the private folder.

Method:

createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)

Parameters:

• colleagueId: user login.
• password: user password.
• companyId: company code.
• parentDocumentId: parent folder number.
• documentDescription: document description.
• attachments: file attached to post.

Return: WebServiceMessage[].

deleteDocument

Deletes a document and sends it to the bin.

Method:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: number of the document that will be excluded.
• colleagueId: user registration.

Return: WebServiceMessage[].

destroyDocument

Deletes a bin document.

Method:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: number of the document that will be excluded.
• colleagueId: user registration.

Return: WebServiceMessage[].

destroyDocumentApproval

Deletes document pending approval.

Method:

destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId)

Parameters:

• user: integration user code.
• password: integration user password.
• companyId: company code.
• documentId: code of the document to be deleted.
• publisherId: publisher code.

Return: WebServiceMessage[]

findMostPopularDocuments

Returns the documents mostly accessed in Fluig to which the user has access permission.

Method:

findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• nr_resultados: amount of documents that will be returned.

Return: DocumentDto[].

Return Attributes:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

findMostPopularDocumentsOnDemand

Returns the documents mostly accessed in Fluig to which the user has access permission, paged.

Method:

findMostPopularDocuments(int companyId, String user, String password, String colleagueId, int limit, int lastRowId)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: DocumentDto[].

Return Attributes:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

findRecycledDocuments

Returns the documents from the bin.

Method:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

Return Attributes:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

getActiveDocument

Returns an active document.

Method:

getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• colleagueId: user registration.

Return: DocumentDto[].

getApprovers

Returns the approvers of a document.

Method:

getApprovers(String user, String password, int companyId, int nrDocumentId, int version)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• version: document version number.

Return: ApproverWithLevelDto[].

Return Attributes:

• approverType
• colleagueId
• companyId
• documentId
• levelId
• version

getDocumentApprovalHistory

Returns the approval history of the requested document.

Method:

getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int version)

Parameters:

• user: integration user code.
• password: integration user password.
• companyId: company code.
• documentId: document code for which you want to view the status.
• version: version of the document (if version 0 is provided, the last document version will be requested).

Return: DocumentApprovementHistoryDto[]

Return Attributes:

• colleagueId
• documentVersion
• iterationSequence
• levelId
• movementSequence
• observation
• signed
• status

getDocumentApprovalStatus

Returns the document status related to the approval. The document status can be:

0 - Approved.

1 - Rejected.

2 - Under approval.

Method:

getDocumentApprovalStatus(String user, String password, int companyId, int documentId, int version)

Parameters:

• user: integration user code.
• password: integration user password.
• companyId: company code.
• documentId: document code for which you want to view the status.
• version: version of the document (if version 0 is provided, the last document version will be requested).

Return: DocumentApprovalStatusDto[]

Return Attributes:

• companyId
• documentId
• status
• version

getDocumentByExternalId

Returns a document by the external code.

Method:

getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• externalDocumentId: document external code.
• colleagueId: user registration.

Return: DocumentDto[].

getDocumentContent

Returns a document physical file code, if the user has permission to access it.

Method:

getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• colleagueId: user registration.
• documentVersao: document version number.
• nomeArquivo: file name.

Return: byte[].

getDocumentVersion

Returns the version of a document.

Method:

getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• version: document version number.
• colleagueId: user registration.

Return: DocumentDto[].

Return Attributes:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

getRelatedDocuments

Returns all the documents related to a document.

Method:

getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• version: document version number.

Return: RelatedDocumentDto[].

Return Attributes:

• companyId
• documentId
• relatedDocumentId
• version

getReportSubjectId

Returns the report subject code within Fluig.

Method:

getReportSubjectId(String user, String password, int companyId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.

Return: int.

getSecurity

Returns a document security.

Method:

getSecurity(String user, String password, int company, int nrDocumentId, int version)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• version: document version number.

Return: DocumentSecurityConfigDto[].

Return Attributes:

• attributionType
• attributionValue
• companyId
• documentId
• permission
• securityLevel
• sequence
• showContent
• version

getUserPermissions

Returns the user permissions over a document.

Method:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

Parameters:

• companyId: company code.
• user: user login.
• nrDocumentId: document number.
• version: document version number.

Return: Integer.

Return Attributes:

• result

moveDocument

Moves documents to the target folder.

Method:

moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentIds: list with document numbers that will be moved.
• colleagueId: registration of the user with permission to move the document
• destFolder: target folder number.

Return: String[]

removeSecurity

Removes a document security.

Method:

removeSecurity(String user, String password, int companyId, int documentId, int version)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: document number.
• version: document version number.

Return: There is no return.

restoreDocument

Restores a document from the bin.

Method:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: number of the document that will be restored.
• colleagueId: user registration.

Return: WebServiceMessage[].

updateDocument

Changes a document.

Method:

updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docDtos: document that will be changed.
• attachs: file attached to change.
• docSecurity: security of the document that will be changed.
• docApprovers: approvers of document that will be changed.
• relDocs: documents related to the document that will be changed.

Return: WebServiceMessage[].

updateDocumentWithApprovementLevels

Changes a document with approval level.

Methods:

updateDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecutiry, ApproverWithLevelDto[]  docApprovers, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docDtos: document that will be changed.
• attachs: file attached to change.
• docSecurity: security of the document that will be changed.
• docApprovers: approval level in which document approvers are inserted.
• levels: approval levels that the document will have.
• relDocs: documents related to the document that will be changed.

Return: WebServiceMessage[].

updateGroupSecurityType

Modifies the group security type in the permission and restriction. There are two options that will be represented by an integer:

0 - ALL group users.

1 - ONLY group common users.

Method:

updateGroupSecurityType(String user, String password, int companyId, int documentId, int version, int permissionType, int restrictionType, String colleagueId)

Parameters:

• user: integration user code.
• password: integration user password.
• companyId: company code.
• documentId: document code.
• version: document version.
• permissionType: type of permission (0 - ALL group users / 1 - ONLY group common users)
• restrictionType: type of restriction (0 - ALL group users / 1 - ONLY group common users)
• colleagueId: user registration

Return: WebServiceMessage[] 

updateSimpleDocument

Changes a document in a simple way.

Method:

updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments)

Parameters:

• username: integration user login.
• password: integration user password.
• companyId: company code.
• documentId: number of the document that will be changed.
• publisherId: user registration that will change the document.
• documentDescription: document description.
• attachments: files attached to change.

Return: WebServiceMessage[].

validateIntegrationRequirements

Checks user integration in Fluig.

Method:

validateIntegrationRequirements (String user, String password, int companyId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.

Return: String.

addDocumentToFavorites

Adds a document to the provided user favorites.

Method:

addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao,  String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• nrDocument: document number
• nrVersao: document version
• colleagueId: user registration.

Return: void.

addProcessToFavorites

Adds a process to the provided user favorites.

Method:

addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processId: process code
• colleagueId: user registration.

findFavorites

Returns the user favorite documents.

Method:

findFavorites(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

findFavoritesOnDemand

Returns the user favorite documents, paged.

Method:

findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: DocumentDto[].

findFavoritesProcess

Returns the user favorite processes.

Method:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: ProcessDefinitionVersionDto[] .

findFavoritesProcessOnDemand

Returns the user favorite processes, paged.

Method:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: ProcessDefinitionVersionDto[] .

isFavoriteDocument

Checks if document is favorite.

Method:

isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId)

Parameters:

• username: integration user login.
• password: user password.
• companyId: company code.
• nrDocument: document code.
• colleagueId: user registration.

Return: Boolean.

removeFavoriteDocument

Removes a document from the provided user favorites.

Method:

removeFavoriteDocument (String username, String password, int companyId, int nrDocument,  String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• nrDocument: document number
• colleagueId: user registration.

Return: void.

removeFavoriteProcess

Removes a process from the provided user favorites.

Method:

addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• colleagueId: user registration.

Return: void.

createFolder

Creates a folder.

Method:

createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers )

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docdtos: folder that will be created.
• docsecurity: folder security.
• docapprovers: folder approvers.

Return: WebServiceMessage[].

createFolderWithApprovementLevels

Creates a folder with approval level.

Method:

createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docdtos: folder that will be created.
• docsecurity: folder security.
• docapprovers: approvers in levels.
• levels: folder approval levels.

Return: WebServiceMessage[].

createSimpleFolder

Creates a simple folder.

Method:

createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• parentDocumentId: parent document number.
• publisherId: registration of the publisher user.
• documentDescription: folder description.

Return: WebServiceMessage[].

deleteDocument

Deletes a folder and sends it to the bin.

Method:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: folder number.
• colleagueId: user registration.

Return: WebServiceMessage[].

destroyDocument

Deletes a folder from the bin.

Method:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: folder number.
• colleagueId: user registration.

Return: WebServiceMessage[].

findRecycledDocuments

Returns all the documents from a user's bin.

Method:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

getApprovers

Returns the approvers of a folder.

Method:

getApprovers(String user, String password, int companyId, int nrDocumentId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: folder number.

Return: ApproverWithLevelDto[].

getChildren

Returns all the documents of a folder.

Method:

getChildren(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: folder number.
• colleagueId: user registration.

Return: DocumentDto[].

getFolder

Returns a folder.

Method:

getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: folder number.
• colleagueId: source user registration.

Return: DocumentDto[].

getPrivateChildren

Returns all the documents of a private folder.

Method:

getPrivateChildren(String user, String password, int companyId, int parentDocumentId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: folder number.

Return: DocumentDto[].

getRootFolders

Returns the root folders that a user has access to, expect the private folder.

Method:

getRootFolders(String user, String password, int companyId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.

Return: DocumentDto[].

getSecurity

Returns a folder security.

Method:

getSecurity(String user, String password, int companyId, int nrDocumentId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: folder number.

Return: DocumentSecurityConfigDto[].

getSubFolders

Returns all the subfolders and files of a folder.

Method:

getSubFolders(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: folder number.
• colleagueId: user registration.

Return: DocumentDto[].

getSubFoldersOnDemand

Returns all the sub-folders and files of a folder, paged.

Method:

getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId)

Parameters:

• companyId: company code.
• user: user login.
• password: user password.
• documentId: folder number.
• privatefolder: identifies if it is a private folder.
• documenttypes: folder document types.
• limit: number of records to be returned.
• lastRowId: last line returned.
• colleagueId: user registration.

Return: DocumentDto[].

getSubFoldersPermission

Returns all the sub-folders where the user has the provided permission.

Method:

getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: private folder number.
• colleagueId: user registration.
• permission: permission over the folder.

Return: DocumentDto[].

getSubPrivateFolders

Returns all sub-folders of a private folder.

Method:

getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId)

Parameters:

• colleagueId: user registration.
• password: user password.
• companyId: company code.
• documentId: private folder number.

Return: DocumentDto[].

getUserPermissions

Returns the permission of a user over a folder.

Method:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

Parameters:

• companyId: company code.
• user: user registration.
• nrDocumentId: folder number.
• version: folder version.

Return: Integer.

restoreDocument

Restores a folder from the bin.

Method:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• documentId: folder number.
• colleagueId: user registration.

Return: WebServiceMessage[].

updateFolder

Changes a folder.

Method:

updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docdtos: folder that will be changed.
• docsecurity: folder security.
• docapprovers: folder approvers.

Return: WebServiceMessage[].

updateFolderWithApprovementLevels

Changes a folder with approval level.

Method:

updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• docdtos: folder that will be changed.
• docsecurity: folder security.
• docapprovers: approvers in levels.
• levels: folder approval levels.

Return: WebServiceMessage[].

updateSimpleFolder

Changes a folder in a simple way.

Method:

updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)

Parameters:

• user: user login
• password: user password
• companyId: company code
• docdtos: folder that will be changed.

Return: WebServiceMessage[].

createGlobalParam

Creates general parameters for a company.

Method:

createGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• global: company general parameters.

Return: String.

getGlobalParam

Returns the general parameters of a company.

Method:

getGlobalParam(String username, String password, int companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: GlobalParamDto[].

getVolumes

Returns the company volumes.

Method:

getVolumes(String user, String password, int companyId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.

Return: VolumeDto[].

updateConfigurations

Changes the system settings.

Method:
updateConfigurations( String username,String password, int companyId, String dbDriver, String dbUser, String dbPassword, String dbServer,
String dbPort,String dbScheme, String dbInstance, String emailServer, String emailPort, String emailSender, boolean emailDefaultSender, String emailUser, String emailPassword, boolean emailTLS,String paramsRMTPTPort, String lsType, String paramsLSHost, String paramsLSPort, String paramsOpenOfficeDir, String paramsOpenOfficePorts, String portsSetName)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• dbDriver: database driver (MySql- com.mysql.jdbc.Driver. SQLServer - net.sourceforge.jtds.jdbc.Driver. Oracle -oracle.jdbc.driver.OracleDriver)
• dbUser: database username.
• dbPassword: database password.
• dbServer: database connection server.
• dbPort: database server port.
• dbScheme: database.
• dbInstance: database instance, used for SQLServer, if it is not the case of passing blank ("").
• mailServer: SMTP server name.
• emailSender: product default sender email.
• emailPort: SMTP server port.
• emailDefaultSender:
• emailUser: email user, only if the server needs authentication.
• emailPassword: email password, only if the server needs authentication.
• emailTLS: server will use encrypting whrn sending email (true/false)
• paramsRMTPTPort: port used by Flex.
• lsType: type of license used, LM/LS.
• paramsLSHost: license server.
• paramsLSPort: license server port.
• paramsOpenOfficeDir: OpenOffice install directory
• paramsOpenOfficePorts: port used by OpenOffice
• portsSetName: port used by the system (ports-default, ports-01, ports-02)

Return: String.

updateGlobalParam

Changes general parameters of a company.

Method:

updateGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• global: company general parameters.

Return: String.

createGroup

Creates a group in Fluig.

Method:

createGroup(String username, String password, int companyId, GroupDto[] grupos)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• grupos: group that will be created.

Return: String.

deleteGroup

Deletes a group from Fluig.

Method:

deleteGroup(String username, String password, int companyId, String groupId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• GroupId: group code.

Return: String.

getGroup

Returns a group registered in Fluig.

Method:

getGroups(String username, String password, int companyId, String groupId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• groupId: group code.

Return: GroupDto[].

Return Attributes:

• companyId

• groupDescription

• groupId

getGroups

Returns all the groups registered in Fluig.

Method:

getGroups(String username, String password, int companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: GroupDto[].

Return Attributes:

• companyId

• groupDescription

• groupId

getGroupsByDescription

returns a group by description.

Method:

getGroupsByDescription(String username, String password, int companyId, String desc)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• desc: group description.

Return: GroupDto[].

Return Attributes:

• companyId

• groupDescription

• groupId

getOcurrenceByKey

Returns if there is safety configuration for assignment and assignment value.

Method:

getOcurrenceByKey(String username, String password, int companyId, int pIdiAtribuic, String pDesValAtribuic)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• pIdiAtribuic: assignment code.
• pDesValAtribuic: assignment value.

Return: boolean.

updateGroup

Changes a group in Fluig.

Method:

updateGroup(String username, String password, int companyId, GroupDto[] grupos)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• grupos: group that will be changed.

Return: String.

transfer

Transfers pending of a user to another user.

Method:

transfer(String user, String password, int companyId, String colleagueIdFrom, String colleagueIdTo, String[] parameters)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueIdFrom: source user registration (its pending will be transfered to the target user).
• colleagueIdTo: target user registration (it will receive pending from source user).
• parameters: pending array that will be transfered to the target user.

Return: String.

createSimpleReport

Creates a report in a simplified manner in Fluig.

Method:

createSimpleReport(String username, String password, int companyId, int parentDocId, String reportDescription, Attachment[] attachments)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• parentDocId: parent folder code.
• reportDescription: report description.
• attachments: report attachments.

Return: WebServiceMessage[].

getActiveReport

Returns an active report in Fluig.

Method:

getActiveReport(int companyId, String username, String password, String documentId)

Parameters:

• companyId: company code.
• username: user login.
• password: user password.
• documentId: document code.

Return: DocumentDto.

getAttachmentsList

Returns a list of report attachments in Fluig.

Method:

getAttachmentsList(String username, String password, int companyId, String documentId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• documentId: document code.

Return: String[].

getReportContent

Returns the physical file of a report.

Method:

getReportContent(String username, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String fileName)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• nrDocumentId: document number.
• colleagueId: user registration.
• documentoVersao: document version.
• fileName: file name.

Return: byte[].

getRepots

Returns the available reports.

Method:

getRepots(String username, String password, int companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: DocumentDto[].

updateSimpleReport

Updates a report in a simplified manner in Fluig.

Method:

createSimpleReport(String username, String password, int companyId, int docId, String reportDescription, Attachment[] attachments, String versionOption)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• docId: parent folder code.
• reportDescription: report description.
• attachments: report attachments.
• versionOption: informs if you want to update the report version.

Return: WebServiceMessage[].

advancedSearchDocuments

Uses advanced search.

Method:

advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• content: search content.
• findAllDocumentTypes: indicates if all document types should be searched.
• findFolders: indicates if folders should be searched.
• findDocuments: indicates if documents should be searched.
• findCardIndex: indicates if card index should be searched.
• findCards: indicates if card index should be searched.
• findExternalDocument: indicates if external documents should be searched.
• documentParentId: parent document number.
• startDate: start date.
• finalDate: final date.

Return: SearchResultDto[].

Uses advanced search through metadata options and customized fields.

Method:

advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, SearchFields[] metadata, SearchFields[] customfields, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• content: search content.
• metadata: information for search from metadata.
• customfields: information for search from custom fields.
• findAllDocumentTypes: indicates if all document types should be searched.
• findFolders: indicates if folders should be searched.
• findDocuments: indicates if documents should be searched.
• findCardIndex: indicates if card index should be searched.
• findCards: indicates if card index should be searched.
• findExternalDocument: indicates if external documents should be searched.
• documentParentId: parent document number.
• startDate: start date.
• finalDate: final date.

Return: SearchResultDto[].

searchDocuments

Uses simple search.

Method:

searchDocuments(String user, String password, int companyId, String colleagueId, String content)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• content: search content.

Return: SearchResultDto[].

searchFavoritesDocuments

Searches favorite documents.

Method:

searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• colleagueId: user registration.
• contente: content to be searched

Return: SearchResultDto[]

createSignal

Creates a signal in Fluig.

Method:

createSignal(String login, String password, int companyId, String description)

Parameters:

• login: user login.
• password: user password.
• companyId: company code.
• description: signal description.

Return: String.

deleteSignal

Remove a signal created in Fluig.

Method:

deleteSignal(String login, String password, int companyId, int signalId)

Parameters:

• login: login of the user that will be generated by token.
• password: user password.
• companyId: company code.
• signalId: signal code.

Return: String.

fireSignal

Sends/Triggers existing signals.

Method:

fireSignal (String login, String password, int companyId, int signalId)

Parameters:

• login: login of the user that will be generated by token.
• password: user password.
• companyId: company code.
• signalId: signal code.

Return: String.

getSignals

Returns the existing signals in Fluig.

Method:

getSignals(String login, String password, int companyId)

Parameter:

• login: user login.
• password: user password.
• companyId: company code.

Return: Signal[].

getToken

Returns the security token.

Method:

getToken(String login, String password)

Parameters:

• login: user login.
• password: user password.

Return: String.

getTokenByLogin

Returns a security token for the requested login.

Method:

getTokenByLogin(int companyId, String colleagueId, String password, String login)

Parameters:

• companyId: company code.
• colleagueId: user registration.
• password: user password.
• login: login of the user that will be generated by token.

Return: String.

getTokenEmail

Returns a security token for the requested email.

Method:

getTokenEmail(int companyId, String email, String password)

Parameters:

• companyId: company code.
• email: user email.
• password: user password.

Return: String.

validateToken

Validates the security token and returns the user login.

Method:

validateToken(String token)

Parameter:

• token: user token.

Return: String.

calculateDeadLineHours

Calculates the deadline from a date based on the working hours and holidays registered in the product passing the deadline in hours.

Method:

calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code
• userId - User registration
• data - date (String type in the "yyyy-MM-dd" format).
• segundos - Number of seconds after midnight
• prazo - Deadline that will be applied in hours (int variable).
• periodId - Working Hours Code

Return: DeadLineDto object that contains variables with date and time.

calculateDeadLineTime

Calculates the deadline from a date based on the working hours and holidays registered in the product passing the deadline in minutes.

Method:

calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code
• userId - User registration
• data - date (String type in the "yyyy-MM-dd" format).
• segundos - Number of seconds after midnight
• prazo - Deadline that will be applied in minutes (int variable).
• periodId - Working Hours Code

Return: DeadLineDto object that contains variables with date and time.

cancelInstance

Cancels a request.

Method:

cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• userId: user registration.
• cancelText: cancellation comments.

Return: String.

cancelInstanceByReplacement

Cancels a request using the substitute user.

Method:

cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• userId: user registration.
• cancelText: cancellation comments.
• replacementId: substitute user registration.

Return: String.

Creates a new version of the workflow process.

Method:

createWorkFlowProcessVersion(String user, String password, int companyId, int processId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: request number.

Return: String.

exportProcess

Returns the selected process in a String.

Method:

exportProcess (String username, String password, int companyId, String processId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code
• processId - Process code
  
  

Return: String that contains the process definition.

Returns the selected process in the zip format.

Method:

exportProcessInZipFormat(String username, String password, int companyId, String processId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code
• processId - Process code
  
  

Return: byte[] that contains the process definition.

getActualThread

Returns the thread sequence of a request.

Method:

getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• stateSequence: state sequence.

Return: int.

getAllActiveStates

Returns the activity number where the request is.

Method:

getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• processInstanceId: request number.

Return: Integer[].

getAllProcessAvailableToExport

Returns a list of available processes to be exported.

Method:

getAllProcessAvailableToExport (String username, String password, int companyId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code

Return: ProcessDefinitionDto[].

getAllProcessAvailableToImport

Returns a list of available processes to be imported.

Method:

getAllProcessAvailableToImport (String username, String password, int companyId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code

Return: ProcessDefinitionDto[]

getAttachments

Returns a request attachments.

Method:

getAttachments(String user, String password, int companyId, String userId, int processInstanceId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• processInstanceId: request number.

Return: ProcessAttachmentDto[].

getAvailableProcess

Returns the processes the user can start in a request.

Method:

getAvailableProcess(String username, String password, int companyId, String userId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• userId: user registration.

Return: ProcessDefinitionVersionDto[].

getAvailableProcessOnDemand

Returns the processes the user can start in a request, paged.

Method:

getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• limit: number of records to be returned.
• lastRowId: last line returned.

Return: ProcessDefinitionVersionDto[].

getAvailableStates

Returns the number of the next activity of a request.

Method:

getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• processInstanceId: request number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: Integer[].

getAvailableStatesDetail

Returns details on the activities available for selection.

Method:

getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• processInstanceId: request number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: ProcessStateDto[].

getAvailableUsers

Returns users who can run the current task of a request.

Method:

getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• state: activity number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: String[].

getAvailableUsersOnDemand

Returns users who can run the current task of a request, paged and with search.

Method:

getAvailableUsersOnDemand(String username, String password, int companyId, int processInstanceId, int state, int threadSequence, int limit, int initialUser, String userSearch)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• state: activity number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.
• limit: number of records to be returned.
• initialUser: last returned line.
• userSearch: text to be searched.

Return: AvailableUsersDto.

getAvailableUsersStart

Returns the users available in opening a request.

Method:

getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• state: activity number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: String[].

getAvailableUsersStartOnDemand

Returns the users available in opening a request, paged and with search.

Method:

getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence, int limit, int initialUser, String userSearch)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• state: activity number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.
• limit: number of records to be returned.
• initialUser: last returned line.
• userSearch: text to be searched.

Return: AvailableUsersDto.

getCardValue

Returns the value of a form field.

Method:

getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• userId: user registration.
• cardFieldName: form field name.

Return: String.

getHistories

Returns list of histories of a process.

Method:

getHistories (String username, String password, int companyId)

Parameters:

• username - Integration user
• password - Integration Password
• companyId - Company code
• userId - User registration
• processInstanceId - workflow request number

Return: ProcessHistoryDto[].

getInstanceCardData

Returns a request form field values.

Method:

getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• processInstanceId: request number.

Return: String[][].

Returns form code linked to the process.

Method:

getProcessFormId(String user, String password, int companyId, String userId, int processId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• processId: request number.

Return: int.

Returns the version of a process.

Method:

getWorkFlowProcessVersion(String user, String password, int companyId, int processId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: request number.

Return: int.

importProcess

Imports workflow processes.

Method:

importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• file: file to be imported.
• newProcess: indicates if a process should be created or the existing one updated.
• overWrite: indicates if the existing process activity and flows should be overwritten.
• colleagueId: user registration.

Return: String.

Imports workflow and form processes.

Method:

importProcessWithCard(String user, String password, int companyId, String processId, Attachment[] processAttachs, boolean newProcess, boolean overWrite, String colleagueId, int parentDocId, String docDescription, String cardDescription, String datasetName, Attachment[] cardAttachs, CardEventDto[] customEvents, boolean update)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• processAttachs: process attachments.
• newProcess: indicates if a process should be created or the existing one updated.
• overWrite: indicates if the existing process activity and flows should be overwritten.
• colleagueId: user registration.
• parentDocId: form number.
• docDescription: description.
• cardDescription: name.
• datasetName: dataset name.
• cardAttachs: attached file.
• customEvents: events.
• update: if true, informs that it will be an update.
  
  

Return: String.

Releases workflow processes.

Method:

releaseProcess(String user, String password, int companyId, String processId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
  
  

saveAndSendTask

Moves the request to the next activity.

Method:

saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• choosedState: activity number.
• colleagueIds: user that will receive the task.
• comments: comments.
• userId: user registration that will run the task.
• completeTask: indicates if the task must be completed (true) or only saved (false)
• attachments: request attachments.
• cardData: form data.
• appointment: task appointment.
• managerMode: indicates if the user is running the task as a process manager.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: String[][].

saveAndSendTaskByReplacement

Moves the request to the next activity using a substitute user.

Method:

saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• choosedState: activity number.
• colleagueIds: user that will receive the task.
• comments: comments.
• userId: user registration that will run the task.
• completeTask: indicates if the task must be completed (true) or only saved (false)
• attachments: request attachments.
• cardData: form data.
• appointment: task appointment.
• managerMode: indicates if the user is running the task as a process manager.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.
• replacementId: substitute user registration.

Return: String[][].

saveAndSendTaskClassic

Moves the request to the next activity and returns an object array with key and value.

Method:

saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• choosedState: activity number.
• colleagueIds: user that will receive the task.
• comments: comments.
• userId: user registration that will run the task.
• completeTask: indicates if the task must be completed (true) or only saved (false)
• attachments: request attachments.
• cardData: form data.
• appointment: task appointment.
• managerMode: indicates if the user is running the task as a process manager.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: KeyValueDto[].

searchProcess

Searches processes available for initialization.

Method:

searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)

Parameters

• user - Integration User
• password - Integration Password
• companyId - Company code
• colleagueId - User registration
• content - name of the process to be searched
• favorite – search of the list of favorite processes or of the default listing.

Return: ProcessDefinitionVersionDto[]

setAutomaticDecisionClassic

Selects user(s) and forwards automatic activity.

Method:

setAutomaticDecisionClassic(String user, String password, int companyId, int processInstanceId, int iTaskAutom, int iTask, int condition, String[] colleagueIds, String comments, String userId, boolean managerMode, int threadSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• iTaskAutom: automatic activity number.
• iTask: current activity number.
• condition: automatic activity condition number.
• colleagueIds: user that will receive the task.
• comments: comments.
• userId: user registration that will run the task.
• managerMode: indicates if the user is running the task as a process manager.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: KeyValueDto[].

setDueDate

Changes the task deadline.

Method:

setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• userId: user registration. When it is For a Group or For a Role, it should be passed as follows:
  Role: "Pool:Role:CodigoDoPapel";
  Group: "Pool:Group:CodigoDoGrupo".
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.
• newDueDate: new task deadline. Example: "2014-08-20".
• timeInSeconds: amount of seconds after midnight. Example: "32000".

Return: String.

setTasksComments

Changes the task comments.

Method:

setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processInstanceId: request number.
• userId: user registration.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.
• comments: comments.

Return: String.

simpleStartProcess

Starts a simple request:

Method:

simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• comments: comments.
• attachments: request attachments.
• cardData: form data.

Return: String[].

startProcess

Starts a request.

Method:

startProcess(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• choosedState: activity number.
• colleagueIds: user that will receive the task.
• comments: comments.
• userId: user registration that will start the request.
• completeTask: indicates if the task must be completed (true) or only saved (false)
• attachments: request attachments.
• cardData: form data.
• appointment: task appointment.
• managerMode: indicates whether the user is starting the request as a process manager.

Return: String[][].

startProcessClassic

Starts a request and returns an object array with key and value.

Method:

startProcessClassic(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• processId: process code.
• choosedState: activity number.
• colleagueIds: user that will receive the task.
• comments: comments.
• userId: user registration that will start the request.
• completeTask: indicates if the task must be completed (true) or only saved (false)
• attachments: request attachments.
• cardData: form data.
• appointment: task appointment.
• managerMode: indicates whether the user is starting the request as a process manager.

Return: String[][].

takeProcessTask

Assumes a task.

Method:

takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• processInstanceId: request number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.

Return: String.

takeProcessTaskByReplacement

Assumes a task using a substitute user.

Method:

takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence, String replacementId)

Parameters:

• user: user login.
• password: user password.
• companyId: company code.
• userId: user registration.
• processInstanceId: request number.
• threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.
• replacementId: substitute user registration.

Return: String.

updateWorkflowAttachment

Updates a document of type 7.

Returns a string containing the success description or operation failure.

Method:

updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId, String usuario, DocumentDto[] docdtos, Attachment[] attach)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• processInstanceId: workflow request number.
• usuario: user responsible for editing document.
• docDtos: document or documents that will be posted.
• attachs: file(s) attached to post.

createWorkflowRole

Creates a role in Fluig.

Method:

createWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• role: role that will be created.

Return: String.

deleteWorkflowRole

Deletes a role from Fluig.

Method:

deleteWorkflowRole(String username, String password, int companyId, String roleId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• roleId: code of the role to be deleted.

Return: String.

getWorkflowRole

Returns a role registered in Fluig.

Method:

getWorkflowRole(String username, String password, int companyId, String roleId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• roleId: role code.

Return: WorkflowRoleDto.

Return Attributes:

• companyId
• roleDescription
• roleId

getWorkflowRoles

Returns all the roles registered in Fluig.

Method:

getWorkflowRoles(String username, String password, int companyId)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.

Return: WorkflowRoleDto[].

Return Attributes:

• companyId
• roleDescription
• roleId

updateWorkflowRole

Updates a role in Fluig.

Method:

updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

Parameters:

• username: user login.
• password: user password.
• companyId: company code.
• role: role that will be created.

Return: String.